Skip to content

Icon

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

v0.1.9BetaNot reviewed for accessibility

NOTE: These docs are being migrated. The originals are available here.

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

Examples

View in Lookbook