Maia Documentation

Appearance

maia.component-library / ListBoxRootProps

Interface: ListBoxRootProps<T> ​

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/list-box/list-box.d.ts:4

Extends ​

Type Parameters ​

T ​

T extends object

Properties ​

aria-describedby? ​

optional aria-describedby?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:51

Identifies the element (or elements) that describes the object.

Inherited from ​

AlertDialogDialogProps.aria-describedby

aria-details? ​

optional aria-details?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:57

Identifies the element (or elements) that provide a detailed, extended description for the object.

Inherited from ​

AlertDialogDialogProps.aria-details

aria-label? ​

optional aria-label?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:41

Defines a string value that labels the current element.

Inherited from ​

AlertDialogDialogProps.aria-label

aria-labelledby? ​

optional aria-labelledby?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:46

Identifies the element (or elements) that labels the current element.

Inherited from ​

AlertDialogDialogProps.aria-labelledby

autoFocus? ​

optional autoFocus?: boolean | FocusStrategy

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/listbox/useListBox.d.ts:6

Whether to auto focus the listbox or an option.

Inherited from ​

ComponentPropsWithRef.autoFocus

children? ​

optional children?: ReactNode | ((item) => ReactNode)

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Collection.d.ts:7

The contents of the collection.

Inherited from ​

ComponentPropsWithRef.children

className? ​

optional className?: string

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/list-box/list-box.d.ts:5

The CSS className for the element. A function may be provided to compute the class based on component state.

Default ​

ts
'react-aria-ListBox'

Overrides ​

ComponentPropsWithRef.className

defaultSelectedKeys? ​

optional defaultSelectedKeys?: "all" | Iterable<Key, any, any>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/selection.d.ts:37

The initial selected keys in the collection (uncontrolled).

Inherited from ​

ComponentPropsWithRef.defaultSelectedKeys

dependencies? ​

optional dependencies?: readonly any[]

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/Collection.d.ts:9

Values that should invalidate the item cache when using dynamic collections.

Inherited from ​

ComponentPropsWithRef.dependencies

dir? ​

optional dir?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:299

Inherited from ​

ComponentPropsWithRef.dir

disabledKeys? ​

optional disabledKeys?: Iterable<Key, any, any>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/collections.d.ts:70

The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.

Inherited from ​

ComponentPropsWithRef.disabledKeys

disallowEmptySelection? ​

optional disallowEmptySelection?: boolean

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/selection.d.ts:33

Whether the collection allows empty selection.

Inherited from ​

ComponentPropsWithRef.disallowEmptySelection

dragAndDropHooks? ​

optional dragAndDropHooks?: DragAndDropHooks<NoInfer<T>>

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/ListBox.d.ts:70

The drag and drop hooks returned by useDragAndDrop used to enable drag and drop behavior for the ListBox.

Inherited from ​

ComponentPropsWithRef.dragAndDropHooks

escapeKeyBehavior? ​

optional escapeKeyBehavior?: "none" | "clearSelection"

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/listbox/useListBox.d.ts:20

Whether pressing the escape key should clear selection in the listbox or not.

Most experiences should not modify this option as it eliminates a keyboard user's ability to easily clear selection. Only use if the escape key is being handled externally or should not trigger selection clearing contextually.

Default ​

ts
'clearSelection'

Inherited from ​

ComponentPropsWithRef.escapeKeyBehavior

hidden? ​

optional hidden?: boolean

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:301

Inherited from ​

ComponentPropsWithRef.hidden

id? ​

optional id?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:75

The element's unique identifier. See MDN.

Inherited from ​

AlertDialogDialogProps.id

inert? ​

optional inert?: boolean

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:302

Inherited from ​

ComponentPropsWithRef.inert

items? ​

optional items?: Iterable<T, any, any>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/collections.d.ts:65

Item objects in the collection.

Inherited from ​

ComponentPropsWithRef.items

key? ​

optional key?: Key | null

Defined in: node_modules/.pnpm/@types+react@19.2.17/node_modules/@types/react/index.d.ts:259

Inherited from ​

ComponentPropsWithRef.key

lang? ​

optional lang?: string

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:300

Inherited from ​

ComponentPropsWithRef.lang

layout? ​

optional layout?: "grid" | "stack"

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/ListBox.d.ts:78

Whether the items are arranged in a stack or grid.

Default ​

ts
'stack'

Inherited from ​

ComponentPropsWithRef.layout

onAction? ​

optional onAction?: (key) => void

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/listbox/useListBox.d.ts:37

Handler that is called when a user performs an action on an item. The exact user event depends on the collection's selectionBehavior prop and the interaction modality.

Parameters ​

key ​

Key

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onAction

onAnimationEnd? ​

optional onAnimationEnd?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:382

Inherited from ​

ComponentPropsWithRef.onAnimationEnd

onAnimationEndCapture? ​

optional onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:383

Inherited from ​

ComponentPropsWithRef.onAnimationEndCapture

onAnimationIteration? ​

optional onAnimationIteration?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:384

Inherited from ​

ComponentPropsWithRef.onAnimationIteration

onAnimationIterationCapture? ​

optional onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:385

Inherited from ​

ComponentPropsWithRef.onAnimationIterationCapture

onAnimationStart? ​

optional onAnimationStart?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:380

Inherited from ​

ComponentPropsWithRef.onAnimationStart

onAnimationStartCapture? ​

optional onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:381

Inherited from ​

ComponentPropsWithRef.onAnimationStartCapture

onAuxClick? ​

optional onAuxClick?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:322

Inherited from ​

ComponentPropsWithRef.onAuxClick

onAuxClickCapture? ​

optional onAuxClickCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:323

Inherited from ​

ComponentPropsWithRef.onAuxClickCapture

onBlur? ​

optional onBlur?: (e) => void

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/events.d.ts:89

Handler that is called when the element loses focus.

Parameters ​

e ​

FocusEvent<Element>

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onBlur

onClick? ​

optional onClick?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:320

Inherited from ​

ComponentPropsWithRef.onClick

onClickCapture? ​

optional onClickCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:321

Inherited from ​

ComponentPropsWithRef.onClickCapture

onContextMenu? ​

optional onContextMenu?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:324

Inherited from ​

ComponentPropsWithRef.onContextMenu

onContextMenuCapture? ​

optional onContextMenuCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:325

Inherited from ​

ComponentPropsWithRef.onContextMenuCapture

onDoubleClick? ​

optional onDoubleClick?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:326

Inherited from ​

ComponentPropsWithRef.onDoubleClick

onDoubleClickCapture? ​

optional onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:327

Inherited from ​

ComponentPropsWithRef.onDoubleClickCapture

onFocus? ​

optional onFocus?: (e) => void

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/events.d.ts:87

Handler that is called when the element receives focus.

Parameters ​

e ​

FocusEvent<Element>

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onFocus

onFocusChange? ​

optional onFocusChange?: (isFocused) => void

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/events.d.ts:91

Handler that is called when the element's focus status changes.

Parameters ​

isFocused ​

boolean

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onFocusChange

onGotPointerCapture? ​

optional onGotPointerCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:366

Inherited from ​

ComponentPropsWithRef.onGotPointerCapture

onGotPointerCaptureCapture? ​

optional onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:367

Inherited from ​

ComponentPropsWithRef.onGotPointerCaptureCapture

onLostPointerCapture? ​

optional onLostPointerCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:368

Inherited from ​

ComponentPropsWithRef.onLostPointerCapture

onLostPointerCaptureCapture? ​

optional onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:369

Inherited from ​

ComponentPropsWithRef.onLostPointerCaptureCapture

onMouseDown? ​

optional onMouseDown?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:328

Inherited from ​

ComponentPropsWithRef.onMouseDown

onMouseDownCapture? ​

optional onMouseDownCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:329

Inherited from ​

ComponentPropsWithRef.onMouseDownCapture

onMouseEnter? ​

optional onMouseEnter?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:330

Inherited from ​

ComponentPropsWithRef.onMouseEnter

onMouseLeave? ​

optional onMouseLeave?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:331

Inherited from ​

ComponentPropsWithRef.onMouseLeave

onMouseMove? ​

optional onMouseMove?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:332

Inherited from ​

ComponentPropsWithRef.onMouseMove

onMouseMoveCapture? ​

optional onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:333

Inherited from ​

ComponentPropsWithRef.onMouseMoveCapture

onMouseOut? ​

optional onMouseOut?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:334

Inherited from ​

ComponentPropsWithRef.onMouseOut

onMouseOutCapture? ​

optional onMouseOutCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:335

Inherited from ​

ComponentPropsWithRef.onMouseOutCapture

onMouseOver? ​

optional onMouseOver?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:336

Inherited from ​

ComponentPropsWithRef.onMouseOver

onMouseOverCapture? ​

optional onMouseOverCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:337

Inherited from ​

ComponentPropsWithRef.onMouseOverCapture

onMouseUp? ​

optional onMouseUp?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:338

Inherited from ​

ComponentPropsWithRef.onMouseUp

onMouseUpCapture? ​

optional onMouseUpCapture?: MouseEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:339

Inherited from ​

ComponentPropsWithRef.onMouseUpCapture

onPointerCancel? ​

optional onPointerCancel?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:358

Inherited from ​

ComponentPropsWithRef.onPointerCancel

onPointerCancelCapture? ​

optional onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:359

Inherited from ​

ComponentPropsWithRef.onPointerCancelCapture

onPointerDown? ​

optional onPointerDown?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:352

Inherited from ​

ComponentPropsWithRef.onPointerDown

onPointerDownCapture? ​

optional onPointerDownCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:353

Inherited from ​

ComponentPropsWithRef.onPointerDownCapture

onPointerEnter? ​

optional onPointerEnter?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:360

Inherited from ​

ComponentPropsWithRef.onPointerEnter

onPointerLeave? ​

optional onPointerLeave?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:361

Inherited from ​

ComponentPropsWithRef.onPointerLeave

onPointerMove? ​

optional onPointerMove?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:354

Inherited from ​

ComponentPropsWithRef.onPointerMove

onPointerMoveCapture? ​

optional onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:355

Inherited from ​

ComponentPropsWithRef.onPointerMoveCapture

onPointerOut? ​

optional onPointerOut?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:364

Inherited from ​

ComponentPropsWithRef.onPointerOut

onPointerOutCapture? ​

optional onPointerOutCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:365

Inherited from ​

ComponentPropsWithRef.onPointerOutCapture

onPointerOver? ​

optional onPointerOver?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:362

Inherited from ​

ComponentPropsWithRef.onPointerOver

onPointerOverCapture? ​

optional onPointerOverCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:363

Inherited from ​

ComponentPropsWithRef.onPointerOverCapture

onPointerUp? ​

optional onPointerUp?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:356

Inherited from ​

ComponentPropsWithRef.onPointerUp

onPointerUpCapture? ​

optional onPointerUpCapture?: PointerEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:357

Inherited from ​

ComponentPropsWithRef.onPointerUpCapture

onScroll? ​

optional onScroll?: UIEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:372

Inherited from ​

ComponentPropsWithRef.onScroll

onScrollCapture? ​

optional onScrollCapture?: UIEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:373

Inherited from ​

ComponentPropsWithRef.onScrollCapture

onSelectionChange? ​

optional onSelectionChange?: (keys) => void

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/selection.d.ts:39

Handler that is called when the selection changes.

Parameters ​

keys ​

Selection

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onSelectionChange

onTouchCancel? ​

optional onTouchCancel?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:342

Inherited from ​

ComponentPropsWithRef.onTouchCancel

onTouchCancelCapture? ​

optional onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:343

Inherited from ​

ComponentPropsWithRef.onTouchCancelCapture

onTouchEnd? ​

optional onTouchEnd?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:344

Inherited from ​

ComponentPropsWithRef.onTouchEnd

onTouchEndCapture? ​

optional onTouchEndCapture?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:345

Inherited from ​

ComponentPropsWithRef.onTouchEndCapture

onTouchMove? ​

optional onTouchMove?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:346

Inherited from ​

ComponentPropsWithRef.onTouchMove

onTouchMoveCapture? ​

optional onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:347

Inherited from ​

ComponentPropsWithRef.onTouchMoveCapture

onTouchStart? ​

optional onTouchStart?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:348

Inherited from ​

ComponentPropsWithRef.onTouchStart

onTouchStartCapture? ​

optional onTouchStartCapture?: TouchEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:349

Inherited from ​

ComponentPropsWithRef.onTouchStartCapture

onTransitionCancel? ​

optional onTransitionCancel?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:388

Inherited from ​

ComponentPropsWithRef.onTransitionCancel

onTransitionCancelCapture? ​

optional onTransitionCancelCapture?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:389

Inherited from ​

ComponentPropsWithRef.onTransitionCancelCapture

onTransitionEnd? ​

optional onTransitionEnd?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:390

Inherited from ​

ComponentPropsWithRef.onTransitionEnd

onTransitionEndCapture? ​

optional onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:391

Inherited from ​

ComponentPropsWithRef.onTransitionEndCapture

onTransitionRun? ​

optional onTransitionRun?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:392

Inherited from ​

ComponentPropsWithRef.onTransitionRun

onTransitionRunCapture? ​

optional onTransitionRunCapture?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:393

Inherited from ​

ComponentPropsWithRef.onTransitionRunCapture

onTransitionStart? ​

optional onTransitionStart?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:394

Inherited from ​

ComponentPropsWithRef.onTransitionStart

onTransitionStartCapture? ​

optional onTransitionStartCapture?: TransitionEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:395

Inherited from ​

ComponentPropsWithRef.onTransitionStartCapture

onWheel? ​

optional onWheel?: WheelEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:376

Inherited from ​

ComponentPropsWithRef.onWheel

onWheelCapture? ​

optional onWheelCapture?: WheelEventHandler<HTMLDivElement>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:377

Inherited from ​

ComponentPropsWithRef.onWheelCapture

orientation? ​

optional orientation?: Orientation

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/ListBox.d.ts:85

The primary orientation of the items. Usually this is the direction that the collection scrolls.

Default ​

ts
'vertical'

Inherited from ​

ComponentPropsWithRef.orientation

ref? ​

optional ref?: Ref<HTMLDivElement>

Defined in: node_modules/.pnpm/@types+react@19.2.17/node_modules/@types/react/index.d.ts:301

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

See ​

React Docs

Inherited from ​

ComponentPropsWithRef.ref

render? ​

optional render?: DOMRenderFunction<"div", ListBoxRenderProps>

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:194

Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.

Requirements:

  • You must render the expected element type (e.g. if <button> is expected, you cannot render an <a>).
  • Only a single root DOM element can be rendered (no fragments).
  • You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.

Inherited from ​

ComponentPropsWithRef.render

renderEmptyState? ​

optional renderEmptyState?: (props) => ReactNode

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/ListBox.d.ts:72

Provides content to display when there are no items in the list.

Parameters ​

props ​

ListBoxRenderProps

Returns ​

ReactNode

Inherited from ​

ComponentPropsWithRef.renderEmptyState

selectedKeys? ​

optional selectedKeys?: "all" | Iterable<Key, any, any>

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/selection.d.ts:35

The currently selected keys in the collection (controlled).

Inherited from ​

ComponentPropsWithRef.selectedKeys

selectionBehavior? ​

optional selectionBehavior?: SelectionBehavior

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/ListBox.d.ts:65

How multiple selection should behave in the collection.

Default ​

ts
'toggle'

Inherited from ​

ComponentPropsWithRef.selectionBehavior

selectionMode? ​

optional selectionMode?: SelectionMode

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/selection.d.ts:31

The type of selection that is allowed in the collection.

Inherited from ​

ComponentPropsWithRef.selectionMode

shouldFocusOnHover? ​

optional shouldFocusOnHover?: boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/listbox/useListBox.d.ts:32

Whether options should be focused when the user hovers over them.

Inherited from ​

ComponentPropsWithRef.shouldFocusOnHover

shouldFocusWrap? ​

optional shouldFocusWrap?: boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/listbox/useListBox.d.ts:8

Whether focus should wrap around when the end/start is reached.

Inherited from ​

ComponentPropsWithRef.shouldFocusWrap

shouldSelectOnPressUp? ​

optional shouldSelectOnPressUp?: boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/listbox/useListBox.d.ts:30

Whether selection should occur on press up instead of press down.

Inherited from ​

ComponentPropsWithRef.shouldSelectOnPressUp

slot? ​

optional slot?: string | null

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:158

A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

Inherited from ​

ComponentPropsWithRef.slot

style? ​

optional style?: StyleOrFunction<ListBoxRenderProps>

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:118

The inline style for the element. A function may be provided to compute the style based on component state.

Inherited from ​

ComponentPropsWithRef.style

translate? ​

optional translate?: "yes" | "no"

Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:303

Inherited from ​

ComponentPropsWithRef.translate

variant? ​

optional variant?: "default" | "danger"

Inherited from ​

ButtonRootProps.variant