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

CircleBadge

  • Alpha
  • Review pending by accessibility team
On this page
import {CircleBadge} from '@primer/react'

Use CircleBadge to visually connect logos of third party services like in marketplace. Use CircleBadge.Icon to add an Octicon to the CircleBadge.

Examples

Props

CircleBadge

NameTypeDefaultDescription
variant
'small' | 'medium' | 'large'
'medium'Creates a smaller or larger badge. Has no effect if the size prop is set
size
number
Sets the size of the badge in pixels. Overrides the variant prop when set
inline
boolean
falseStyles the badge to display: inline
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.
as
React.ElementType
"div"The underlying element to render — either a HTML element name or a React component.
ref
React.RefObject<HTMLDivElement>
A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the as prop.
Additional props are passed to the <div> element. See for a list of props accepted by the <div> element. If an as prop is specified, the accepted props will change accordingly.

CircleBadge.Icon

NameTypeDefaultDescription
as
React.ElementType
StyledOcticonThe underlying element to render — either a HTML element name or a React component.
Additional props are passed to the <StyledOcticon> element. See the StyledOcticon docs for a list of props accepted by the <StyledOcticon> element. If an as prop is specified, the accepted props will change accordingly.

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 contributorcolebemis
Last edited by colebemis on December 17, 2021