` element.
**Root Props:**
| Name | Type | Default | Description |
| ---------------- | ------------------------------------------------------------------------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | string | - | Identifies the field when a form is submitted. |
| defaultValue | number | - | The uncontrolled value of the field when it's initially rendered. To render a controlled number field, use the `value` prop instead. |
| value | number \| null | - | The raw numeric value of the field. |
| onValueChange | ((value: number \| null, eventDetails: NumberField.Root.ChangeEventDetails) => void) | - | Callback fired when the number value changes. The `eventDetails.reason` indicates what triggered the change: `'input-change'` for parseable typing or programmatic text updates`'input-clear'` when the field becomes empty`'input-blur'` when formatting (and clamping, if enabled) occurs on blur`'input-paste'` for paste interactions`'keyboard'` for arrow-key/Home/End stepping (typing digits uses `'input-change'`/`'input-clear'`)`'increment-press'` / `'decrement-press'` for button presses on the increment and decrement controls`'wheel'` for wheel-based scrubbing`'scrub'` for scrub area drags |
| onValueCommitted | ((value: number \| null, eventDetails: NumberField.Root.CommitEventDetails) => void) | - | Callback function that is fired when the value is committed.
It runs later than `onValueChange`, when: The input is blurred after typing a value.The pointer is released after scrubbing or pressing the increment/decrement buttons. It runs simultaneously with `onValueChange` when interacting with the keyboard or the
mouse wheel. **Warning**: This is a generic event not a change event. |
| allowOutOfRange | boolean | `false` | When true, direct text entry may be outside the `min`/`max` range without clamping,
so native range underflow/overflow validation can occur.
Step-based interactions (keyboard arrows, buttons, wheel, scrub) still clamp. |
| form | string | - | Identifies the form that owns the hidden input.
Useful when the number field is rendered outside the form. |
| locale | Intl.LocalesArgument | - | The locale of the input element.
Defaults to the user's runtime locale. |
| snapOnStep | boolean | `false` | Whether the value should snap to the nearest step when incrementing or decrementing. |
| step | number \| 'any' | `1` | Amount to increment and decrement with the buttons and arrow keys, or to scrub with pointer movement in the scrub area.
To always enable step validation on form submission, specify the `min` prop explicitly in conjunction with this prop.
Specify `step="any"` to always disable step validation; interactive stepping then uses a base amount of `1`, while the alt and shift keys still step by `smallStep` and `largeStep`. |
| smallStep | number | `0.1` | The small step value of the input element when incrementing while the alt key is held.
Snaps to multiples of this value when `snapOnStep` is enabled. |
| largeStep | number | `10` | The large step value of the input element when incrementing while the shift key is held.
Snaps to multiples of this value when `snapOnStep` is enabled. |
| min | number | - | The minimum value of the input element. |
| max | number | - | The maximum value of the input element. |
| allowWheelScrub | boolean | `false` | Whether to allow the user to scrub the input value with the mouse wheel while focused and
hovering over the input. |
| format | Intl.NumberFormatOptions | - | Options to format the input value. |
| disabled | boolean | `false` | Whether the component should ignore user interaction. |
| readOnly | boolean | `false` | Whether the user should be unable to change the field value. |
| required | boolean | `false` | Whether the user must enter a value before submitting a form. |
| inputRef | Ref
| - | A ref to access the hidden input element. |
| id | string | - | The id of the input element. |
| class | JSX.ClassValue \| ((state) => JSX.ClassValue) | - | CSS class applied to the element, or a function that
returns a class based on the component's state. |
| style | JSX.CSSProperties \| string \| ((state) => JSX.CSSProperties \| string \| undefined) | - | Style applied to the element, or a function that
returns a style object based on the component's state. |
| render | keyof JSX.IntrinsicElements \| Component \| ((props, state) => JSX.Element) | - | Replace the default element with a tag name, component, or render function. |
**Root Data Attributes:**
| Name | Type | Default | Description |
| -------------- | ---- | ------- | ---------------------------------------------------------------------------------- |
| data-disabled | - | - | Present when the number field is disabled. |
| data-readonly | - | - | Present when the number field is readonly. |
| data-required | - | - | Present when the number field is required. |
| data-valid | - | - | Present when the number field is in a valid state (when wrapped in Field.Root). |
| data-invalid | - | - | Present when the number field is in an invalid state (when wrapped in Field.Root). |
| data-dirty | - | - | Present when the number field's value has changed (when wrapped in Field.Root). |
| data-touched | - | - | Present when the number field has been touched (when wrapped in Field.Root). |
| data-filled | - | - | Present when the number field is filled (when wrapped in Field.Root). |
| data-focused | - | - | Present when the number field is focused (when wrapped in Field.Root). |
| data-scrubbing | - | - | Present while scrubbing. |
#### Root.State
```typescript
type NumberFieldRootState = {
/** The raw numeric value of the field. */
value: number | null;
/** The formatted string value presented in the input element. */
inputValue: string;
/** Whether the user must enter a value before submitting a form. */
required: boolean;
/** Whether the component should ignore user interaction. */
disabled: boolean;
/** Whether the user should be unable to change the field value. */
readOnly: boolean;
/** Whether the user is currently scrubbing the field. */
scrubbing: boolean;
/** Whether the field has been touched. */
touched: boolean;
/** Whether the field value has changed from its initial value. */
dirty: boolean;
/** Whether the field is valid. */
valid: boolean | null;
/** Whether the field has a value. */
filled: boolean;
/** Whether the field is focused. */
focused: boolean;
};
```
#### Root.ChangeEventReason
```typescript
type NumberFieldRootChangeEventReason =
| 'input-change'
| 'input-clear'
| 'input-blur'
| 'input-paste'
| 'keyboard'
| 'increment-press'
| 'decrement-press'
| 'wheel'
| 'scrub'
| 'none';
```
#### Root.ChangeEventDetails
```typescript
type NumberFieldRootChangeEventDetails = (
| { reason: 'input-change'; event: InputEvent | Event }
| { reason: 'input-clear'; event: InputEvent | Event | FocusEvent }
| { reason: 'input-blur'; event: FocusEvent }
| { reason: 'input-paste'; event: ClipboardEvent }
| { reason: 'keyboard'; event: KeyboardEvent }
| { reason: 'increment-press'; event: PointerEvent | MouseEvent | TouchEvent }
| { reason: 'decrement-press'; event: PointerEvent | MouseEvent | TouchEvent }
| { reason: 'wheel'; event: WheelEvent }
| { reason: 'scrub'; event: PointerEvent }
| { reason: 'none'; event: Event }
) & {
/** Cancels Base UI from handling the event. */
cancel: () => void;
/** Allows the event to propagate in cases where Base UI will stop the propagation. */
allowPropagation: () => void;
/** Indicates whether the event has been canceled. */
isCanceled: boolean;
/** Indicates whether the event is allowed to propagate. */
isPropagationAllowed: boolean;
/** The element that triggered the event, if applicable. */
trigger: Element | undefined;
direction?: Direction;
};
```
#### Root.CommitEventReason
```typescript
type NumberFieldRootCommitEventReason =
| 'input-blur'
| 'input-clear'
| 'keyboard'
| 'increment-press'
| 'decrement-press'
| 'wheel'
| 'scrub'
| 'none';
```
#### Root.CommitEventDetails
```typescript
type NumberFieldRootCommitEventDetails =
| { reason: 'input-clear'; event: InputEvent | Event | FocusEvent }
| { reason: 'input-blur'; event: FocusEvent }
| { reason: 'keyboard'; event: KeyboardEvent }
| { reason: 'increment-press'; event: PointerEvent | MouseEvent | TouchEvent }
| { reason: 'decrement-press'; event: PointerEvent | MouseEvent | TouchEvent }
| { reason: 'wheel'; event: WheelEvent }
| { reason: 'scrub'; event: PointerEvent }
| { reason: 'none'; event: Event };
```
### Input
The native input control in the number field.
Renders an `` element.
**Input Props:**
| Name | Type | Default | Description |
| -------------------- | ------------------------------------------------------------------------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| aria-roledescription | string | `'Number field'` | A user-friendly description of the input's role for assistive tech. This is a role
description, not an accessible name — use `Field.Label` or `aria-label` to name the control. |
| class | JSX.ClassValue \| ((state) => JSX.ClassValue) | - | CSS class applied to the element, or a function that
returns a class based on the component's state. |
| style | JSX.CSSProperties \| string \| ((state) => JSX.CSSProperties \| string \| undefined) | - | Style applied to the element, or a function that
returns a style object based on the component's state. |
| render | keyof JSX.IntrinsicElements \| Component \| ((props, state) => JSX.Element) | - | Replace the default element with a tag name, component, or render function. |
**Input Data Attributes:**
| Name | Type | Default | Description |
| -------------- | ---- | ------- | ---------------------------------------------------------------------------------- |
| data-disabled | - | - | Present when the number field is disabled. |
| data-readonly | - | - | Present when the number field is readonly. |
| data-required | - | - | Present when the number field is required. |
| data-valid | - | - | Present when the number field is in a valid state (when wrapped in Field.Root). |
| data-invalid | - | - | Present when the number field is in an invalid state (when wrapped in Field.Root). |
| data-dirty | - | - | Present when the number field's value has changed (when wrapped in Field.Root). |
| data-touched | - | - | Present when the number field has been touched (when wrapped in Field.Root). |
| data-filled | - | - | Present when the number field is filled (when wrapped in Field.Root). |
| data-focused | - | - | Present when the number field is focused (when wrapped in Field.Root). |
| data-scrubbing | - | - | Present while scrubbing. |
#### Input.State
```typescript
type NumberFieldInputState = {
/** The raw numeric value of the field. */
value: number | null;
/** The formatted string value presented in the input element. */
inputValue: string;
/** Whether the user must enter a value before submitting a form. */
required: boolean;
/** Whether the component should ignore user interaction. */
disabled: boolean;
/** Whether the user should be unable to change the field value. */
readOnly: boolean;
/** Whether the user is currently scrubbing the field. */
scrubbing: boolean;
/** Whether the field has been touched. */
touched: boolean;
/** Whether the field value has changed from its initial value. */
dirty: boolean;
/** Whether the field is valid. */
valid: boolean | null;
/** Whether the field has a value. */
filled: boolean;
/** Whether the field is focused. */
focused: boolean;
};
```
### Group
Groups the input with the increment and decrement buttons.
Renders a `` element.
**Group Props:**
| Name | Type | Default | Description |
| ------ | ------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------ |
| class | JSX.ClassValue \| ((state) => JSX.ClassValue) | - | CSS class applied to the element, or a function that
returns a class based on the component's state. |
| style | JSX.CSSProperties \| string \| ((state) => JSX.CSSProperties \| string \| undefined) | - | Style applied to the element, or a function that
returns a style object based on the component's state. |
| render | keyof JSX.IntrinsicElements \| Component \| ((props, state) => JSX.Element) | - | Replace the default element with a tag name, component, or render function. |
**Group Data Attributes:**
| Name | Type | Default | Description |
| -------------- | ---- | ------- | ---------------------------------------------------------------------------------- |
| data-disabled | - | - | Present when the number field is disabled. |
| data-readonly | - | - | Present when the number field is readonly. |
| data-required | - | - | Present when the number field is required. |
| data-valid | - | - | Present when the number field is in a valid state (when wrapped in Field.Root). |
| data-invalid | - | - | Present when the number field is in an invalid state (when wrapped in Field.Root). |
| data-dirty | - | - | Present when the number field's value has changed (when wrapped in Field.Root). |
| data-touched | - | - | Present when the number field has been touched (when wrapped in Field.Root). |
| data-filled | - | - | Present when the number field is filled (when wrapped in Field.Root). |
| data-focused | - | - | Present when the number field is focused (when wrapped in Field.Root). |
| data-scrubbing | - | - | Present while scrubbing. |
#### Group.State
```typescript
type NumberFieldGroupState = {
/** The raw numeric value of the field. */
value: number | null;
/** The formatted string value presented in the input element. */
inputValue: string;
/** Whether the user must enter a value before submitting a form. */
required: boolean;
/** Whether the component should ignore user interaction. */
disabled: boolean;
/** Whether the user should be unable to change the field value. */
readOnly: boolean;
/** Whether the user is currently scrubbing the field. */
scrubbing: boolean;
/** Whether the field has been touched. */
touched: boolean;
/** Whether the field value has changed from its initial value. */
dirty: boolean;
/** Whether the field is valid. */
valid: boolean | null;
/** Whether the field has a value. */
filled: boolean;
/** Whether the field is focused. */
focused: boolean;
};
```
### ScrubArea
An interactive area where the user can click and drag to change the field value.
Renders a `
` element.
**ScrubArea Props:**
| Name | Type | Default | Description |
| ---------------- | ------------------------------------------------------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| direction | 'horizontal' \| 'vertical' | `'horizontal'` | Cursor movement direction in the scrub area. |
| pixelSensitivity | number | `2` | Determines how many pixels the cursor must move before the value changes.
A higher value will make scrubbing less sensitive. |
| teleportDistance | number | - | If specified, determines the distance that the cursor may move from the center
of the scrub area before it will loop back around. |
| class | JSX.ClassValue \| ((state) => JSX.ClassValue) | - | CSS class applied to the element, or a function that
returns a class based on the component's state. |
| style | JSX.CSSProperties \| string \| ((state) => JSX.CSSProperties \| string \| undefined) | - | Style applied to the element, or a function that
returns a style object based on the component's state. |
| render | keyof JSX.IntrinsicElements \| Component \| ((props, state) => JSX.Element) | - | Replace the default element with a tag name, component, or render function. |
**ScrubArea Data Attributes:**
| Name | Type | Default | Description |
| -------------- | ---- | ------- | ---------------------------------------------------------------------------------- |
| data-disabled | - | - | Present when the number field is disabled. |
| data-readonly | - | - | Present when the number field is readonly. |
| data-required | - | - | Present when the number field is required. |
| data-valid | - | - | Present when the number field is in a valid state (when wrapped in Field.Root). |
| data-invalid | - | - | Present when the number field is in an invalid state (when wrapped in Field.Root). |
| data-dirty | - | - | Present when the number field's value has changed (when wrapped in Field.Root). |
| data-touched | - | - | Present when the number field has been touched (when wrapped in Field.Root). |
| data-filled | - | - | Present when the number field is filled (when wrapped in Field.Root). |
| data-focused | - | - | Present when the number field is focused (when wrapped in Field.Root). |
| data-scrubbing | - | - | Present while scrubbing. |
#### ScrubArea.State
```typescript
type NumberFieldScrubAreaState = {
/** The raw numeric value of the field. */
value: number | null;
/** The formatted string value presented in the input element. */
inputValue: string;
/** Whether the user must enter a value before submitting a form. */
required: boolean;
/** Whether the component should ignore user interaction. */
disabled: boolean;
/** Whether the user should be unable to change the field value. */
readOnly: boolean;
/** Whether the user is currently scrubbing the field. */
scrubbing: boolean;
/** Whether the field has been touched. */
touched: boolean;
/** Whether the field value has changed from its initial value. */
dirty: boolean;
/** Whether the field is valid. */
valid: boolean | null;
/** Whether the field has a value. */
filled: boolean;
/** Whether the field is focused. */
focused: boolean;
};
```
### ScrubAreaCursor
A custom element to display instead of the native cursor while using the scrub area.
Renders a `` element.
This component uses the [Pointer Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API), which may prompt the browser to display a related notification. It is disabled
in Safari to avoid a layout shift that this notification causes there.
**ScrubAreaCursor Props:**
| Name | Type | Default | Description |
| ------ | ------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------ |
| class | JSX.ClassValue \| ((state) => JSX.ClassValue) | - | CSS class applied to the element, or a function that
returns a class based on the component's state. |
| style | JSX.CSSProperties \| string \| ((state) => JSX.CSSProperties \| string \| undefined) | - | Style applied to the element, or a function that
returns a style object based on the component's state. |
| render | keyof JSX.IntrinsicElements \| Component \| ((props, state) => JSX.Element) | - | Replace the default element with a tag name, component, or render function. |
**ScrubAreaCursor Data Attributes:**
| Name | Type | Default | Description |
| -------------- | ---- | ------- | ---------------------------------------------------------------------------------- |
| data-disabled | - | - | Present when the number field is disabled. |
| data-readonly | - | - | Present when the number field is readonly. |
| data-required | - | - | Present when the number field is required. |
| data-valid | - | - | Present when the number field is in a valid state (when wrapped in Field.Root). |
| data-invalid | - | - | Present when the number field is in an invalid state (when wrapped in Field.Root). |
| data-dirty | - | - | Present when the number field's value has changed (when wrapped in Field.Root). |
| data-touched | - | - | Present when the number field has been touched (when wrapped in Field.Root). |
| data-filled | - | - | Present when the number field is filled (when wrapped in Field.Root). |
| data-focused | - | - | Present when the number field is focused (when wrapped in Field.Root). |
| data-scrubbing | - | - | Present while scrubbing. |
#### ScrubAreaCursor.State
```typescript
type NumberFieldScrubAreaCursorState = {
/** The raw numeric value of the field. */
value: number | null;
/** The formatted string value presented in the input element. */
inputValue: string;
/** Whether the user must enter a value before submitting a form. */
required: boolean;
/** Whether the component should ignore user interaction. */
disabled: boolean;
/** Whether the user should be unable to change the field value. */
readOnly: boolean;
/** Whether the user is currently scrubbing the field. */
scrubbing: boolean;
/** Whether the field has been touched. */
touched: boolean;
/** Whether the field value has changed from its initial value. */
dirty: boolean;
/** Whether the field is valid. */
valid: boolean | null;
/** Whether the field has a value. */
filled: boolean;
/** Whether the field is focused. */
focused: boolean;
};
```
### Decrement
A stepper button that decreases the field value when clicked.
Renders a `