createNumberField API
API reference for the createNumberField composable.
(options?: NumberFieldOptions) => NumberFieldContextnumber | undefinedMinimum value.
Default: -Infinity
number | undefinedMaximum value.
Default: Infinity
number | undefinedStep increment for Arrow keys.
Default: 1
number | undefinedLarge step for PageUp/PageDown.
Default: step * 10
boolean | undefinedCircular wrapping (max+step → min).
Default: false
Ref<number | null, number | null> | undefinedValue source — defaults to ref(null).
string | undefinedBCP 47 locale tag.
Default: 'en-US'
Intl.NumberFormatOptions | undefinedIntl.NumberFormat options.
boolean | undefinedWhether commit() clamps to min/max.
Default: true
MaybeRefOrGetter<boolean> | undefinedDisabled state.
MaybeRefOrGetter<boolean> | undefinedReadonly state.
import("/home/runner/work/0/0/packages/0/src/types/index").ID | undefinedUnique identifier.
string | undefinedDisplay label.
string | undefinedForm field name.
(string | import("/home/runner/work/0/0/packages/0/src/composables/index").FormValidationRule | import("/home/runner/work/0/0/packages/0/src/composables/index").StandardSchemaV1)[] | undefinedValidation rules.
MaybeRefOrGetter<boolean> | undefinedManual error state override — forces invalid.
MaybeRefOrGetter<import("/home/runner/work/0/0/packages/0/src/types/index").MaybeArray<string> | undefined>Manual error messages — merged with rule-based errors.
Ref<number | null, number | null>The numeric value (null when empty).
Readonly<Ref<string, string>>Formatted display string (empty for null).
Readonly<Ref<boolean, boolean>>Whether the value can be incremented.
Readonly<Ref<boolean, boolean>>Whether the value can be decremented.
NumericContextThe underlying numeric context.
InputContext<number | null>The underlying input context.
(multiplier?: number) => voidIncrement value by step * multiplier.
(multiplier?: number) => voidDecrement value by step * multiplier.
() => voidSet value to min.
() => voidSet value to max.
(value: number) => stringFormat a number using Intl.NumberFormat.
(text: string) => number | nullParse locale-formatted text to a number or null.
() => voidSnap and optionally clamp the current value.
