Text input - Web Component
...
Browser support
Parameters
The Web component uses a <z-text-input>
tag.
The parametrization of the component can be done with the following custom HTML params:
Name | Type | Description |
---|---|---|
config | string | The main parameter has two components following the pattern:
|
label | string | Label of the input |
readonly (optional) | boolean | Transforms the input into an output |
value (optional) | string | Value of the model |
disabled (optional) | boolean | Blocks the interaction with the input component. |
required (optional) | boolean | Marks the input component as required. |
name (optional) | string | Identification for the field inside the form |
invalid (optional) | boolean | The forced state for set the input as invalid |
help-text (optional) | string | The forced message to be shown under the input |
input-type | string | |
pattern | string? | |
data-list | string | Presents a list of suggestions for the input. Values to be separated by comma. |
The events emitted from the component are:
Name | Payload | Description |
---|---|---|
onchange | string | Returns the new value of the "value" attribute |
Playground
Customization
HTML Examples
Imports
html
<link rel="stylesheet" href="/0.3.7/@zurich/web-components/styles.css" />
<script type="module" src="/0.3.7/@zurich/web-components/text-input.js"></script>
Code
html
<!-- Default -->
<z-text-input label="Text input"></z-text-input>
<z-text-input label="Text input" config="shaped"></z-text-input>
<!-- With value -->
<z-text-input label="Text input" value="Some text"></z-text-input>
<z-text-input label="Text input" value="Some text" config="shaped"></z-text-input>
<!-- Disabled -->
<z-text-input label="Text input" disabled></z-text-input>
<z-text-input label="Text input" disabled config="shaped"></z-text-input>
<!-- Readonly -->
<z-text-input label="Text input" readonly value="Some text"></z-text-input>
<z-text-input label="Text input" readonly value="Some text" config="shaped"></z-text-input>
<!-- With help text -->
<z-text-input label="Text input" help-text="Help text"></z-text-input>
<z-text-input label="Text input" help-text="Help text" config="shaped"></z-text-input>
<!-- With maxlength -->
<z-text-input label="Text input" max-length="20"></z-text-input>
<z-text-input label="Text input" max-length="20" config="shaped"></z-text-input>
<!-- Invalid -->
<z-text-input label="Text input" help-text="Invalid input" invalid></z-text-input>
<z-text-input label="Text input" help-text="Invalid input" invalid config="shaped"></z-text-input>