@aria-ui/select

@aria-ui/select

SelectContentEvents #

Group

PopoverContent

escapeKeyDown: EscapeKeyDownEvent

Fired when the escape key is pressed.

By default, the popover will be closed. It can be prevented by calling preventDefault().

focusOutside: FocusOutsideEvent

Fired when the focus is moved outside the element.

By default, the popover will be closed. It can be prevented by calling preventDefault().

interactOutside: InteractOutsideEvent

Fired when an interaction (pointer or focus) happens outside the component.

By default, the popover will be closed. It can be prevented by calling preventDefault().

pointerDownOutside: PointerDownOutsideEvent

Fired when the pointer is pressed down outside the element.

By default, the popover will be closed. It can be prevented by calling preventDefault().

SelectItemProps #

Group

SelectItem

value: string

The value of the item. Every item must have a unique value in the parent list.

Default: ""

SelectListEvents #

Group

SelectList

valueChange: CustomEvent<string>

SelectListProps #

Group

SelectList

autoFocus: boolean

Whether the listbox should automatically set the focus to the first item when the listbox is mounted or when the query changes.

Default: false

eventTarget?: HTMLElement | TypedEventTarget<"keydown">

By default, the Listbox element will listen for keydown events. You can pass a different element to listen for keydown events.

filter: null | ItemFilter

The filter function to determine if an item should be shown in the listbox. By default, a simple case-insensitive substring match is used. You can provide a custom filter function to match against a more complex pattern. You can also pass null to disable filtering and allow all items to be shown.

Default: defaultItemFilter

query: string

The query string to filter the listbox items.

Default: ""

selectionMode: "multiple" | "single"

Listbox selection mode

(Currently only single selection mode is implemented)

Default: "single"

value: string

The selected value.

Default: ""

SelectRootEvents #

Group

SelectRoot

openChange: CustomEvent<boolean>

SelectRootProps #

Group

SelectRoot

defaultOpen: boolean

Whether the popover is open by default.

Default: false

open: boolean

Whether the popover is open.

Default: false

SelectValueProps #

Group

SelectValue

placeholder: string

The value to show when no item is selected

Default: ""

selectContentEvents #

Type: EventDeclarations<PopoverContentEvents>