# createNumberField API

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

## Related

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

## Functions

### createNumberField

```ts
(options?: NumberFieldOptions) => NumberFieldContext
```

## Options

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `min` | `number \| undefined` | `-Infinity` | no | Minimum value. |
| `max` | `number \| undefined` | `Infinity` | no | Maximum value. |
| `step` | `number \| undefined` | `1` | no | Step increment for Arrow keys. |
| `leap` | `number \| undefined` | `step * 10` | no | Large step for PageUp/PageDown. |
| `wrap` | `boolean \| undefined` | `false` | no | Circular wrapping (max+step → min). |
| `value` | `Ref<number \| null, number \| null> \| undefined` | — | no | Value source — defaults to ref(null). |
| `locale` | `string \| undefined` | `'en-US'` | no | BCP 47 locale tag. |
| `format` | `Intl.NumberFormatOptions \| undefined` | — | no | Intl.NumberFormat options. |
| `clamp` | `boolean \| undefined` | `true` | no | Whether commit() clamps to min/max. |
| `disabled` | `MaybeRefOrGetter<boolean> \| undefined` | — | no | Disabled state. |
| `readonly` | `MaybeRefOrGetter<boolean> \| undefined` | — | no | Readonly state. |
| `id` | `import("/home/runner/work/0/0/packages/0/src/types/index").ID \| undefined` | — | no | Unique identifier. |
| `label` | `string \| undefined` | — | no | Display label. |
| `name` | `string \| undefined` | — | no | Form field name. |
| `rules` | `(string \| import("/home/runner/work/0/0/packages/0/src/composables/createForm/index").FormValidationRule \| import("/home/runner/work/0/0/packages/0/src/composables/useRules/index").StandardSchemaV1)[] \| undefined` | — | no | Validation rules. |
| `error` | `MaybeRefOrGetter<boolean> \| undefined` | — | no | Manual error state override — forces invalid. |
| `errorMessages` | `MaybeRefOrGetter<import("/home/runner/work/0/0/packages/0/src/types/index").MaybeArray<string> \| undefined>` | — | no | Manual error messages — merged with rule-based errors. |

## Methods

| Name | Type | Description |
|---|---|---|
| `increment` | `(multiplier?: number) => void` | Increment value by step * multiplier. |
| `decrement` | `(multiplier?: number) => void` | Decrement value by step * multiplier. |
| `floor` | `() => void` | Set value to min. |
| `ceil` | `() => void` | Set value to max. |
| `formatValue` | `(value: number) => string` | Format a number using Intl.NumberFormat. |
| `parse` | `(text: string) => number \| null` | Parse locale-formatted text to a number or null. |
| `commit` | `(next?: number \| null) => void` | Snap and optionally clamp the current value. Pass `next` to avoid reading the stale model on the same tick as a write. |

## Properties

| Name | Type | Description |
|---|---|---|
| `value` | `Ref<number \| null, number \| null>` | The numeric value (null when empty). |
| `display` | `Readonly<Ref<string, string>>` | Formatted display string (empty for null). |
| `canIncrement` | `Readonly<Ref<boolean, boolean>>` | Whether the value can be incremented. |
| `canDecrement` | `Readonly<Ref<boolean, boolean>>` | Whether the value can be decremented. |
| `numeric` | `NumericContext` | The underlying numeric context. |
| `input` | `InputContext<number \| null>` | The underlying input context. |