Date input - Web Component

Attention!

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

Browser support

Detected engine:  

• Chromium

• Webkit

• Gecko

Parameters

The Web component uses the <z-date-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: <shape><?:size>. shape: Establishes the styling of the input. Default value is line . Possible values are: shaped or line. , size: (optional) defines de size of the input. The default value is m, being omitted from the param. The possible values are: m or l. Check the sizes section.
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	Type of input. Possible values are: date: it will a date, without the day of the month as yyyy-mm-dd. month: it will handle a shorter version of the date, without the day of the month as yyyy-mm. datetime-localit will handle an extended version of the date including the time as yyyy-mm-ddThh:mm following the ISO string format. week: it will provide the year and the week number based on ISO 8601, where the format will be yyyy-Wnn

The events emitted from the component are:

Name	Payload	Description
onchange	string	Returns the new value of the "value" attribute
onenter	void	Triggered when "Enter" in pressed

The available slots for the component are:

Name	Tags	Description
default	span

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.

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 date for the input. Make sure you use a valid date 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.

input-type

The input-type parameter is used to set the type of input. Possible values are: date, month, datetime-local and week.

Playground

Customization

HTML Examples

Imports

<link rel="stylesheet" href="/0.5.0/@zurich/web-components/styles.css" />
<script type="module" src="/0.5.0/@zurich/web-components/date-input.js"></script>

Code

<!-- Default -->
<z-date-input label="Date input"></z-date-input>
<z-date-input label="Date input" config="shaped"></z-date-input>

<!-- with value -->
<z-date-input label="Date input" value="2024-09-21"></z-date-input>
<z-date-input label="Date input" value="2024-09-21" config="shaped"></z-date-input>

<!-- datetime-local -->
<z-date-input label="Date input" type="datetime-local"></z-date-input>
<z-date-input label="Date input" type="datetime-local" config="shaped"></z-date-input>

<!-- month -->
<z-date-input label="Date input" type="month"></z-date-input>
<z-date-input label="Date input" type="month" config="shaped"></z-date-input>

<!-- week -->
<z-date-input label="Date input" type="week"></z-date-input>
<z-date-input label="Date input" type="week" config="shaped"></z-date-input>

<!-- disabled -->
<z-date-input label="Date input" disabled></z-date-input>
<z-date-input label="Date input" disabled config="shaped"></z-date-input>

<!-- readonly -->
<z-date-input label="Date input" readonly value="2024-09-21"></z-date-input>
<z-date-input label="Date input" readonly value="2024-09-21" config="shaped"></z-date-input>

<!-- with help text -->
<z-date-input label="Date input" help-text="Help text"></z-date-input>
<z-date-input label="Date input" help-text="Help text" config="shaped"></z-date-input>

<!-- invalid -->
<z-date-input label="Date input" help-text="Invalid input" invalid></z-date-input>
<z-date-input label="Date input" help-text="Invalid input" invalid config="shaped"></z-date-input>