SelectPanel

Use a select panel to provides an anchor that will open an overlay with a list of selectable items, and a text input to filter the selectable items.

Alpha
Not reviewed for accessibility

Source

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.

A SelectPanel provides an anchor that will open an overlay with a list of selectable items, and a text input to filter the selectable items

Example

function getColorCircle(color) {
  return () => (
    <Box
      borderWidth="1px"
      borderStyle="solid"
      bg={color}
      borderColor={color}
      width={14}
      height={14}
      borderRadius={10}
      margin="auto"
    />
  )
}

const items = [
  {leadingVisual: getColorCircle('#a2eeef'), text: 'enhancement', id: 1},
  {leadingVisual: getColorCircle('#d73a4a'), text: 'bug', id: 2},
  {leadingVisual: getColorCircle('#0cf478'), text: 'good first issue', id: 3},
  {leadingVisual: getColorCircle('#ffd78e'), text: 'design', id: 4},
  {leadingVisual: getColorCircle('#ff0000'), text: 'blocker', id: 5},
  {leadingVisual: getColorCircle('#a4f287'), text: 'backend', id: 6},
  {leadingVisual: getColorCircle('#8dc6fc'), text: 'frontend', id: 7},
]

function DemoComponent() {
  const [selected, setSelected] = React.useState([items[0], items[1]])
  const [filter, setFilter] = React.useState('')
  const filteredItems = items.filter(item => item.text.toLowerCase().startsWith(filter.toLowerCase()))
  const [open, setOpen] = React.useState(false)

  return (
    <SelectPanel
      renderAnchor={({children, 'aria-labelledby': ariaLabelledBy, ...anchorProps}) => (
        <Button trailingAction={TriangleDownIcon} aria-labelledby={` ${ariaLabelledBy}`} {...anchorProps}>
          {children || 'Select Labels'}
        </Button>
      )}
      placeholderText="Filter Labels"
      open={open}
      onOpenChange={setOpen}
      items={filteredItems}
      selected={selected}
      onSelectedChange={setSelected}
      onFilterChange={setFilter}
      showItemDividers={true}
      overlayProps={{width: 'small', height: 'xsmall'}}
    />
  )
}

render(<DemoComponent />)

function getColorCircle(color) {
  return () => (
    <Box
      borderWidth="1px"
      borderStyle="solid"
      bg={color}
      borderColor={color}
      width={14}
      height={14}
      borderRadius={10}
      margin="auto"
    />
  )
}

const items = [
  {leadingVisual: getColorCircle('#a2eeef'), text: 'enhancement', id: 1},
  {leadingVisual: getColorCircle('#d73a4a'), text: 'bug', id: 2},
  {leadingVisual: getColorCircle('#0cf478'), text: 'good first issue', id: 3},
  {leadingVisual: getColorCircle('#ffd78e'), text: 'design', id: 4},
  {leadingVisual: getColorCircle('#ff0000'), text: 'blocker', id: 5},
  {leadingVisual: getColorCircle('#a4f287'), text: 'backend', id: 6},
  {leadingVisual: getColorCircle('#8dc6fc'), text: 'frontend', id: 7},
]

function DemoComponent() {
  const [selected, setSelected] = React.useState([items[0], items[1]])
  const [filter, setFilter] = React.useState('')
  const filteredItems = items.filter(item => item.text.toLowerCase().startsWith(filter.toLowerCase()))
  const [open, setOpen] = React.useState(false)

  return (
    <SelectPanel
      renderAnchor={({children, 'aria-labelledby': ariaLabelledBy, ...anchorProps}) => (
        <Button trailingAction={TriangleDownIcon} aria-labelledby={` ${ariaLabelledBy}`} {...anchorProps}>
          {children || 'Select Labels'}
        </Button>
      )}
      placeholderText="Filter Labels"
      open={open}
      onOpenChange={setOpen}
      items={filteredItems}
      selected={selected}
      onSelectedChange={setSelected}
      onFilterChange={setFilter}
      showItemDividers={true}
      overlayProps={{width: 'small', height: 'xsmall'}}
    />
  )
}

render(<DemoComponent />)

Pressing Enter or Space on the SelectPanel anchor will open the SelectPanel and place focus on the filter input. Pressing Escape or interacting with the cancel or close buttons will close the SelectPanel and restore focus to the anchor.

A user may use Tab and Shift+Tab to navigate between the filter input, list of items, action buttons, and the close button.

When focus is on the list of items, pressing ArrowDown and ArrowUp will allow navigation between items. Support for Home and End is also provided to quickly navigate to the first and last items in the list, respectively. Pressing Space will select an item.

The Enter key may be used when focus is within the SelectPanel as an alternative to activating the save button.

Props

SelectPanel

Name	Type	Default	Description
title	string \| React.ReactElement	"Select an item" or "Select items"	A descriptive title for the panel
subtitle	string \| React.ReactElement		When provided, a subtitle is displayed below the title
onOpenChange Required	( open: boolean, gesture: \| 'anchor-click' \| 'anchor-key-press' \| 'click-outside' \| 'escape' \| 'selection' ) => void
placeholder	string		Text used in anchor when there are no selected items
placeholderText	string	Filter items	Text used as placeholder for search input
inputLabel	string	Same as placeholderText	The aria-label for the filter input
selected	ItemInput \| ItemInput[] \| undefined		Specify the selected item(s)
onSelectedChange	(selected: ItemInput \| ItemInput[]) => void		Provide a callback called when the selected item(s) change
overlayProps	Partial<OverlayProps>		See Overlay props.
textInputProps	Partial<Omit<TextInputProps, 'onChange'>>		See TextInput props.
footer	string \| React.ReactElement	null	Footer rendered at the end of the panel

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.
Component can adapt to different themes.
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.

Primer Design System

Site navigation

On this page

SelectPanel

Example

Accessibility

Keyboard

Props

SelectPanel

Status

Alpha

Beta

Stable