@aria-ui/select v0.0.26
@aria-ui/select
SelectContentEvents #
escapeKeyDown
Fired when the escape key is pressed.
By default, the popover will be closed. It can be prevented by calling preventDefault()
.
Type: EscapeKeyDownEvent
focusOutside
Fired when the focus is moved outside the element.
By default, the popover will be closed. It can be prevented by calling preventDefault()
.
Type: FocusOutsideEvent
interactOutside
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()
.
Type: InteractOutsideEvent
pointerDownOutside
Fired when the pointer is pressed down outside the element.
By default, the popover will be closed. It can be prevented by calling preventDefault()
.
Type: PointerDownOutsideEvent
SelectItemProps #
value
The value of the item. Every item must have a unique value in the parent list.
Type: string
Default: ""
SelectListEvents #
valueChange
Type: CustomEvent<string>
SelectListProps #
autoFocus
Whether the listbox should automatically set the focus to the first item when the listbox is mounted or when the query changes.
Type: boolean
Default: false
eventTarget
By default, the Listbox element will listen for keydown events. You can pass a different element to listen for keydown events.
Type: HTMLElement | TypedEventTarget<"keydown">
filter
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.
Type: null | ItemFilter
Default: defaultItemFilter
query
The query string to filter the listbox items.
Type: string
Default: ""
selectionMode
Listbox selection mode
(Currently only single selection mode is implemented)
Type: "multiple" | "single"
Default: "single"
value
The selected value.
Type: string
Default: ""
SelectRootEvents #
openChange
Type: CustomEvent<boolean>
SelectRootProps #
defaultOpen
Whether the popover is open by default.
Type: boolean
Default: false
open
Whether the popover is open.
Type: boolean
Default: false
SelectValueProps #
placeholder
The value to show when no item is selected
Type: string
Default: ""
selectContentEvents #
Type: EventDeclarations<PopoverContentEvents>
8 months ago
8 months ago
8 months ago
12 months ago
12 months ago
12 months ago
11 months ago
1 year ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago