Skip to content

CircleBadge

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

Default example

System props

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

Component props

CircleBadge

NameTypeDefaultDescription
asStringdivsets the HTML tag for the component
inlineBooleanfalseStyles the badge to display inline
sizeNumbersets the size of the badge in pixels; overrides any value for variant prop when set
variantString'medium'a value of small, medium, or large creates a smaller or larger badge; no effect if size prop is set

CircleBadge.Icon

CircleBadge.Icon components receive all the same props at [StyledOcticon]. They are listed below for convenience:

NameTypeDefaultDescription
ariaLabelStringSpecifies the aria-label attribute, which is read verbatim by screen readers
iconComponentOcticon component used in the component
sizeNumber16Sets the uniform width and height of the SVG element
verticalAlignStringtext-bottomSets the vertical-align CSS property
Edit this page on GitHub
2 contributorsemplumsBinaryMuse
Last edited by emplums on July 1, 2020