createNumberField API

When to write typed input into value. 'change' (default) only writes on commit() (blur/Enter). 'input' also writes on every keystroke via write(), without clamping or snapping — clamping mid-type would jump a value like 1 to min before the user finishes typing 15. Clamping/snapping still happens on the next commit().

Default: 'change'

disabled

MaybeRefOrGetter<boolean> | undefined

Disabled state.

readonly

MaybeRefOrGetter<boolean> | undefined

Readonly state.

id

import("/home/runner/work/0/0/packages/0/src/types/index").ID | undefined

Unique identifier.

label

string | undefined

Display label.

name

string | undefined

Form field name.

formNamespace

string | undefined

Form injection key. Must match the parent Form's namespace.

Default: 'v0:form'

required

boolean | undefined

Whether required. When true, a presence rule is registered so Form submit fails on empty values even with novalidate.

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

Validation rules.

error

MaybeRefOrGetter<boolean> | undefined

Manual error state override — forces invalid.

errorMessages

MaybeRefOrGetter<import("/home/runner/work/0/0/packages/0/src/types/index").MaybeArray<string> | undefined>

Manual error messages — merged with rule-based errors.

Properties

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.

commitOn

"input" | "change"

When typed input is written into value — see {@link NumberFieldOptions.commitOn}.

Methods

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.

write

(text: string) => void

Parse text and write it straight into value, without clamping or snapping. Used by commitOn: 'input' consumers to get per-keystroke updates without the min/max jump commit() would cause mid-type.