Octicon

readyNot reviewed for a11y

This page may be removed. Primer plans to move all Rails component documentation to Lookbook.

Description

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

Arguments

Name	Required	Description
icon_name		`Symbol, String` Name of Octicons to use.
icon		`Symbol, String` Name of Octicons to use.
size		`Symbol` One of `:xsmall` (`12`), `:small` (`16`), or `:medium` (`24`).
use_symbol		`Boolean` EXPERIMENTAL (May change or be removed) - Set to true when using with `Primer::Alpha::OcticonSymbols`.
system_arguments		`Hash` System arguments