Select

A select list enables users to select one or more items from a list. Use a select list when options are dynamic or variable.

Info alert:Beta feature

This beta component is currently under review and is still open for further evolution. It is available for use in product. Beta components are considered for promotion on a quarterly basis. Please join in and give us your feedback or submit any questions on the PatternFly forum or via Slack. To learn more about the process, visit our about page or our Beta components page on GitHub.

Info alert:Templates

This page showcases templates for the select component. A template combines a component with logic that supports a specific use case, with a streamlined API that offers additional, limited customization.

Note: Templates live in their own package at @patternfly/react-templates!

For custom use cases, please see the select component suite from @patternfly/react-core.

Select template examples

Simple

isDisabled

Checkbox

Props

SelectSimple

*required
Name	Type	Description
initialOptions	SelectSimpleOption[]	Initial options of the select.
isDisabled	boolean	Flag indicating the select should be disabled.
onSelect	(_event: React.MouseEvent<Element, MouseEvent>, selection: string \| number) => void	Callback triggered on selection.
onToggle	(nextIsOpen: boolean) => void	Callback triggered when the select opens or closes.
toggleContent	React.ReactNode	Content of the toggle. Defaults to the selected option.
toggleWidth	string	Width of the toggle

CheckboxSelect

*required
Name	Type	Description
initialOptions	CheckboxSelectOption[]	Initial options of the select.
isDisabled	boolean	Flag indicating the select should be disabled.
onSelect	(_event: React.MouseEvent<Element, MouseEvent>, value?: string \| number) => void	Callback triggered on selection.
onToggle	(nextIsOpen: boolean) => void	Callback triggered when the select opens or closes.
toggleContent	React.ReactNode	Content of the toggle. Defaults to the selected option.

View source on GitHub