Skip to content

Primer/Interface guidelines

Design
Interface guidelinesOcticonsDesktopMobileCLI
Build
CSSReactReact BrandViewComponents
ContributeAbout

Icon

Icons at GitHub are called Octicons, which are available in various implementations including React, Figma, Rails, and Styled System.

On this page
Work in progressWe are currently transferring the Rails documentation for Octicon from a different site to this page. To view the original documentation, please visit the Primer ViewComponents documentation for Octicon.
v0.1.5BetaNot reviewed for accessibility

Description

Octicon renders an Octicons with System arguments. Octicon can also be rendered with the primer_octicon helper, which accepts the same arguments.

Arguments

NameDefaultDescription
icon_name

nil

Symbol, String

Name of Octicons to use.

icon

nil

Symbol, String

Name of Octicons to use.

size

:small

Symbol

One of :xsmall (12), :small (16), or :medium (24).

use_symbol

false

Boolean

EXPERIMENTAL (May change or be removed) - Set to true when using with Primer::Alpha::OcticonSymbols.

system_arguments

N/A

Hash

System arguments

Examples

View in Lookbook