modelValue | number | null | null | Current value. An empty field is null. |
label | string | — | Field label, also used as the accessible name. |
description | string | — | Helper text under the label. |
placeholder | string | '' | Placeholder text. |
min | number | null | — | Minimum value. On blur or Enter, a smaller entry commits at this value. While typing, it is marked invalid. |
max | number | null | — | Maximum value. On blur or Enter, a larger entry commits at this value. While typing, it is marked invalid. |
step | number | null | 1 | Amount added or removed on each step. |
hasNumberSteppers | boolean | false | Shows increment and decrement buttons at the end of the input. A button is disabled when its step would not change the value. |
isWheelEnabled | boolean | true | Whether scrolling the wheel over the focused input steps the value. Turn it off where page scrolling should always win. |
isIntegerOnly | boolean | false | Only whole numbers commit. Decimal entries stay in the field while editing and are dropped when the field loses focus. The keyboard also switches to the numeric keypad. |
formatValue | (value: number) => string | — | Formats the value shown while the field is not focused, for example (v) => `${v} items`. Focus shows the raw number so it stays editable, and the formatted text is exposed through aria-valuetext. |
units | string | null | — | Unit shown at the end of the input, such as %. |
hasClear | boolean | false | Shows a clear button when the field has a value. The tooltip only says “Clear”; the accessible name includes the field label. Clearing sets the value to null. An emptied draft commits null on blur only when this is on; otherwise it reverts. |
isDisabled | boolean | false | Disables the field. |
disabledMessage | string | — | Explains why the field is disabled. With isDisabled, the reason shows in a tooltip on hover and keyboard focus, and the input stays focusable through aria-disabled instead of being removed from the tab order. |
isReadOnly | boolean | false | Shows the value at full opacity and still submits it, but blocks edits. Arrow keys, the wheel, and the stepper buttons are all off while read-only. isDisabled wins when both are set. |
isOptional | boolean | false | Marks the field optional. Mutually exclusive with isRequired. |
isRequired | boolean | false | Marks the field required. Mutually exclusive with isOptional. |
isLabelHidden | boolean | false | Keeps the label for screen readers and hides it visually. |
labelTooltip | string | — | Tooltip text behind an info icon at the end of the label. |
labelIcon | Component | — | Icon shown before the label text. The labelIcon slot works too. |
startIcon | Component | — | Icon shown at the start of the input. The icon slot works too. |
size | 'sm' | 'md' | 'lg' | 'md' | Field size. |
width | number | string | — | Width of the whole field, label and status included. Numbers are pixels, strings are used as-is, such as '100%'. |
status | 'default' | 'error' | 'warning' | 'success' | { type, message? } | — | Validation status. An object with message shows that text under the field. |
statusVariant | 'attached' | 'detached' | 'tooltip' | 'attached' | How the status message is placed. 'tooltip' hides the message box and reveals it from the status icon instead. |
htmlName | string | — | Form field name. |
autoComplete | string | — | Native autocomplete attribute. |
hasAutoFocus | boolean | false | Focuses the input after it mounts. |
id | string | — | Id for the input element. Generated when omitted. |
disabled | boolean | false | Same as isDisabled. |
disabledReason | string | — | Same as disabledMessage. |
clearable | boolean | false | Same as hasClear. |
name | string | — | Same as htmlName. |
containerClass | string | object | array | — | Class for the field container. Has no effect, and warns in development, when no Field box renders, including inside InputGroup and a horizontal-labels FormLayout. |
containerStyle | StyleValue | — | Inline style for the field container. |
controlClass | string | object | array | — | Class for the number field box. A class written on the component lands here too, with no warning. |
controlStyle | StyleValue | — | Inline style for the number field box. A style written on the component lands here too. |