Skip to content

Number Input ui-number-input

Try Demo

Adds a single number input row to your dashboard.

Properties

PropDynamicDescription
GroupDefines which group of the UI Dashboard this widget will render in.
SizeControls the width of the number input field with respect to the parent group. Maximum value is the width of the group.
IconRenders a Material Design icon within the Number Input. There is no need to include the "mdi-" prefix.
Icon PositionIf "Icon" is defined, this property controls which side of the "Label" the icon will render on.
Icon Inner PositionIf "Icon" is defined, this property controls if icon is render inside or outside the number input box.
LabelThe number shown within the number input field.
MinDefines the minimum allowable value for the number input field.
MaxDefines the maximum allowable value for the number input field.
StepSets the increment/decrement step for adjusting the number value in the input field.
SpinnerSets the layout of the spinners either as inline or stacked.
TooltipThe number shown when hovering over the number input field.
PassthroughIf this node receives a msg in Node-RED, should it be passed through to the output as if a new value was inserted to the input?
Clear selection with buttonIf true, a clear icon/button appears on the rigth side to clear the number input.
Send On "Clear Button"Send a msg when the user clear the number input using the clear button, the "Clear Selection" button must be enabled.

Dynamic Properties

Dynamic properties are those that can be overriden at runtime by sending a particular msg to the node.

Where appropriate, the underlying values set within Node-RED will be overriden by the values set in the received messages.

PropPayloadStructuresExample Values
Classmsg.classString
Labelmsg.ui_update.labelString
Clearablemsg.ui_update.clearableBoolean
Iconmsg.ui_update.iconString
Icon Positionmsg.ui_update.iconPositionString
left|right
Icon Inner Positionmsg.ui_update.iconInnerPositionString
inside|outside
Minmsg.ui_update.minNumber
Maxmsg.ui_update.maxNumber
Stepmsg.ui_update.stepNumber
Spinnermsg.ui_update.spinnerString

Controls

msg.ExampleDescription
enabledtrue | falseAllow control over whether or not the number-input is enabled

Example

Example of Number Inputs TypesExample of severall Number Inputs Types rendered in a Dashboard.