Combobox

Combobox presents user with a set of options and allows to select one of them.

#

Combobox should be disabled, when user shouldn't be allowed to interact with it.

Individual options can be disabled too.

You can also provide a custom message when an option is disabled:

#

Mark combobox as loading, when options are fetched on the fly and are not yet available.

#

Invalid combobox indicates that current value isn't what the system expects.

#

Clearable combobox should be used when empty selection is acceptable.

#

Options can display an additional descriptive text underneath the label.

Options can display additional accessories view before and after the label. You can show an image using an image accessory. This is useful for showing logos when selecting sources or destinations, for example.

Additionally, using the showPlaceholderIcon prop will render a dotted circle in the placeholder state.

Icons can be accessories too.

Accessories can be shown on the left or right.

#

The combobox supports filtering options based on the input value. This state is accessible via the onSearchUpdate prop. Any change that's typed in the input will call this function.

#

Use an icon button trigger to open the combobox with a compact icon button. The search input will appear inside the popover.

#

Use a component trigger to open the combobox with a custom React component that receives props to spread onto the trigger element (onClick, disabled, aria-*, etc.). The search input will appear inside the popover.

Set renderInputInControl to false to render the combobox input inside of the popover.

#

You can disable sorting and filtering internally by setting disableSortingAndFiltering to true. This could be helpful if the options are already sorted and filtered externally.

#

Combobox allows user to create a new option on the fly, when no suitable option exists. For that, enable supportsCreatableOptions and set an onCreateOption function that will handle creation of options. Options can be created asynchronously, but you need to handle loading state yourself via isLoading prop.

#

You don't have to create objects with label and value keys as shown in the examples above. Combobox supports any objects, as long as you provide a label and value for each option via optionLabel and optionValue functions. description may be replaced with the optionDescription function.

When rendering smaller-width comboboxes, you may end up with options that are quite tall. To make the options easier to read, pass in a specific width for the popover using popoverWidth.

It is recommended to match widths, when possible.

Show a header section within the combobox when the options are displayed.

#

When there are more options than fit in the popover, the popover becomes scrollable.

#

When single selection is required.
When user should be able to create new options, if needed.
When selecting from user-generated data, where searching might come handy for long lists.

#

Use sentence case.

#

Name	Default	Description
`isDisabled`	—	`boolean` Determines if combobox is disabled.
`isLoading`	—	`boolean` Indicates that options are being loaded.
`isInvalid`	—	`boolean` Indicates that combobox is in invalid state.
`isClearable`	`false`	`boolean` Determines if selection can be cleared.
`isOptionDisabled`	—	`(option: Option) => boolean \| string` Function to determine whether an option should be disabled. If a string is returned, it will be used as a disabled message.
`emptyOptionsMessage`	`"No options"`	`string` Text to show inside a dropdown when there are no options.
`disableSortingAndFiltering`	`false`	`boolean` Determines if the options should be sorted and filtered internally.
`optionDescription`	—	`(option: Option) => string` Function to extract description from an option. If it's not provided, `description` field will be used as a label.
`optionValue`	—	`(option: Option) => OptionValue` Function to extract value from an option. If it's not provided, `value` field will be used as a value.
`placeholder`	—	`string` Text to show inside combobox when no option is selected.
`removePortal`	`false`	`boolean` Determines if the select dropdown should be rendered in a portal.
`showPlaceholderIcon`	`false`	`boolean` Determines if the placeholder icon should be shown. Only available when optionAccessory is defined.
`size`	`"md"`	`"sm" \| "md" \| "lg"` Combobox height.
`value`	—	`OptionValue \| undefined` Selected option.
`variant`	`"default"`	`"default" \| "alternative" \| "tertiary"` Determines the appearance of the combobox.
`fontWeight`	`"normal"`	`"normal" \| "medium"` Determines the font weight of the value and placeholder text.
`onChange`	—	`(value: OptionValue \| undefined) => void` Callback for when user selects a different option or clears the selection.
`onSearchUpdate`	—	`(inputValue: string) => void` Callback for when user changes the input value.
`comboboxRef`	—	`RefObject<HTMLInputElement>` Reference to the combobox input element.
`headerLabel`	—	`string` Show a header label at the top when displaying the options.
`headerDescription`	—	`string` Show a header description at the top when displaying the options.
`isLazy`	`true`	`boolean` Determines if the popover content should be lazily rendered. When true, content is only rendered when the popover is opened for the first time. Note: Should be set to false when using icon trigger, or when renderInputInControl is false, to prevent scroll jumping on first open.
`supportsCreatableOptions`	—	`boolean` Determines if user is allowed to create a new option, if it's not present already.
`createOptionMessage`	`"Create "[input value]""`	`(inputValue: string) => string` Text to show inside dropdown when creating a new option.
`options`	—	`Option[]` Available options. `Option` is a generic, so type of options will be inferred.
`optionLabel`	—	`(option: Option) => string` Function to extract label from an option. If it's not provided, `label` field will be used as a label.
`optionAccessories`	—	`IconAccessoriesGetter<Option>` Function to show accessories near the option label.
`trigger`	`{ type: 'input' }`	`{ \| type?: "input"; \| } \| { \| type: "component"; \| component: (props: ComboboxTriggerComponentProps) => ReactNode; \| } \| { \| type: "icon"; \| icon: IconButtonProps["icon"]; \| "aria-label": string; \| shape?: IconButtonProps["shape"]; \| }` Configuration for the combobox trigger element. Controls whether the combobox is opened via an input field or icon button.
`popoverWidth`	`undefined`	`"4xs" \| "3xs" \| "2xs" \| "xs" \| "sm" \| "md" \| "lg"` The dropdown width. If not provided, the select width will be used.
`onCreateOption`	—	`(inputValue: string) => Promise<void> \| void` Callback for creating a new option. It can be async.
`onClose`	—	`() => void` Callback for when user closes the select.
`onOpen`	—	`() => void` Callback for when user opens the select.
`valueLabel`	—	`(option: Option) => string` Function to format a selected option's label. If not provided, `label` field will be used as a label.
`renderInputInControl`	`true`	`boolean` Determines if the input should be rendered in the control. Only applies when trigger.type is "input".
`width`	`"xs"`	`"4xs" \| "3xs" \| "2xs" \| "xs" \| "sm" \| "md" \| "lg" \| "xl" \| "auto" \| "fit-content" \| "100%"` Combobox width.

#

Name	Default	Description
`isDisabled`	—	`boolean` Determines if combobox is disabled.
`isLoading`	—	`boolean` Indicates that options are being loaded.
`isInvalid`	—	`boolean` Indicates that combobox is in invalid state.
`isClearable`	`false`	`boolean` Determines if selection can be cleared.
`isOptionDisabled`	—	`(option: Option) => boolean \| string` Function to determine whether an option should be disabled. If a string is returned, it will be used as a disabled message.
`emptyOptionsMessage`	`"No options"`	`string` Text to show inside a dropdown when there are no options.
`disableSortingAndFiltering`	`false`	`boolean` Determines if the options should be sorted and filtered internally.
`optionDescription`	—	`(option: Option) => string` Function to extract description from an option. If it's not provided, `description` field will be used as a label.
`optionValue`	—	`(option: Option) => OptionValue` Function to extract value from an option. If it's not provided, `value` field will be used as a value.
`placeholder`	—	`string` Text to show inside combobox when no option is selected.
`removePortal`	`false`	`boolean` Determines if the select dropdown should be rendered in a portal.
`showPlaceholderIcon`	`false`	`boolean` Determines if the placeholder icon should be shown. Only available when optionAccessory is defined.
`size`	`"md"`	`"sm" \| "md" \| "lg"` Combobox height.
`value`	—	`OptionValue \| undefined` Selected option.
`variant`	`"default"`	`"default" \| "alternative" \| "tertiary"` Determines the appearance of the combobox.
`fontWeight`	`"normal"`	`"normal" \| "medium"` Determines the font weight of the value and placeholder text.
`onChange`	—	`(value: OptionValue \| undefined) => void` Callback for when user selects a different option or clears the selection.
`onSearchUpdate`	—	`(inputValue: string) => void` Callback for when user changes the input value.
`comboboxRef`	—	`RefObject<HTMLInputElement>` Reference to the combobox input element.
`isLazy`	`true`	`boolean` Determines if the popover content should be lazily rendered. When true, content is only rendered when the popover is opened for the first time. Note: Should be set to false when using icon trigger, or when renderInputInControl is false, to prevent scroll jumping on first open.
`optionGroups`	—	`Array<{ label: string; options: Option[]; }>` Available options. `Option` is a generic, so type of options will be inferred.
`optionLabel`	—	`(option: Option) => string` Function to extract label from an option. If it's not provided, `label` field will be used as a label.
`optionAccessories`	—	`IconAccessoriesGetter<Option>` Function to show an accessory view near the option label.
`trigger`	`{ type: 'input' }`	`{ \| type?: "input"; \| } \| { \| type: "component"; \| component: (props: ComboboxTriggerComponentProps) => ReactNode; \| } \| { \| type: "icon"; \| icon: IconButtonProps["icon"]; \| "aria-label": string; \| shape?: IconButtonProps["shape"]; \| }` Configuration for the combobox trigger element. Controls whether the combobox is opened via an input field or icon button.
`popoverWidth`	`undefined`	`"4xs" \| "3xs" \| "2xs" \| "xs" \| "sm" \| "md" \| "lg"` The dropdown width. If not provided, the select width will be used.
`valueLabel`	—	`(option: Option) => string` Function to format a selected option's label. If not provided, `label` field will be used as a label.
`renderInputInControl`	`true`	`boolean` Determines if the input should be rendered in the control. Only applies when trigger.type is "input".
`width`	`"xs"`	`"4xs" \| "3xs" \| "2xs" \| "xs" \| "sm" \| "md" \| "lg" \| "xl" \| "auto" \| "fit-content" \| "100%"` Combobox width.

Combobox

#Disabled

#Loading

#Invalid

#Clearable

#Description

#Accessories

#Search

#Icon button trigger

#Component trigger

#Rendering the input inside of the popover

#Disable sorting and filtering

#Creatable options

#Custom objects

#Groups

#Medium font weight

#Alternative variant

#Tertiary variant

#Size

#Popover width

#Header

#Scrolling

#Guidelines

#When to use

#Content

#Props

#Combobox

#GroupedCombobox

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#

#