@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
69 lines (68 loc) • 2.83 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.DateFormatProperties = void 0;
const DateFormatProperties = exports.DateFormatProperties = {
value: {
doc: 'The date that will be formatted.',
type: ['Date', 'string'],
status: 'optional'
},
dateStyle: {
doc: 'Defines the style used to format the date. Also affects duration formatting when using ISO 8601 duration strings. Defaults to `long`.',
type: ['long', 'medium', 'short', 'full'],
status: 'optional'
},
hideCurrentYear: {
doc: 'When `true`, the year is hidden if the date is in the current year, for any `dateStyle` (e.g. "4. feb." instead of "4. feb. 2025"). Defaults to `false`.',
type: 'boolean',
status: 'optional'
},
hideYear: {
doc: 'When `true`, the year is always hidden from the formatted date, for any `dateStyle`. Defaults to `false`.',
type: 'boolean',
status: 'optional'
},
timeStyle: {
doc: 'Defines the style used to format the time. If provided, time is included in the output.',
type: ['long', 'medium', 'short', 'full'],
status: 'optional'
},
dateTimeSeparator: {
doc: 'Custom separator used between date and time when both are rendered (e.g. " - "). When not provided, uses the locale-appropriate separator (e.g. " kl. " for Norwegian, " at " for English).',
type: 'string',
status: 'optional'
},
relativeTime: {
doc: 'If set to `true`, actual dates will be formatted as relative time (e.g., "2 hours ago"). ISO 8601 duration strings (e.g., "PT1H") are automatically detected and formatted without this prop. Defaults to `false`.',
type: 'boolean',
status: 'optional'
},
relativeTimeStyle: {
doc: 'Defines the style used to format relative time. Defaults to `dateStyle` when not provided.',
type: ['long', 'medium', 'short', 'full'],
status: 'optional'
},
relativeTimeReference: {
doc: 'A function that returns a Date object to use as the reference point for relative time calculations. If not provided, the current time is used.',
type: 'function',
status: 'optional'
},
locale: {
doc: "A string in [Intl.DateTimeFormat locale](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument) format. Duration formatting supports all locales using the browser's built-in internationalization. Defaults to `nb-NO`.",
type: 'string',
status: 'optional'
},
skeleton: {
doc: 'If set to `true`, an overlaying skeleton with animation will be shown.',
type: 'boolean',
status: 'optional'
},
'[Space](/uilib/layout/space/properties)': {
doc: 'Spacing properties like `top` or `bottom` are supported.',
type: ['string', 'object'],
status: 'optional'
}
};
//# sourceMappingURL=DateFormatDocs.js.map