Back to Homepage

Date & Time

docs/widgets/info/datetime.md

1.12.31.2 KB
Original Source

This allows you to display the date and/or time, can be heavily configured using Intl.DateTimeFormat.

Formatting is locale aware and will present your date in the regional format you expect, for example, 9/16/22, 3:03 PM for locale en and 16.09.22, 15:03 for de. You can also specify a locale just for the datetime widget with the locale option (see below).

yaml
- datetime:
    text_size: xl
    format:
      timeStyle: short

Any options passed to format are passed directly to Intl.DateTimeFormat, please reference the MDN documentation for all available options.

Valid text sizes are 4xl, 3xl, 2xl, xl, md, sm, xs.

A few examples,

yaml
# 13:37
format:
  timeStyle: short
  hourCycle: h23
yaml
# 1:37 PM
format:
  timeStyle: short
  hour12: true
yaml
# 1/23/22, 1:37 PM
format:
  dateStyle: short
  timeStyle: short
  hour12: true
yaml
# 4 januari 2023 om 13:51:25 PST
locale: nl
format:
  dateStyle: long
  timeStyle: long