Icon

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

v0.36.1BetaNot 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

NameTypeDefaultDescription
icon_name
Symbol, String

nil

Name of Octicons to use.

icon
Symbol, String

nil

Name of Octicons to use.

size
Symbol

:small

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

use_symbol
Boolean

false

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

system_arguments
Hash

N/A

Examples