Skip to content

Time input - Web Component

The TimeInput 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.

NamePayloadDescription
changestringReturns the new value of the "value" attribute
entervoidTriggered when "Enter" in pressed
restartedvoidEmitted on value reset
blurvoidEmitted on blur
validatedbooleanEmitted when the validation status changes

Slots

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

NameTagsDescription
labelspan
help-textspan

Parameters use

model

The model parameter is used to set the text for the input. Make sure you use a valid time format (ISO 8601) as hh:mm or hh:mm:ss:

Attention!

If you hardcode this value, it will not be reactive and the selection won't change. Use a variable instead and, ideally, a closed loop.

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:

Time input

name

The name parameter is used to set the name of the component. This is useful when the component is part of a form.

help-text

The help-text parameter is used to provide additional assistance to the user.

range

The range parameter is used to define the min and max values of the input. It must be an array with two strings.

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.

locale

Check this documentation

Flags

readonly

The readonly parameter is used to set the input in a read-only state. It's commonly used to display information.

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.

The default text adapts to the localization:

invalid

The invalid parameter is used to set the component as invalid.

The default text adapts to the localization:

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

Browser support

Detected engine:  

  • Chromium

  • Webkit

  • Gecko

HTML Examples

CodeSandbox example