mirror of
https://github.com/onsonr/nebula.git
synced 2025-03-11 01:39:11 +00:00
40 lines
1.7 KiB
TypeScript
40 lines
1.7 KiB
TypeScript
import ShoelaceElement from '../../internal/shoelace-element.js';
|
|
/**
|
|
* @summary Formats a date/time using the specified locale and options.
|
|
* @documentation https://shoelace.style/components/format-date
|
|
* @status stable
|
|
* @since 2.0
|
|
*/
|
|
export default class SlFormatDate extends ShoelaceElement {
|
|
private readonly localize;
|
|
/**
|
|
* The date/time to format. If not set, the current date and time will be used. When passing a string, it's strongly
|
|
* recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert a date to this format
|
|
* in JavaScript, use [`date.toISOString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
|
|
*/
|
|
date: Date | string;
|
|
/** The format for displaying the weekday. */
|
|
weekday: 'narrow' | 'short' | 'long';
|
|
/** The format for displaying the era. */
|
|
era: 'narrow' | 'short' | 'long';
|
|
/** The format for displaying the year. */
|
|
year: 'numeric' | '2-digit';
|
|
/** The format for displaying the month. */
|
|
month: 'numeric' | '2-digit' | 'narrow' | 'short' | 'long';
|
|
/** The format for displaying the day. */
|
|
day: 'numeric' | '2-digit';
|
|
/** The format for displaying the hour. */
|
|
hour: 'numeric' | '2-digit';
|
|
/** The format for displaying the minute. */
|
|
minute: 'numeric' | '2-digit';
|
|
/** The format for displaying the second. */
|
|
second: 'numeric' | '2-digit';
|
|
/** The format for displaying the time. */
|
|
timeZoneName: 'short' | 'long';
|
|
/** The time zone to express the time in. */
|
|
timeZone: string;
|
|
/** The format for displaying the hour. */
|
|
hourFormat: 'auto' | '12' | '24';
|
|
render(): import("lit-html").TemplateResult<1> | undefined;
|
|
}
|