Skip to content

Component status

Check the current status of Primer React components

See the component lifecycle for more information about each status.

ComponentStatusAccessibilityDescription
ActionListBetaReview pendingAn ActionList is a list of items that can be activated or selected. ActionList is the base component for many menu-type components, including ActionMenu and SelectPanel.
ActionList (legacy)DeprecatedReview pending
ActionMenuBetaReviewedAn ActionMenu is an ActionList-based component for creating a menu of actions that expands through a trigger button.
ActionMenu (legacy)DeprecatedReview pending
AnchoredOverlayAlphaReview pending
AutocompleteAlphaReview pendingUsed to render a text input that allows a user to quickly filter through a list of options to pick one or more values.
AvatarAlphaReview pendingUse avatars to represent users or organizations.
AvatarPairAlphaReview pending
AvatarStackAlphaReview pendingUse an avatar stack to display two or more avatars in an inline stack.
BorderBoxDeprecatedReview pending
BoxBetaReview pendingA low-level utility component that accepts styled system props to enable custom theme-aware styling
BranchNameAlphaReview pending
BreadcrumbsAlphaReview pendingUse breadcrumbs to show navigational context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages.
ButtonAlphaReview pendingUse button for the main actions on a page or form.
Button (legacy)deprecatedReview pending
ButtonGroupAlphaReview pending
CheckboxAlphaReview pendingUse checkboxes to toggle between checked and unchecked states in a list or as a standalone form field
CheckboxGroupAlphaReview pendingRenders a set of checkboxes to let users make one or more selections from a short list of options
ChoiceFieldsetDeprecatedReview pending
ChoiceInputFieldDeprecatedReview pendingThe ChoiceInputField component is used to render a labelled checkbox or radio inputs with optional hint text.
CircleBadgeAlphaReview pending
CircleOcticonAlphaReview pending
CounterLabelAlphaReview pendingUse the CounterLabel component to add a count to navigational elements and buttons.
DetailsAlphaReview pending
DialogAlphaReview pending
Dialog v2DraftReview pending
DropdownDeprecatedReview pending
DropdownMenuDeprecatedReview pending
FilteredSearchAlphaReview pending
FilterListAlphaReview pending
FlashAlphaReview pending
FlexDeprecatedReview pending
FormControlAlphaReview pendingRenders a labelled input and, optionally, associated validation text and/or hint text.
FormGroupDeprecatedReview pending
GridDeprecatedReview pending
HeaderAlphaReview pendingUse the Header component to create a header that has all of its items aligned vertically with consistent horizontal spacing
HeadingAlphaReview pendingUse Heading to structure your content and provide an accessible experience for users of assistive technologies.
IconButtonAlphaReview pendingAn accessible button component with no text and only icon.
InlineAutocompleteDraftReview pendingProvides inline auto completion suggestions for an input or textarea.
InputFieldDeprecatedReview pendingThe InputField component is used to render a labelled text input and, optionally, associated validation text and hint text.
LabelAlphaReview pendingUse Label components to add contextual metadata to a design.
Label (legacy)DeprecatedReview pendingUse Label components to add contextual metadata to a design.
LabelGroupAlphaReview pendingUse LabelGroup components to add commonly used margins and other layout constraints to groups of Labels
LinkAlphaReview pending
MarkdownEditorDraftReview pendingFull-featured Markdown input.
MarkdownViewerDraftReview pendingDisplays rendered Markdown and facilitates interaction.
NavListAlphaReview pendingUse a nav list to render a vertical list of navigation links.
OverlayAlphaReview pendingUse Overlay to provide a flexible floating surface for displaying transient content such as menus, selection options, dialogs, and more.
PageheadAlphaReview pendingUse Pagehead to provide a clear, separated page title.
PageLayoutAlphaReview pending
PaginationAlphaReview pendingUse Pagination to display a sequence of links that allow navigation to discrete, related pages.
PointerBoxAlphaReview pendingA customisable, bordered Box with a caret pointer
PopoverAlphaReview pendingUse Popovers to bring attention to specific user interface elements and suggest an action or to guide users through a new experience
PortalAlphaReview pendingPortals allow you to create a separation between the logical React component hierarchy and the physical DOM.
PositionDeprecatedReview pending
ProgressBarAlphaReview pendingUse progress bars to visualize task completion.
RadioAlphaReview pendingUse radios when a user needs to select one option from a list
RadioGroupAlphaReview pendingRenders a set of radio inputs to let users make a single selection from a short list of options
SegmentedControlAlphaReview pendingUse a segmented control to let users select an option from a short list and immediately apply the selection
SelectAlphaReviewedUse a select input when a user needs to select one option from a long list
SelectMenuDeprecatedReview pending
SelectPanelAlphaReview pending
SideNavDeprecatedReview pending
SpinnerAlphaReview pendingUse spinners to let users know that content is being loaded.
SplitPageLayoutDraftReview pendingProvides structure for a split page layout, including independent scrolling for the pane and content regions. Useful for responsive list/detail patterns, when an item in the pane updates the page content on selection.
StateLabelAlphaReview pending
StyledOcticonAlphaReview pendingUse StyledOcticon to render an Octicon as a component.
SubNavAlphaReview pending
TabNavAlphaReview pending
TextAlphaReview pending
TextareaAlphaReview pendingUse Textarea for multi-line text input form fields
TextInputAlphaReview pending
TextInputWithTokensAlphaReview pendingUsed to show multiple values in one field
TimelineAlphaReview pending
ToggleSwitchAlphaReview pendingToggles a setting on or off, and immediately saves the change
TokenAlphaReview pendingA Token represents a piece of data. They are typically used to show a collection of related attributes.
TooltipAlphaReview pending
TreeViewDraftReview pendingA hierarchical list of items where nested items can be expanded and collapsed.
TruncateAlphaReview pending
UnderlineNavAlphaReview pending
UnderlineNav v2DraftReview pendingUse an underlined nav to allow tab like navigation with overflow behaviour in your UI.