Skip to main content

Number Input

Rocket 2.0

The Number Input component is a field for entering a number, such as a quantity, a price or a percentage. The user can type a value or change it with the step buttons and arrow keys.

Properties​

Property
Description
Expected Value
LabelText shown above the field.Text. Default: Quantity
Help textHint text shown under the field.Text
PlaceholderText shown in the field when it is empty.Text. Default: 0
Default valueNumber in the field when the app loads.Number. Default: 1
Decimal placesNumber of digits kept after the decimal point. Values are rounded to this many places.Number. Default: 2
StepAmount added or subtracted by each click on a step button or press of the Up and Down arrow keys.Number. Default: 1
Step buttonsWhere the step buttons appear. Split -/+ puts minus and plus buttons on either side, Stacked puts up and down arrows on the right, and None hides them.Split -/+, Stacked, None. Default: Split -/+
Prefix (inside the box)Text shown inside the field before the number, such as $.Text
Suffix (inside the box)Text shown inside the field after the number, such as kg or %.Text
Thousands separatorsGroups the digits of large numbers with separators, such as 12,500, while the field isn't being edited.On or off. Default: On
Show clear buttonShows a button in the field that clears the number.On or off. Default: Off
Min valueLowest allowed number. The step buttons stop here and a smaller number shows an error. Leave empty for no limit.Text
Max valueHighest allowed number. The step buttons stop here and a larger number shows an error. Leave empty for no limit.Text

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.
On enter pressedTriggers 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 textSets the field to the given Value.components.numberinput1.setText("")
ClearEmpties the field.components.numberinput1.clear()
Set focusMoves keyboard focus to the field.components.numberinput1.setFocus()
Set blurRemoves focus from the field.components.numberinput1.setBlur()
Set visibilityShows the component when true, hides it when false.components.numberinput1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.numberinput1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.numberinput1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field.{{components.numberinput1.label}}
descriptionHint text shown under the field.{{components.numberinput1.description}}
placeholderText shown in the field when it is empty.{{components.numberinput1.placeholder}}
defaultValueNumber in the field when the app loads.{{components.numberinput1.defaultValue}}
decimalPlacesNumber of digits kept after the decimal point. Values are rounded to this many places.{{components.numberinput1.decimalPlaces}}
stepAmount added or subtracted by each click on a step button or press of the Up and Down arrow keys.{{components.numberinput1.step}}
stepperWhere the step buttons appear. Split -/+ puts minus and plus buttons on either side, Stacked puts up and down arrows on the right, and None hides them.{{components.numberinput1.stepper}}
prefixText shown inside the field before the number, such as $.{{components.numberinput1.prefix}}
suffixText shown inside the field after the number, such as kg or %.{{components.numberinput1.suffix}}
thousandSeparatorGroups the digits of large numbers with separators, such as 12,500, while the field isn't being edited.{{components.numberinput1.thousandSeparator}}
showClearBtnShows a button in the field that clears the number.{{components.numberinput1.showClearBtn}}
minValueLowest allowed number. The step buttons stop here and a smaller number shows an error. Leave empty for no limit.{{components.numberinput1.minValue}}
maxValueHighest allowed number. The step buttons stop here and a larger number shows an error. Leave empty for no limit.{{components.numberinput1.maxValue}}
valueThe number in the field, or null when it is empty.{{components.numberinput1.value}}
isVisibleWhether the component is visible.{{components.numberinput1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.numberinput1.isLoading}}
isDisabledWhether the component is disabled.{{components.numberinput1.isDisabled}}

Styles​

Style
Default
Label colorTheme: Primary text
Help text colorTheme: Placeholder text
Field backgroundTheme: Surface 1
Field text colorTheme: Primary text
Placeholder colorTheme: Placeholder text
Field border colorTheme: Default border
Accent (focus ring, selection)Theme: Brand primary
Error color (message and border)Theme: Error
Field radius—
Step button backgroundtransparent
Step button icon colorTheme: Placeholder text
Step button hover backgroundTheme: Surface 3
Prefix and suffix colorTheme: Placeholder text
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.