Skip to content

Component status

Check the current status of Primer React components.

See the component lifecycle for more information about each status.

ComponentStatusAccessibilityDescription
ActionListBetaNot reviewedAn 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)DeprecatedNot reviewed
ActionMenuBetaReviewedAn ActionMenu is an ActionList-based component for creating a menu of actions that expands through a trigger button.
ActionMenu (legacy)DeprecatedNot reviewed
AnchoredOverlayAlphaNot reviewed
AutocompleteAlphaNot reviewedUsed to render a text input that allows a user to quickly filter through a list of options to pick one or more values.
AvatarAlphaNot reviewedUse avatars to represent users or organizations.
AvatarPairAlphaNot reviewed
AvatarStackAlphaNot reviewedUse an avatar stack to display two or more avatars in an inline stack.
BorderBoxDeprecatedNot reviewed
BoxBetaNot reviewedA low-level utility component that accepts styled system props to enable custom theme-aware styling
BranchNameAlphaNot reviewed
BreadcrumbsAlphaNot reviewedUse 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.
ButtonAlphaNot reviewedUse button for the main actions on a page or form.
Button (legacy)DeprecatedNot reviewed
ButtonGroupAlphaNot reviewed
CheckboxAlphaNot reviewedUse checkboxes to toggle between checked and unchecked states in a list or as a standalone form field
CheckboxGroupAlphaNot reviewedRenders a set of checkboxes to let users make one or more selections from a short list of options
ChoiceFieldsetDeprecatedNot reviewed
ChoiceInputFieldDeprecatedNot reviewedThe ChoiceInputField component is used to render a labelled checkbox or radio inputs with optional hint text.
CircleBadgeAlphaNot reviewed
CircleOcticonAlphaNot reviewed
CounterLabelAlphaNot reviewedUse the CounterLabel component to add a count to navigational elements and buttons.
DetailsAlphaNot reviewed
DialogAlphaNot reviewed
Dialog v2DraftNot reviewed
DropdownDeprecatedNot reviewed
DropdownMenuDeprecatedNot reviewed
FilteredSearchAlphaNot reviewed
FilterListAlphaNot reviewed
FlashAlphaNot reviewed
FlexDeprecatedNot reviewed
FormControlAlphaNot reviewedRenders a labelled input and, optionally, associated validation text and/or hint text.
FormGroupDeprecatedNot reviewed
GridDeprecatedNot reviewed
HeaderAlphaNot reviewedUse the Header component to create a header that has all of its items aligned vertically with consistent horizontal spacing
HeadingAlphaNot reviewedUse Heading to structure your content and provide an accessible experience for users of assistive technologies.
HiddenAlphaNot reviewedUse Hidden to responsively hide or show content in narrow, regular and wide viewports.
IconButtonAlphaNot reviewedAn accessible button component with no text and only icon.
InlineAutocompleteDraftNot reviewedProvides inline auto completion suggestions for an input or textarea.
InputFieldDeprecatedNot reviewedThe InputField component is used to render a labelled text input and, optionally, associated validation text and hint text.
LabelAlphaNot reviewedUse Label components to add contextual metadata to a design.
Label (legacy)DeprecatedNot reviewedUse Label components to add contextual metadata to a design.
LabelGroupAlphaNot reviewedUse LabelGroup components to add commonly used margins and other layout constraints to groups of Labels
LinkAlphaNot reviewed
MarkdownEditorDraftNot reviewedFull-featured Markdown input.
MarkdownViewerDraftNot reviewedDisplays rendered Markdown and facilitates interaction.
NavListAlphaNot reviewedUse a nav list to render a vertical list of navigation links.
OverlayAlphaNot reviewedUse Overlay to provide a flexible floating surface for displaying transient content such as menus, selection options, dialogs, and more.
PageheadAlphaNot reviewedUse Pagehead to provide a clear, separated page title.
PageLayoutAlphaReviewed
PaginationAlphaNot reviewedUse Pagination to display a sequence of links that allow navigation to discrete, related pages.
PointerBoxAlphaNot reviewedA customisable, bordered Box with a caret pointer
PopoverAlphaNot reviewedUse Popovers to bring attention to specific user interface elements and suggest an action or to guide users through a new experience
PortalAlphaNot reviewedPortals allow you to create a separation between the logical React component hierarchy and the physical DOM.
PositionDeprecatedNot reviewed
ProgressBarAlphaNot reviewedUse progress bars to visualize task completion.
RadioAlphaNot reviewedUse radios when a user needs to select one option from a list
RadioGroupAlphaNot reviewedRenders a set of radio inputs to let users make a single selection from a short list of options
SegmentedControlAlphaNot reviewedUse 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
SelectMenuDeprecatedNot reviewed
SelectPanelAlphaNot reviewed
SideNavDeprecatedNot reviewed
SpinnerAlphaNot reviewedUse spinners to let users know that content is being loaded.
SplitPageLayoutAlphaReviewedProvides 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.
StateLabelAlphaNot reviewed
StyledOcticonAlphaNot reviewedUse StyledOcticon to render an Octicon as a component.
SubNavAlphaNot reviewed
TabNavAlphaNot reviewed
TextAlphaNot reviewed
TextareaAlphaNot reviewedUse Textarea for multi-line text input form fields
TextInputAlphaNot reviewed
TextInputWithTokensAlphaNot reviewedUsed to show multiple values in one field
TimelineAlphaNot reviewed
ToggleSwitchAlphaNot reviewedToggles a setting on or off, and immediately saves the change
TokenAlphaNot reviewedA Token represents a piece of data. They are typically used to show a collection of related attributes.
TooltipAlphaNot reviewed
TreeViewDraftNot reviewedA hierarchical list of items where nested items can be expanded and collapsed.
TruncateAlphaNot reviewed
UnderlineNavAlphaNot reviewed
UnderlineNav v2DraftNot reviewedUse an underlined nav to allow tab like navigation with overflow behaviour in your UI.