mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 12:09:26 +00:00
8121faa1d4
* keep header styles with repositioned description text * `animated-image` move description to component * code style * `avatar` add summary from docs * `badge` add summary from docs * `breadcrumb` add summary from docs * `button` add summary from docs * lead sentence is now part of the header * `button-group` add summary from docs * `card` add summary from docs * `checkbox` add summary from docs * `color-picker` add summary from docs * `details` add summary from docs * `dialog` add summary from docs * `divider` add summary from docs * `drawer` add summary from docs * `dropdown` add summary from docs * `format-bytes` add summary from docs * `format-date` add summary from docs * `format-number` add summary from docs * `icon` add summary from docs * `icon-button` add summary from docs * `image-comparer` add summary from docs * `include` add summary from docs * `input` add summary from docs * `menu` add summary from docs * `menu-item` add summary from docs * `menu-label` add summary from docs * `popup` add summary from docs * `progressbar` add summary from docs * `progress-ring` add summary from docs * `radio` add summary from docs * `radio-button` add summary from docs * `range` add summary from docs * `rating` add summary from docs * `relative-time` add summary from docs * `select` add summary from docs * `skeleton` add summary from docs * `spinner` add summary from docs * `split-panel` add summary from docs * `switch` add summary from docs * `tab-group` add summary from docs * `tag` add summary from docs * `textarea` add summary from docs * `tooltip` add summary from docs * `visually-hidden` add summary from docs * `animation` add summary from docs * `breadcrumb-item` add summary from docs * `mutation-observer` add summary from docs * `radio-group` add summary from docs * `resize-observer` add summary from docs * `tab` add summary from docs * `tab-panel` add summary from docs * `tree` add summary from docs * `tree-item` add summary from docs * remove `title` for further usage of `Sl` classnames in docs * revert: use markdown parser for component summary
125 lines
3.9 KiB
Markdown
125 lines
3.9 KiB
Markdown
# Format Date
|
|
|
|
[component-header:sl-format-date]
|
|
|
|
Localization is handled by the browser's [`Intl.DateTimeFormat` API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat). No language packs are required.
|
|
|
|
```html preview
|
|
<!-- Shoelace 2 release date 🎉 -->
|
|
<sl-format-date date="2020-07-15T09:17:00-04:00"></sl-format-date>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlFormatDate } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => <SlFormatDate date="2020-07-15T09:17:00-04:00" />;
|
|
```
|
|
|
|
The `date` attribute determines the date/time to use when formatting. It must be a string that [`Date.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse) can interpret or a [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse#Date_Time_String_Format) 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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat). 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.
|
|
|
|
```html preview
|
|
<!-- 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>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlFormatDate } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<>
|
|
{/* Human-readable date */}
|
|
<SlFormatDate month="long" day="numeric" year="numeric" />
|
|
<br />
|
|
|
|
{/* Time */}
|
|
<SlFormatDate hour="numeric" minute="numeric" />
|
|
<br />
|
|
|
|
{/* Weekday */}
|
|
<SlFormatDate weekday="long" />
|
|
<br />
|
|
|
|
{/* Month */}
|
|
<SlFormatDate month="long" />
|
|
<br />
|
|
|
|
{/* Year */}
|
|
<SlFormatDate year="numeric" />
|
|
<br />
|
|
|
|
{/* No formatting options */}
|
|
<SlFormatDate />
|
|
</>
|
|
);
|
|
```
|
|
|
|
### 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`.
|
|
|
|
```html preview
|
|
<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>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlFormatDate } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<>
|
|
<SlFormatDate hour="numeric" minute="numeric" hour-format="12" />
|
|
<br />
|
|
<SlFormatDate hour="numeric" minute="numeric" hour-format="24" />
|
|
</>
|
|
);
|
|
```
|
|
|
|
### Localization
|
|
|
|
Use the `lang` attribute to set the date/time formatting locale.
|
|
|
|
```html preview
|
|
English: <sl-format-date lang="en"></sl-format-date><br />
|
|
French: <sl-format-date lang="fr"></sl-format-date><br />
|
|
Russian: <sl-format-date lang="ru"></sl-format-date>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlFormatDate } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<>
|
|
English: <SlFormatDate lang="en" />
|
|
<br />
|
|
French: <SlFormatDate lang="fr" />
|
|
<br />
|
|
Russian: <SlFormatDate lang="ru" />
|
|
</>
|
|
);
|
|
```
|
|
|
|
[component-metadata:sl-format-date]
|