Skip to content

Component status

Check the current status of Primer React components

See the component lifecycle for more information about each status.

ComponentStatusAccessibilityDescription
ActionList
  • Beta
  • Review 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)
  • Deprecated
  • Review pending
    ActionMenu
  • Beta
  • ReviewedAn ActionMenu is an ActionList-based component for creating a menu of actions that expands through a trigger button.
    ActionMenu (legacy)
  • Deprecated
  • Review pending
    AnchoredOverlay
  • Alpha
  • Review pending
    Autocomplete
  • Alpha
  • Review pendingUsed to render a text input that allows a user to quickly filter through a list of options to pick one or more values.
    Avatar
  • Alpha
  • Review pendingUse avatars to represent users or organizations.
    AvatarPair
  • Alpha
  • Review pending
    AvatarStack
  • Alpha
  • Review pendingUse an avatar stack to display two or more avatars in an inline stack.
    BorderBox
  • Deprecated
  • Review pending
    Box
  • Beta
  • Review pendingA low-level utility component that accepts styled system props to enable custom theme-aware styling
    BranchName
  • Alpha
  • Review pending
    Breadcrumbs
  • Alpha
  • Review 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.
    Button
  • Alpha
  • Review pendingUse button for the main actions on a page or form.
    Button (legacy)
  • deprecated
  • Review pending
    ButtonGroup
  • Alpha
  • Review pending
    Checkbox
  • Alpha
  • Review pendingUse checkboxes to toggle between checked and unchecked states in a list or as a standalone form field
    CheckboxGroup
  • Alpha
  • Review pendingRenders a set of checkboxes to let users make one or more selections from a short list of options
    ChoiceFieldset
  • Deprecated
  • Review pending
    ChoiceInputField
  • Deprecated
  • Review pendingThe ChoiceInputField component is used to render a labelled checkbox or radio inputs with optional hint text.
    CircleBadge
  • Alpha
  • Review pending
    CircleOcticon
  • Alpha
  • Review pending
    CounterLabel
  • Alpha
  • Review pendingUse the CounterLabel component to add a count to navigational elements and buttons.
    Details
  • Alpha
  • Review pending
    Dialog
  • Alpha
  • Review pending
    Dialog v2
  • Draft
  • Review pending
    Dropdown
  • Deprecated
  • Review pending
    DropdownMenu
  • Deprecated
  • Review pending
    FilteredSearch
  • Alpha
  • Review pending
    FilterList
  • Alpha
  • Review pending
    Flash
  • Alpha
  • Review pending
    Flex
  • Deprecated
  • Review pending
    FormControl
  • Alpha
  • Review pendingRenders a labelled input and, optionally, associated validation text and/or hint text.
    FormGroup
  • Deprecated
  • Review pending
    Grid
  • Deprecated
  • Review pending
    Header
  • Alpha
  • Review pendingUse the Header component to create a header that has all of its items aligned vertically with consistent horizontal spacing
    Heading
  • Alpha
  • Review pendingUse Heading to structure your content and provide an accessible experience for users of assistive technologies.
    Hidden
  • Alpha
  • Review pendingUse Hidden to responsively hide or show content in narrow, regular and wide viewports.
    IconButton
  • Alpha
  • Review pendingAn accessible button component with no text and only icon.
    InlineAutocomplete
  • Draft
  • Review pendingProvides inline auto completion suggestions for an input or textarea.
    InputField
  • Deprecated
  • Review pendingThe InputField component is used to render a labelled text input and, optionally, associated validation text and hint text.
    Label
  • Alpha
  • Review pendingUse Label components to add contextual metadata to a design.
    Label (legacy)
  • Deprecated
  • Review pendingUse Label components to add contextual metadata to a design.
    LabelGroup
  • Alpha
  • Review pendingUse LabelGroup components to add commonly used margins and other layout constraints to groups of Labels
    Link
  • Alpha
  • Review pending
    MarkdownEditor
  • Draft
  • Review pendingFull-featured Markdown input.
    MarkdownViewer
  • Draft
  • Review pendingDisplays rendered Markdown and facilitates interaction.
    NavList
  • Alpha
  • Review pendingUse a nav list to render a vertical list of navigation links.
    Overlay
  • Alpha
  • Review pendingUse Overlay to provide a flexible floating surface for displaying transient content such as menus, selection options, dialogs, and more.
    Pagehead
  • Alpha
  • Review pendingUse Pagehead to provide a clear, separated page title.
    PageLayout
  • Alpha
  • Reviewed
    Pagination
  • Alpha
  • Review pendingUse Pagination to display a sequence of links that allow navigation to discrete, related pages.
    PointerBox
  • Alpha
  • Review pendingA customisable, bordered Box with a caret pointer
    Popover
  • Alpha
  • Review pendingUse Popovers to bring attention to specific user interface elements and suggest an action or to guide users through a new experience
    Portal
  • Alpha
  • Review pendingPortals allow you to create a separation between the logical React component hierarchy and the physical DOM.
    Position
  • Deprecated
  • Review pending
    ProgressBar
  • Alpha
  • Review pendingUse progress bars to visualize task completion.
    Radio
  • Alpha
  • Review pendingUse radios when a user needs to select one option from a list
    RadioGroup
  • Alpha
  • Review pendingRenders a set of radio inputs to let users make a single selection from a short list of options
    SegmentedControl
  • Alpha
  • Review pendingUse a segmented control to let users select an option from a short list and immediately apply the selection
    Select
  • Alpha
  • ReviewedUse a select input when a user needs to select one option from a long list
    SelectMenu
  • Deprecated
  • Review pending
    SelectPanel
  • Alpha
  • Review pending
    SideNav
  • Deprecated
  • Review pending
    Spinner
  • Alpha
  • Review pendingUse spinners to let users know that content is being loaded.
    SplitPageLayout
  • Alpha
  • ReviewedProvides 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.
    StateLabel
  • Alpha
  • Review pending
    StyledOcticon
  • Alpha
  • Review pendingUse StyledOcticon to render an Octicon as a component.
    SubNav
  • Alpha
  • Review pending
    TabNav
  • Alpha
  • Review pending
    Text
  • Alpha
  • Review pending
    Textarea
  • Alpha
  • Review pendingUse Textarea for multi-line text input form fields
    TextInput
  • Alpha
  • Review pending
    TextInputWithTokens
  • Alpha
  • Review pendingUsed to show multiple values in one field
    Timeline
  • Alpha
  • Review pending
    ToggleSwitch
  • Alpha
  • Review pendingToggles a setting on or off, and immediately saves the change
    Token
  • Alpha
  • Review pendingA Token represents a piece of data. They are typically used to show a collection of related attributes.
    Tooltip
  • Alpha
  • Review pending
    TreeView
  • Draft
  • Review pendingA hierarchical list of items where nested items can be expanded and collapsed.
    Truncate
  • Alpha
  • Review pending
    UnderlineNav
  • Alpha
  • Review pending
    UnderlineNav v2
  • Draft
  • Review pendingUse an underlined nav to allow tab like navigation with overflow behaviour in your UI.