Skip to content
Primer/React
What's new
Design
Interface guidelinesOcticonsPresentationsCommand lineMobileDesktop
Build
CSSReactReact BrandViewComponents
ContributeAbout
On this page

StyledOcticon

Use StyledOcticon to render an Octicon as a component.
  • Alpha
  • Not reviewed for accessibility
On this page

Example

Props

NameTypeDefaultDescription
ariaLabel
string
Specifies the aria-label attribute, which is read verbatim by screen readers
icon
Component
Checks the input by default in uncontrolled modeName of the Octicon component used in the
color
string
Sets an override color for the Octicon. Compatible with colors from the Primer color system."
size
number
16Sets the uniform `width` and `height` of the SVG element
verticalAlign
string
text-bottomSets the `vertical-align` CSS property
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.

Status

Alpha

  • Component props are documented on primer.style/react.
  • Component does not have any unnecessary third-party dependencies.
  • Component can adapt to different themes.
  • Component can adapt to different screen sizes.
  • Component has 100% test coverage.

Beta

  • Component is used in a production application.
  • Common usage examples are documented on primer.style/react.
  • Common usage examples are documented in storybook stories.
  • Component has been reviewed by a systems designer and any resulting issues have been addressed.
  • Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Stable

  • Component API has been stable with no breaking changes for at least one month.
  • Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
  • Component has corresponding design guidelines documented in the interface guidelines.
  • Component has corresponding Figma component in the Primer Web library.
Edit this page on GitHub
1 contributorrezrah
Last edited by rezrah on January 10, 2022