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
The Web component uses the <z-number-input> tag:
By default, all the parameters are optional or can be set in different, except for the ones marked as required
The parametrization of the component can be done with the following custom HTML params:
| Name | Type | Description | Slot | A11y |
|---|---|---|---|---|
config | string | The main parameter has two components following the pattern:
| ||
label | string | Label of the input | label | |
readonly | boolean | Transforms the input into an output | ||
autocomplete | string | Automated assistance in filling out form field values | ||
value | number | Value of the model | ||
disabled | boolean | Blocks the interaction with the input component. | ||
required | boolean | Marks the input component as required. | ||
name | string | Identification for the field inside the form | ||
help-text | string | The forced message to be shown under the input | help-text | |
invalid | boolean | The forced state for set the input as invalid | ||
range | number[] | First value is the minimum value of the input, second value is the maximum value of the input. | ||
step | number | Step value of the input. | ||
data-list | number[] | Presents a list of suggestions for the input | default |
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 |
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:
readonly
The readonly parameter is used to set the input in a read-only state. It's commonly used to display information.
value
The value parameter is used to set the number for the input. Make sure you use a valid number format.
disabled
The disabled parameter is used to block the interaction with the component. Not to be confused with readonly.
required
The required parameter is used to set the component as required.
name
The name parameter is used to set the name of the component. This is useful when the component is part of a form.
invalid
The invalid parameter is used to force the component to be invalid.
help-text
The help-text parameter is used to provide additional assistance to the user.
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.
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:
Browser support
Detected engine:
Chromium
Webkit
Gecko