Maia Documentation

Appearance

maia.component-library / ButtonRootProps

Interface: ButtonRootProps ​

Defined in: lib/components/Atoms/Button/Button.tsx:40

Extends ​

  • ButtonRootProps

Properties ​

__button_group_child? ​

optional __button_group_child?: boolean

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/button/button.d.ts:6

Inherited from ​

ButtonRootProps.__button_group_child

aria-controls? ​

optional aria-controls?: string

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:26

Identifies the element (or elements) whose contents or presence are controlled by the current element.

Inherited from ​

ButtonRootProps.aria-controls

aria-current? ​

optional aria-current?: boolean | "time" | "step" | "true" | "false" | "page" | "location" | "date"

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:33

Indicates whether this element represents the current item within a container or set of related elements.

Inherited from ​

ButtonRootProps.aria-current

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-disabled? ​

optional aria-disabled?: boolean | "true" | "false"

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:11

Indicates whether the element is disabled to users of assistive technology.

Inherited from ​

ButtonRootProps.aria-disabled

aria-expanded? ​

optional aria-expanded?: boolean | "true" | "false"

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:16

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Inherited from ​

ButtonRootProps.aria-expanded

aria-haspopup? ​

optional aria-haspopup?: boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:21

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

Inherited from ​

ButtonRootProps.aria-haspopup

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

aria-pressed? ​

optional aria-pressed?: boolean | "true" | "false" | "mixed"

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:28

Indicates the current "pressed" state of toggle buttons.

Inherited from ​

ButtonRootProps.aria-pressed

autoFocus? ​

optional autoFocus?: boolean

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

Whether the element should receive focus on render.

Inherited from ​

ButtonRootProps.autoFocus

children? ​

optional children?: ChildrenOrFunction<ButtonRenderProps>

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 ​

ButtonRootProps.children

className? ​

optional className?: ClassNameOrFunction<ButtonRenderProps>

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

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

Default ​

ts
'react-aria-Button'

Inherited from ​

ButtonRootProps.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

excludeFromTabOrder? ​

optional excludeFromTabOrder?: 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:85

Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.

Inherited from ​

ButtonRootProps.excludeFromTabOrder

form? ​

optional form?: string

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:53

The <form> element to associate the button with. The value of this attribute must be the id of a <form> in the same document. See MDN.

Inherited from ​

ButtonRootProps.form

formAction? ​

optional formAction?: string | ((formData) => void | Promise<void>)

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:58

The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner.

Inherited from ​

ButtonRootProps.formAction

formEncType? ​

optional formEncType?: string

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:60

Indicates how to encode the form data that is submitted.

Inherited from ​

ButtonRootProps.formEncType

formMethod? ​

optional formMethod?: string

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:62

Indicates the HTTP method used to submit the form.

Inherited from ​

ButtonRootProps.formMethod

formNoValidate? ​

optional formNoValidate?: boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:64

Indicates that the form is not to be validated when it is submitted.

Inherited from ​

ButtonRootProps.formNoValidate

formTarget? ​

optional formTarget?: string

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:66

Overrides the target attribute of the button's form owner.

Inherited from ​

ButtonRootProps.formTarget

fullWidth? ​

optional fullWidth?: boolean

Inherited from ​

ButtonRootProps.fullWidth

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

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 ​

BreadcrumbsItemProps.inert

isDisabled? ​

optional isDisabled?: boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:5

Whether the button is disabled.

Inherited from ​

ButtonRootProps.isDisabled

isIconOnly? ​

optional isIconOnly?: boolean

Inherited from ​

ButtonRootProps.isIconOnly

isPending? ​

optional isPending?: boolean

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

Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers.

Inherited from ​

ButtonRootProps.isPending

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 ​

ButtonRootProps.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

name? ​

optional name?: string

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:68

Submitted as a pair with the button's value as part of the form data.

Inherited from ​

ButtonRootProps.name

onAnimationEnd? ​

optional onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onAnimationEnd

onAnimationEndCapture? ​

optional onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onAnimationEndCapture

onAnimationIteration? ​

optional onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onAnimationIteration

onAnimationIterationCapture? ​

optional onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onAnimationIterationCapture

onAnimationStart? ​

optional onAnimationStart?: AnimationEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onAnimationStart

onAnimationStartCapture? ​

optional onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onAnimationStartCapture

onAuxClick? ​

optional onAuxClick?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onAuxClick

onAuxClickCapture? ​

optional onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

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

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

TagRootProps.onClick

onClickCapture? ​

optional onClickCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onClickCapture

onContextMenu? ​

optional onContextMenu?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onContextMenu

onContextMenuCapture? ​

optional onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onContextMenuCapture

onDoubleClick? ​

optional onDoubleClick?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onDoubleClick

onDoubleClickCapture? ​

optional onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

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

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

ButtonRootProps.onFocusChange

onGotPointerCapture? ​

optional onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onGotPointerCapture

onGotPointerCaptureCapture? ​

optional onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

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

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

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

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

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

ListBoxItemRootProps.onKeyUp

onLostPointerCapture? ​

optional onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onLostPointerCapture

onLostPointerCaptureCapture? ​

optional onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onLostPointerCaptureCapture

onMouseDown? ​

optional onMouseDown?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseDown

onMouseDownCapture? ​

optional onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseDownCapture

onMouseEnter? ​

optional onMouseEnter?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseEnter

onMouseLeave? ​

optional onMouseLeave?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseLeave

onMouseMove? ​

optional onMouseMove?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseMove

onMouseMoveCapture? ​

optional onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseMoveCapture

onMouseOut? ​

optional onMouseOut?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseOut

onMouseOutCapture? ​

optional onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseOutCapture

onMouseOver? ​

optional onMouseOver?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseOver

onMouseOverCapture? ​

optional onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseOverCapture

onMouseUp? ​

optional onMouseUp?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseUp

onMouseUpCapture? ​

optional onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onMouseUpCapture

onPointerCancel? ​

optional onPointerCancel?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerCancel

onPointerCancelCapture? ​

optional onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerCancelCapture

onPointerDown? ​

optional onPointerDown?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerDown

onPointerDownCapture? ​

optional onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerDownCapture

onPointerEnter? ​

optional onPointerEnter?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerEnter

onPointerLeave? ​

optional onPointerLeave?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerLeave

onPointerMove? ​

optional onPointerMove?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerMove

onPointerMoveCapture? ​

optional onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerMoveCapture

onPointerOut? ​

optional onPointerOut?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerOut

onPointerOutCapture? ​

optional onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerOutCapture

onPointerOver? ​

optional onPointerOver?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerOver

onPointerOverCapture? ​

optional onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerOverCapture

onPointerUp? ​

optional onPointerUp?: PointerEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onPointerUp

onPointerUpCapture? ​

optional onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

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 ​

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

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

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

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

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

TagRootProps.onPressUp

onScroll? ​

optional onScroll?: UIEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onScroll

onScrollCapture? ​

optional onScrollCapture?: UIEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onScrollCapture

onTouchCancel? ​

optional onTouchCancel?: TouchEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTouchCancel

onTouchCancelCapture? ​

optional onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTouchCancelCapture

onTouchEnd? ​

optional onTouchEnd?: TouchEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTouchEnd

onTouchEndCapture? ​

optional onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTouchEndCapture

onTouchMove? ​

optional onTouchMove?: TouchEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTouchMove

onTouchMoveCapture? ​

optional onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTouchMoveCapture

onTouchStart? ​

optional onTouchStart?: TouchEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTouchStart

onTouchStartCapture? ​

optional onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTouchStartCapture

onTransitionCancel? ​

optional onTransitionCancel?: TransitionEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTransitionCancel

onTransitionCancelCapture? ​

optional onTransitionCancelCapture?: TransitionEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTransitionCancelCapture

onTransitionEnd? ​

optional onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTransitionEnd

onTransitionEndCapture? ​

optional onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTransitionEndCapture

onTransitionRun? ​

optional onTransitionRun?: TransitionEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTransitionRun

onTransitionRunCapture? ​

optional onTransitionRunCapture?: TransitionEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTransitionRunCapture

onTransitionStart? ​

optional onTransitionStart?: TransitionEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTransitionStart

onTransitionStartCapture? ​

optional onTransitionStartCapture?: TransitionEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onTransitionStartCapture

onWheel? ​

optional onWheel?: WheelEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onWheel

onWheelCapture? ​

optional onWheelCapture?: WheelEventHandler<HTMLButtonElement>

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 ​

ButtonRootProps.onWheelCapture

preventFocusOnPress? ​

optional preventFocusOnPress?: boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:47

Whether to prevent focus from moving to the button when pressing it.

Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control.

Inherited from ​

ButtonRootProps.preventFocusOnPress

ref? ​

optional ref?: Ref<HTMLButtonElement>

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 ​

ButtonRootProps.ref

render? ​

optional render?: DOMRenderFunction<"button", ButtonRenderProps>

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 ​

ButtonRootProps.render

size? ​

optional size?: "lg" | "md" | "sm"

Inherited from ​

ButtonRootProps.size

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 ​

ButtonRootProps.slot

style? ​

optional style?: StyleOrFunction<ButtonRenderProps>

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 ​

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

BreadcrumbsItemProps.translate

type? ​

optional type?: "button" | "submit" | "reset"

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:39

The behavior of the button when used in an HTML form.

Default ​

ts
'button'

Inherited from ​

ButtonRootProps.type

value? ​

optional value?: string

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/button/useButton.d.ts:70

The value associated with the button's name when it's submitted with the form data.

Inherited from ​

ButtonRootProps.value

variant? ​

optional variant?: "danger" | "primary" | "secondary" | "danger-soft" | "ghost" | "outline" | "tertiary"

Inherited from ​

ButtonRootProps.variant