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

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

autofocus
boolean
Automatically focus the input on mount.
placeholder
string
Placeholder text shown when the input is empty.
persistentPlaceholder
boolean
Keep the placeholder visible even when the field has a value.
role
string
Custom ARIA role for the input element.
modelModifiers
string | boolean
v-model modifiers passed through (e.g. lazy, number).
inset
boolean
Moves the increment/decrement controls inside the input field.
hideInput
boolean
Hides the numeric input, leaving only the increment/decrement buttons visible (e.g. a stepper-only UI).
modelValue
number | null
Bound numeric value. Supports v-model. null represents an empty/unset state.
min
number
Minimum allowed value. Decrement is disabled when modelValue <= min.
max
number
Maximum allowed value. Increment is disabled when modelValue >= max.
step
number
Amount to increment or decrement on each control press.
precision
number
Number of decimal places to display. Applied via toFixed() on the rendered value.
incrementIcon
TIcon
Custom icon for the increment button.
decrementIcon
TIcon
Custom icon for the decrement button.
holdDelay
number
Milliseconds before hold-repeat kicks in when the control button is held down.
holdRepeat
number
Milliseconds between repeated increment/decrement events while the button is held.
split
boolean
Places the increment and decrement buttons on opposite sides of the input (left/right).
hideControls
boolean
Hides the increment/decrement control buttons entirely, leaving a plain numeric input.
compact
boolean
Reduces the field height for dense UIs.
decrementAriaLabel
string
incrementAriaLabel
string

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Quantity stepper with min/max and hold-repeat

vue