Skip to content
Primer Design System/React

Primer Design System

Site navigation

On this page

LabelGroup

Use LabelGroup components to add commonly used margins and other layout constraints to groups of Labels
  • Alpha
  • Not reviewed for accessibility
On this page
This documentation is moving to a new home. Please update any link or bookmark that points to this page. The new content can be found here.

Example

Props

LabelGroup

NameTypeDefaultDescription
overflowStyle
'inline' | 'overlay'

How hidden tokens should be shown. 'inline' shows the hidden tokens after the visible tokens. 'overlay' shows all tokens in an overlay that appears on top of the visible tokens.

visibleChildCount
'auto' | number

How many tokens to show. 'auto' truncates the tokens to fit in the parent container. Passing a number will truncate after that number tokens. If this is undefined, tokens will never be truncated.

Status

Alpha

  • Component props and basic example usage of the component are documented on primer.style/react.
  • Component does not have any unnecessary third-party dependencies.
  • N/A: Component can adapt to different themes.
  • N/A: Component can adapt to different screen sizes.
  • Component has robust unit test coverage (100% where achievable).
  • Component has visual regression coverage of its default and interactive states.
  • Component does not introduce any axe violations.
  • Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

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 does not introduce any performance regressions.

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.
  • Tooling (such as linters, codemods, etc.) exists to prevent further use of alternatives.