Number input - Web Component

The NumberInput component can be used imported from:

Playground

Attention!

The localization format of the input comes from the format settings of the client's operation system.

Parameters

...

Events

This component has events. Check the documentation about how to use the events.

Name	Payload	Description
change	number	Returns the new value of the "value" attribute
enter	void	Triggered when "Enter" in pressed
restarted	void	Emitted on value reset
blur	void	Emitted on blur
validated	boolean	Emitted when the validation status changes

Slots

This component has slots. Check the documentation about how to use the slots.

Name	Tags	Description
default	span
label	span
help-text	span

Parameters use

config

The config parameter is used to set the shape of the input between lined and shaped. Being omitted will render the default line shape.

label

The label parameter is used to set the text label of the component. Make sure you always use it.

Can also use the label slot:

Number input

model

The model parameter is used to set the number for the input. Make sure you use a valid number format.

Attention!

If you hardcode this value, it will not be reactive and the selection won't change. Use a variable instead and, ideally, a closed loop.

name

The name parameter is used to set the name of the component. This is useful when the component is part of a form.

help-text

The help-text parameter is used to provide additional assistance to the user.

icon

The icon parameter is used to set an icon to the input. The icon will be displayed on the right side of the input.

range

The range parameter is used to set the range of the input. It must be an array with two numbers. The first number is the minimum value and the second number is the maximum value.

min

Instead of using range we can use just min. This overrides the range value.

max

Instead of using range we can use just max. This overrides the range value.

step

The step parameter is used to set the step of the input. It must be a number. The default value is 1.

data-list

The data-list parameter is used to set a list of suggestions for the input. The list must be an array of strings.

Or using the default slot with <option> tags:

Units

unit

The unit param has two components with the format <unit>:<?format> where:

• unit: is the unit used.
• format: is the format, where short is the default for can receive narrow or long.

INFO

Use a predefined model to avoid overlapping with the label

locale

The locale param only affects the units localization. Check this documentation

Flags

disabled

The disabled parameter is used to block the interaction with the component. Not to be confused with readonly.

readonly

The readonly parameter is used to set the input in a read-only state. It's commonly used to display information.

required

The required parameter is used to set the component as required.

The default text adapts to the localization:

invalid

The invalid parameter is used to force the component to be invalid.

The default text adapts to the localization:

align-right

The align-right parameter aligns the input text to the right:

It can de combined with icon:

Attention!

Do not use in combination with unit without using the --z-input--padding-right to adjust the position accordingly.

Methods

reset()

We can all the reset() method of the WebComponent in order to reset the value. This will clean the internal states and emit the nullable value with the change event, plus a restarted event:

In this example, the button triggers the method:

Value:  undefined

Browser support

Detected engine:  

• Chromium

• Webkit

• Gecko

HTML Examples

CodeSandbox example