Skip to main content

Input Number

Ant Design

The Input Number component is a field for entering a number, such as a quantity or a price, with up and down buttons to change it by a step.

Properties​

Property
Description
Expected Value
LabelText shown above the field, or beside it when Layout is horizontal.Text. Default: Quantity
ExtraHelp text shown under the field. A validation message replaces it while the value is invalid.Text
TooltipText shown when the user hovers over an info icon after the label.Text
Layoutvertical puts the label above the field; horizontal puts it at the left.vertical, horizontal. Default: vertical
ValueNumber in the field when the app loads. Leave it empty for no number. Reset field returns to this value.Number
PlaceholderHint shown in the field while it is empty.Text. Default: 0
MinLowest number allowed. A smaller value shows a validation error.Number
MaxHighest number allowed. A larger value shows a validation error.Number
StepHow much the up and down buttons and arrow keys change the number.Number. Default: 1
PrecisionNumber of decimal places. The value is rounded to it. Leave it empty to keep what the user types.Number
PrefixText shown inside the field before the number, such as $.Text
Addon beforeText shown in a gray box attached to the start of the field.Text
Addon afterText shown in a gray box attached to the end of the field, such as a unit like kg.Text
ControlsShows the up and down buttons inside the field.On or off. Default: On
VariantStyle of the field box. outlined has a border, filled has a gray fill, borderless has neither, and underlined has only a bottom line.outlined, filled, borderless, underlined. Default: outlined
SizeHeight and text size of the field.small, middle, large. Default: middle

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the number changes, by typing, the step buttons or an action.
On stepTriggers when the user changes the number with the up and down buttons or arrow keys.
On press enterTriggers when the user presses Enter in the field.
On focusTriggers when the field gets focus.
On blurTriggers when the field loses focus.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set field valueChanges the number to the given Value and fires On change.components.inputnumber1.setFieldValue("")
Reset fieldReturns the number to the Value property's value.components.inputnumber1.resetFields()
FocusMoves keyboard focus to the field.components.inputnumber1.focus()
BlurRemoves keyboard focus from the field.components.inputnumber1.blur()
Set visibilityShows the component when true, hides it when false.components.inputnumber1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.inputnumber1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.inputnumber1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field, or beside it when Layout is horizontal.{{components.inputnumber1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is invalid.{{components.inputnumber1.extra}}
tooltipText shown when the user hovers over an info icon after the label.{{components.inputnumber1.tooltip}}
layoutvertical puts the label above the field; horizontal puts it at the left.{{components.inputnumber1.layout}}
valueNumber in the field when the app loads. Leave it empty for no number. Reset field returns to this value.{{components.inputnumber1.value}}
placeholderHint shown in the field while it is empty.{{components.inputnumber1.placeholder}}
minLowest number allowed. A smaller value shows a validation error.{{components.inputnumber1.min}}
maxHighest number allowed. A larger value shows a validation error.{{components.inputnumber1.max}}
stepHow much the up and down buttons and arrow keys change the number.{{components.inputnumber1.step}}
precisionNumber of decimal places. The value is rounded to it. Leave it empty to keep what the user types.{{components.inputnumber1.precision}}
prefixText shown inside the field before the number, such as $.{{components.inputnumber1.prefix}}
addonBeforeText shown in a gray box attached to the start of the field.{{components.inputnumber1.addonBefore}}
addonAfterText shown in a gray box attached to the end of the field, such as a unit like kg.{{components.inputnumber1.addonAfter}}
controlsShows the up and down buttons inside the field.{{components.inputnumber1.controls}}
variantStyle of the field box. outlined has a border, filled has a gray fill, borderless has neither, and underlined has only a bottom line.{{components.inputnumber1.variant}}
sizeHeight and text size of the field.{{components.inputnumber1.size}}
isVisibleWhether the component is visible.{{components.inputnumber1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.inputnumber1.isLoading}}
isDisabledWhether the component is disabled.{{components.inputnumber1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.