Maia Documentation

Appearance

maia.component-library / ListBoxItemRootProps

Interface: ListBoxItemRootProps ​

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

Extends ​

Properties ​

aria-label? ​

optional aria-label?: string

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

An accessibility label for this item.

Inherited from ​

ListBoxItemRootProps.aria-label

children? ​

optional children?: ChildrenOrFunction<ListBoxItemRenderProps>

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

The children of the component. A function may be provided to alter the children based on component state.

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-item/list-box-item.d.ts:8

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

Default ​

ts
'react-aria-ListBoxItem'

Overrides ​

ComponentPropsWithRef.className

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 ​

BreadcrumbsItemProps.dir

download? ​

optional download?: string | 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:259

Causes the browser to download the linked URL. A string may be provided to suggest a file name. See MDN.

Inherited from ​

ComponentPropsWithRef.download

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 ​

BreadcrumbsItemProps.hidden

href? ​

optional href?: 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:239

A URL to link to. See MDN.

Inherited from ​

ComponentPropsWithRef.href

hrefLang? ​

optional hrefLang?: 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:244

Hints at the human language of the linked URL. SeeMDN.

Inherited from ​

ComponentPropsWithRef.hrefLang

id? ​

optional id?: Key

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

The unique id of the item.

Inherited from ​

ListBoxItemRootProps.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 ​

BreadcrumbsItemProps.inert

isDisabled? ​

optional isDisabled?: boolean

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

Whether the item is disabled.

Inherited from ​

ListBoxItemRootProps.isDisabled

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 ​

BreadcrumbsItemProps.lang

onAction? ​

optional onAction?: () => void

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

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

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<HTMLDivElement>

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onBlur

onClick? ​

optional onClick?: (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:125

Not recommended – use onPress instead. onClick is an alias for onPress provided for compatibility with other libraries. onPress provides additional event details for non-mouse interactions.

Parameters ​

e ​

MouseEvent<FocusableElement>

Returns ​

void

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<HTMLDivElement>

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

onHoverChange? ​

optional onHoverChange?: (isHovering) => 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:100

Handler that is called when the hover state changes.

Parameters ​

isHovering ​

boolean

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onHoverChange

onHoverEnd? ​

optional onHoverEnd?: (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:98

Handler that is called when a hover interaction ends.

Parameters ​

e ​

HoverEvent

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onHoverEnd

onHoverStart? ​

optional onHoverStart?: (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:96

Handler that is called when a hover interaction starts.

Parameters ​

e ​

HoverEvent

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onHoverStart

onKeyDown? ​

optional onKeyDown?: (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:80

Handler that is called when a key is pressed.

Parameters ​

e ​

KeyboardEvent

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onKeyDown

onKeyUp? ​

optional onKeyUp?: (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:82

Handler that is called when a key is released.

Parameters ​

e ​

KeyboardEvent

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onKeyUp

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

onPress? ​

optional onPress?: (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:105

Handler that is called when the press is released over the target.

Parameters ​

e ​

PressEvent

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onPress

onPressChange? ​

optional onPressChange?: (isPressed) => 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:114

Handler that is called when the press state changes.

Parameters ​

isPressed ​

boolean

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onPressChange

onPressEnd? ​

optional onPressEnd?: (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:112

Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.

Parameters ​

e ​

PressEvent

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onPressEnd

onPressStart? ​

optional onPressStart?: (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:107

Handler that is called when a press interaction starts.

Parameters ​

e ​

PressEvent

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onPressStart

onPressUp? ​

optional onPressUp?: (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:119

Handler that is called when a press is released over the target, regardless of whether it started on the target or not.

Parameters ​

e ​

PressEvent

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onPressUp

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

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

ping? ​

optional ping?: 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:264

A space-separated list of URLs to ping when the link is followed. See MDN.

Inherited from ​

ComponentPropsWithRef.ping

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

referrerPolicy? ​

optional referrerPolicy?: HTMLAttributeReferrerPolicy

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

How much of the referrer to send when following the link. See MDN.

Inherited from ​

ComponentPropsWithRef.referrerPolicy

rel? ​

optional rel?: 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:254

The relationship between the linked resource and the current page. See MDN.

Inherited from ​

ComponentPropsWithRef.rel

render? ​

optional render?: (props, renderProps) => ReactElement

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

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.

Note: You can check if 'href' in props in order to tell whether to render an <a> element.

Requirements:

  • You must render the expected element type (e.g. if <a> is expected, you cannot render a <button>).
  • 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.

Parameters ​

props ​

DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement> | DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement>

renderProps ​

ListBoxItemRenderProps

Returns ​

ReactElement

Inherited from ​

ComponentPropsWithRef.render

routerOptions? ​

optional routerOptions?: undefined

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

Options for the configured client side router.

Inherited from ​

ComponentPropsWithRef.routerOptions

style? ​

optional style?: StyleOrFunction<ListBoxItemRenderProps>

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

target? ​

optional target?: HTMLAttributeAnchorTarget

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

The target window for the link. See MDN.

Inherited from ​

ComponentPropsWithRef.target

textValue? ​

optional textValue?: string

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

A string representation of the item's contents, used for features like typeahead.

Inherited from ​

ListBoxItemRootProps.textValue

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 ​

BreadcrumbsItemProps.translate

value? ​

optional value?: unknown

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

The object value that this item represents. When using dynamic collections, this is set automatically.

Inherited from ​

ComponentPropsWithRef.value

variant? ​

optional variant?: "default" | "danger"

Inherited from ​

ButtonRootProps.variant