maia.component-library / NumberFieldRootProps
Interface: NumberFieldRootProps
Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/number-field/number-field.d.ts:7
Extends
ComponentPropsWithRef<typeofNumberFieldPrimitive>.NumberFieldVariants
Properties
aria-describedby?
optionalaria-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?
optionalaria-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?
optionalaria-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?
optionalaria-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?
optionalautoFocus?: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
ComponentPropsWithRef.autoFocus
children?
optionalchildren?:ChildrenOrFunction<NumberFieldRenderProps>
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?
optionalclassName?:ClassNameOrFunction<NumberFieldRenderProps>
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/NumberField.d.ts:43
The CSS className for the element. A function may be provided to compute the class based on component state.
Default
'react-aria-NumberField'Inherited from
ComponentPropsWithRef.className
commitBehavior?
optionalcommitBehavior?:"validate"|"snap"
Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/numberfield/useNumberFieldState.d.ts:17
Controls the behavior of the number field when the user blurs the field after editing. 'snap' will clamp the value to the min/max values, and snap to the nearest step value. 'validate' will not clamp the value, and will validate that the value is within the min/max range and on a valid step.
Default
'snap'Inherited from
ComponentPropsWithRef.commitBehavior
decrementAriaLabel?
optionaldecrementAriaLabel?:string
Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/numberfield/useNumberField.d.ts:10
A custom aria-label for the decrement button. If not provided, the localized string "Decrement" is used.
Inherited from
ComponentPropsWithRef.decrementAriaLabel
defaultValue?
optionaldefaultValue?:number
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:73
The default value (uncontrolled).
Inherited from
ComponentPropsWithRef.defaultValue
dir?
optionaldir?: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
form?
optionalform?: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:160
The <form> element to associate the input with. The value of this attribute must be the id of a <form> in the same document. See MDN.
Inherited from
ComponentPropsWithRef.form
formatOptions?
optionalformatOptions?:NumberFormatOptions
Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/numberfield/useNumberFieldState.d.ts:8
Formatting options for the value displayed in the number field. This also affects what characters are allowed to be typed by the user.
Inherited from
ComponentPropsWithRef.formatOptions
fullWidth?
optionalfullWidth?:boolean
Inherited from
hidden?
optionalhidden?: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?
optionalid?: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
incrementAriaLabel?
optionalincrementAriaLabel?:string
Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/numberfield/useNumberField.d.ts:15
A custom aria-label for the increment button. If not provided, the localized string "Increment" is used.
Inherited from
ComponentPropsWithRef.incrementAriaLabel
inert?
optionalinert?: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
isDisabled?
optionalisDisabled?:boolean
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:64
Whether the input is disabled.
Inherited from
ComponentPropsWithRef.isDisabled
isInvalid?
optionalisInvalid?:boolean
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:25
Whether the input value is invalid.
Inherited from
ComponentPropsWithRef.isInvalid
isReadOnly?
optionalisReadOnly?:boolean
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:66
Whether the input can be selected but not changed by the user.
Inherited from
ComponentPropsWithRef.isReadOnly
isRequired?
optionalisRequired?:boolean
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:23
Whether user input is required on the input before form submission.
Inherited from
ComponentPropsWithRef.isRequired
isWheelDisabled?
optionalisWheelDisabled?:boolean
Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/numberfield/useNumberField.d.ts:19
Enables or disables changing the value with scroll.
Inherited from
ComponentPropsWithRef.isWheelDisabled
key?
optionalkey?: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?
optionallang?: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
maxValue?
optionalmaxValue?:number
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:104
The largest value allowed for the input.
Inherited from
ComponentPropsWithRef.maxValue
minValue?
optionalminValue?:number
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:102
The smallest value allowed for the input.
Inherited from
ComponentPropsWithRef.minValue
name?
optionalname?: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:154
The name of the input element, used when submitting an HTML form. See MDN.
Inherited from
ComponentPropsWithRef.name
onAnimationEnd?
optionalonAnimationEnd?: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?
optionalonAnimationEndCapture?: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?
optionalonAnimationIteration?: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?
optionalonAnimationIterationCapture?: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?
optionalonAnimationStart?: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?
optionalonAnimationStartCapture?: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?
optionalonAuxClick?: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?
optionalonAuxClickCapture?: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
onBeforeInput?
optionalonBeforeInput?:FormEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:141
Handler that is called when the input value is about to be modified. See MDN.
Inherited from
ComponentPropsWithRef.onBeforeInput
onBlur?
optionalonBlur?: (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
onChange?
optionalonChange?: (value) =>void
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:75
Handler that is called when the value changes.
Parameters
value
number
Returns
void
Inherited from
ComponentPropsWithRef.onChange
onClick?
optionalonClick?: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?
optionalonClickCapture?: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
onCompositionEnd?
optionalonCompositionEnd?:CompositionEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:120
Handler that is called when a text composition system completes or cancels the current text composition session. See MDN.
Inherited from
ComponentPropsWithRef.onCompositionEnd
onCompositionStart?
optionalonCompositionStart?:CompositionEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:113
Handler that is called when a text composition system starts a new text composition session. See MDN.
Inherited from
ComponentPropsWithRef.onCompositionStart
onCompositionUpdate?
optionalonCompositionUpdate?:CompositionEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:127
Handler that is called when a new character is received in the current text composition session. See MDN.
Inherited from
ComponentPropsWithRef.onCompositionUpdate
onContextMenu?
optionalonContextMenu?: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?
optionalonContextMenuCapture?: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
onCopy?
optionalonCopy?:ClipboardEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:94
Handler that is called when the user copies text. See MDN.
Inherited from
ComponentPropsWithRef.onCopy
onCut?
optionalonCut?:ClipboardEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:100
Handler that is called when the user cuts text. See MDN.
Inherited from
ComponentPropsWithRef.onCut
onDoubleClick?
optionalonDoubleClick?: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?
optionalonDoubleClickCapture?: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?
optionalonFocus?: (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?
optionalonFocusChange?: (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?
optionalonGotPointerCapture?: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?
optionalonGotPointerCaptureCapture?: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
onInput?
optionalonInput?:FormEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:146
Handler that is called when the input value is modified. See MDN.
Inherited from
ComponentPropsWithRef.onInput
onKeyDown?
optionalonKeyDown?: (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?
optionalonKeyUp?: (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
onLostPointerCapture?
optionalonLostPointerCapture?: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?
optionalonLostPointerCaptureCapture?: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?
optionalonMouseDown?: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?
optionalonMouseDownCapture?: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?
optionalonMouseEnter?: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?
optionalonMouseLeave?: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?
optionalonMouseMove?: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?
optionalonMouseMoveCapture?: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?
optionalonMouseOut?: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?
optionalonMouseOutCapture?: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?
optionalonMouseOver?: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?
optionalonMouseOverCapture?: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?
optionalonMouseUp?: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?
optionalonMouseUpCapture?: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
onPaste?
optionalonPaste?:ClipboardEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:106
Handler that is called when the user pastes text. See MDN.
Inherited from
ComponentPropsWithRef.onPaste
onPointerCancel?
optionalonPointerCancel?: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?
optionalonPointerCancelCapture?: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?
optionalonPointerDown?: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?
optionalonPointerDownCapture?: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?
optionalonPointerEnter?: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?
optionalonPointerLeave?: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?
optionalonPointerMove?: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?
optionalonPointerMoveCapture?: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?
optionalonPointerOut?: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?
optionalonPointerOutCapture?: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?
optionalonPointerOver?: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?
optionalonPointerOverCapture?: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?
optionalonPointerUp?: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?
optionalonPointerUpCapture?: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?
optionalonScroll?: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?
optionalonScrollCapture?: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
onSelect?
optionalonSelect?:ReactEventHandler<HTMLInputElement>
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/dom.d.ts:134
Handler that is called when text in the input is selected. See MDN.
Inherited from
ComponentPropsWithRef.onSelect
onTouchCancel?
optionalonTouchCancel?: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?
optionalonTouchCancelCapture?: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?
optionalonTouchEnd?: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?
optionalonTouchEndCapture?: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?
optionalonTouchMove?: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?
optionalonTouchMoveCapture?: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?
optionalonTouchStart?: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?
optionalonTouchStartCapture?: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?
optionalonTransitionCancel?: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?
optionalonTransitionCancelCapture?: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?
optionalonTransitionEnd?: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?
optionalonTransitionEndCapture?: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?
optionalonTransitionRun?: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?
optionalonTransitionRunCapture?: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?
optionalonTransitionStart?: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?
optionalonTransitionStartCapture?: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?
optionalonWheel?: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?
optionalonWheelCapture?: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
ref?
optionalref?: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
Inherited from
ComponentPropsWithRef.ref
render?
optionalrender?:DOMRenderFunction<"div",NumberFieldRenderProps>
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
slot?
optionalslot?: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
step?
optionalstep?:number
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:106
The amount that the input value changes with each increment or decrement "tick".
Inherited from
ComponentPropsWithRef.step
style?
optionalstyle?:StyleOrFunction<NumberFieldRenderProps>
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?
optionaltranslate?:"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
validate?
optionalvalidate?: (value) =>true|ValidationError|null|undefined
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:42
A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if validationBehavior="native". For realtime validation, use the isInvalid prop instead.
Parameters
value
number
Returns
true | ValidationError | null | undefined
Inherited from
ComponentPropsWithRef.validate
validationBehavior?
optionalvalidationBehavior?:"native"|"aria"
Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:177
Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
Default
'native'Inherited from
ComponentPropsWithRef.validationBehavior
value?
optionalvalue?:number
Defined in: node_modules/.pnpm/@react-types+shared@3.35.0_react@19.2.7/node_modules/@react-types/shared/src/inputs.d.ts:71
The current value (controlled).
Inherited from
ComponentPropsWithRef.value
variant?
optionalvariant?:"primary"|"secondary"