shoelace/docs/components/format-date.md

Format Date

[component-header:sl-format-date]

Formats a date/time using the specified locale and options.

Localization is handled by the browser's Intl.DateTimeFormat API. No language packs are required.

<!-- Shoelace 2 release date 🎉 -->
<sl-format-date date="2020-07-15T09:17:00-04:00"></sl-format-date>

The date attribute determines the date/time to use when formatting. It must be a string that Date.parse() can interpret or a Date object set via JavaScript. If omitted, the current date/time will be assumed.

?> When using strings, avoid ambiguous dates such as 03/04/2020 which can be interpreted as March 4 or April 3 depending on the user's browser and locale. Instead, always use a valid ISO 8601 date time string to ensure the date will be parsed properly by all clients.

Examples

Date & Time Formatting

Formatting options are based on those found in the Intl.DateTimeFormat API. When formatting options are provided, the date/time will be formatted according to those values. When no formatting options are provided, a localized, numeric date will be displayed instead.

<!-- Human-readable date -->
<sl-format-date month="long" day="numeric" year="numeric"></sl-format-date><br>

<!-- Time -->
<sl-format-date hour="numeric" minute="numeric"></sl-format-date><br>

<!-- Weekday -->
<sl-format-date weekday="long"></sl-format-date><br>

<!-- Month -->
<sl-format-date month="long"></sl-format-date><br>

<!-- Year -->
<sl-format-date year="numeric"></sl-format-date><br>

<!-- No formatting options -->
<sl-format-date></sl-format-date>

Hour Formatting

By default, the browser will determine whether to use 12-hour or 24-hour time. To force one or the other, set the hour-format attribute to 12 or 24.

<sl-format-date hour="numeric" minute="numeric" hour-format="12"></sl-format-date><br>
<sl-format-date hour="numeric" minute="numeric" hour-format="24"></sl-format-date>

Localization

Use the locale attribute to set the date/time formatting locale.

English: <sl-format-date locale="en"></sl-format-date><br>
French: <sl-format-date locale="fr"></sl-format-date><br>
Russian: <sl-format-date locale="ru"></sl-format-date><br>

[component-metadata:sl-format-date]