# NumberField API

> Auto-generated API reference for `NumberField` from @vuetify/v0 (Vuetify0).
> Source of truth: https://0.vuetifyjs.com/api/number-field

## Related

- https://0.vuetifyjs.com/components/forms/number-field
- https://0.vuetifyjs.com/composables/forms/create-number-field
- https://0.vuetifyjs.com/components/forms/slider
- https://0.vuetifyjs.com/components/forms/input

## NumberField.Root

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `id` | `any` | `useId()` | no | Unique identifier (auto-generated if not provided) |
| `label` | `string \| undefined` | — | no | Optional display label (rendered as aria-label on the spinbutton) |
| `ariaLabelledby` | `string \| undefined` | — | no | ID of element that labels this spinbutton |
| `name` | `string \| undefined` | — | no | Form field name |
| `form` | `string \| undefined` | — | no | Associate with form by ID |
| `required` | `boolean \| undefined` | — | no | Whether this field is required |
| `disabled` | `MaybeRefOrGetter<boolean> \| undefined` | `false` | no | Disables this field |
| `readonly` | `MaybeRefOrGetter<boolean> \| undefined` | — | no | Makes this field readonly |
| `min` | `number \| undefined` | — | no | Minimum value |
| `max` | `number \| undefined` | — | no | Maximum value |
| `step` | `number \| undefined` | — | no | Step increment (default: 1) |
| `leap` | `number \| undefined` | — | no | Leap increment for PageUp/PageDown |
| `wrap` | `boolean \| undefined` | — | no | Wrap around at boundaries |
| `locale` | `string \| undefined` | — | no | BCP 47 locale tag (default: 'en-US') |
| `format` | `Intl.NumberFormatOptions \| undefined` | — | no | Intl.NumberFormat options |
| `clamp` | `boolean \| undefined` | — | no | Whether commit() clamps to min/max (default: true) |
| `rules` | `any[] \| undefined` | `[]` | no | Validation rules |
| `validateOn` | `any` | `"blur"` | no | When to trigger validation |
| `error` | `boolean \| undefined` | `false` | no | Manual error state override — forces invalid |
| `errorMessages` | `any` | — | no | Manual error messages — merged with rule-based errors |
| `spinDelay` | `number \| undefined` | `400` | no | Delay in ms before spin-on-hold starts (default: 400) |
| `spinRate` | `number \| undefined` | `60` | no | Interval in ms for repeated spin (default: 60) |
| `wheel` | `boolean \| undefined` | `false` | no | Whether mouse wheel adjusts value (default: false) |
| `namespace` | `string \| undefined` | `"v0:number-field:root"` | no | Namespace for context provision |
| `modelValue` | `number \| null \| undefined` | `null` | no | — |

### Events

| Name | Type | Description |
|---|---|---|
| `update:model-value` | `[value: number \| null]` | — |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `NumberFieldRootSlotProps` | — |

## NumberField.Control

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:number-field:root"` | no | Namespace for connecting to parent NumberField.Root |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `NumberFieldControlSlotProps` | — |

## NumberField.Decrement

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:number-field:root"` | no | Namespace for connecting to parent NumberField.Root |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `NumberFieldDecrementSlotProps` | — |

## NumberField.Description

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `id` | `string \| undefined` | `useId()` | no | Unique identifier (auto-generated if not provided) |
| `namespace` | `string \| undefined` | `"v0:number-field:root"` | no | Namespace for connecting to parent NumberField.Root |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `NumberFieldDescriptionSlotProps` | — |

## NumberField.Error

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `id` | `string \| undefined` | `useId()` | no | Unique identifier (auto-generated if not provided) |
| `namespace` | `string \| undefined` | `"v0:number-field:root"` | no | Namespace for connecting to parent NumberField.Root |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `NumberFieldErrorSlotProps` | — |

## NumberField.Increment

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:number-field:root"` | no | Namespace for connecting to parent NumberField.Root |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `NumberFieldIncrementSlotProps` | — |

## NumberField.Scrub

### Props

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `namespace` | `string \| undefined` | `"v0:number-field:root"` | no | Namespace for connecting to parent NumberField.Root |
| `sensitivity` | `number \| undefined` | `1` | no | Pixels of movement per step (default: 1) |

### Slots

| Name | Type | Description |
|---|---|---|
| `default` | `NumberFieldScrubSlotProps` | — |