INumberFieldProps
interface
Component Props
Props for <OrigamNumberField> — a numeric input with increment/decrement controls, precision formatting, min/max clamping, and hold-repeat support. Extends the full field and input surface plus variant styling.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- autofocusboolean
- Automatically focus the input on mount.
- placeholderstring
- Placeholder text shown when the input is empty.
- persistentPlaceholderboolean
- Keep the placeholder visible even when the field has a value.
- rolestring
- Custom ARIA role for the input element.
- modelModifiersstring | boolean
- v-model modifiers passed through (e.g. lazy, number).
- insetboolean
- Moves the increment/decrement controls inside the input field.
- hideInputboolean
- Hides the numeric input, leaving only the increment/decrement buttons visible (e.g. a stepper-only UI).
- modelValuenumber | null
- Bound numeric value. Supports v-model. null represents an empty/unset state.
- minnumber
- Minimum allowed value. Decrement is disabled when modelValue <= min.
- maxnumber
- Maximum allowed value. Increment is disabled when modelValue >= max.
- stepnumber
- Amount to increment or decrement on each control press.
- precisionnumber
- Number of decimal places to display. Applied via toFixed() on the rendered value.
- incrementIconTIcon
- Custom icon for the increment button.
- decrementIconTIcon
- Custom icon for the decrement button.
- holdDelaynumber
- Milliseconds before hold-repeat kicks in when the control button is held down.
- holdRepeatnumber
- Milliseconds between repeated increment/decrement events while the button is held.
- splitboolean
- Places the increment and decrement buttons on opposite sides of the input (left/right).
- hideControlsboolean
- Hides the increment/decrement control buttons entirely, leaving a plain numeric input.
- compactboolean
- Reduces the field height for dense UIs.
- decrementAriaLabelstring
- incrementAriaLabelstring
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Quantity stepper with min/max and hold-repeat