Skip to content
Date input
This is a help text
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
...
Events
This component has events. Check the documentation about how to use the events.
Name | Payload | Description |
---|---|---|
change | string | 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 |
Slots
This component has slots. Check the documentation about how to use the slots.
Name | Tags | Description |
---|---|---|
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:
model
The model
parameter is used to set the date for the input. Make sure you use a valid date format (ISO 8601) as yyyy-mm-dd
:
help-text
The help-text
parameter is used to provide additional assistance to the user.
You can also use the help-text
slot:
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.
input-type
The input-type
parameter is used to set the type of input. Possible values are: date
, month
, datetime-local
and week
.
Attention!
Firefox and Safari do not support type="month"
nor type="week"
. For type="datetime-local"
both don't show a time picker natively.
Check the datetime-local workaround for more details.
name
The name
parameter is used to set the name of the component. This is useful when the component is part of a form.
locale
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 component as readonly.
required
The required
parameter is used to set the component as required.
invalid
The invalid
parameter is used to force the component to be invalid.
custom-ui
Still experimental!
Do not use it in production
Ables the use of a custom date picker:
The calendar will adjust to the input:
If you use the custom-ui
, you can also pass other Calendar
modifiers like:
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
Special uses
datetime-local
workaround
Since Firefox and Safari do not fully support the datetime-local
input type, we can use the DateInput
and TimeInput
together to achieve almost the same result and then having independent controls:
Browser support
Detected engine:
Chromium
Webkit
Gecko