StyledOcticon

StyledOcticon renders an Octicon with common system props, including color, margin, and padding.

Default example

<StyledOcticon icon={Check} size={32} color="green.5" mr={2} />
<StyledOcticon icon={X} size={32} color="red.5" />

System props

StyledOcticon components get COMMON system props. Read our System Props doc page for a full list of available props.

Component props

StyledOcticon passes all of its props except the common system props down to the Octicon component, including:

NameTypeDefaultDescription
ariaLabelStringSpecifies the aria-label attribute, which is read verbatim by screen readers
iconOcticonOcticon component used in the component
sizeNumber16Sets the uniform width and height of the SVG element
verticalAlignStringtext-bottomSets the text-align CSS property
Edit this page on GitHub