Skip to content

Date input - Web Component โ€‹

The DateInput 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-date-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:

NameTypeDescriptionSlotA11y
configstring

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.
labelstringLabel of the inputlabel
readonlybooleanTransforms the input into an output
autocompletestringAutomated assistance in filling out form field values
valuestringValue of the model
disabledbooleanBlocks the interaction with the input component.
requiredbooleanMarks the input component as required.
namestringIdentification for the field inside the form
help-textstringThe forced message to be shown under the inputhelp-text
invalidbooleanThe forced state for set the input as invalid
input-typestring

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

Events โ€‹

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

NamePayloadDescription
changestringReturns the new value of the "value" attribute
entervoidTriggered when "Enter" in pressed
restartedvoidEmitted on value reset

Slots โ€‹

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

NameTagsDescription
labelspan
help-textspan

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:

Date input

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.

You can also use the help-text slot:

This is a help text

input-type โ€‹

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

Browser support โ€‹

Detected engine: ย 

  • Chromium

  • Webkit

  • Gecko

HTML Examples โ€‹

CodeSandbox example โ€‹