getDatepickerFormat Type documentation¶

(locale: string, config: DatepickerInputConfig, timeWhenDisabled: boolean = false) => string¶

Function

Returns date / datetime format to be used for rendering a date object as text to an Html input element, which has the SiDatepickerDirective .
See https://angular.dev/api/common/DatePipe?tab=usage-notes
-
Returns Either - a custom format provided by the config, - the localized medium format when time and seconds included - the localized short format when time and no seconds included

Parameters
The locale for which the format is returned. locale: `string`¶
The config object of the datepicker. config?: `DatepickerInputConfig`¶
If `true` , a format with time (medium or short) is returned, even if the `disabledTime` config is `true` . timeWhenDisabled: `boolean` = `false`¶

Types Documentation¶

DatepickerInputConfig

extends DatepickerConfig¶

Interface

Properties
Similar to `dateTimeFormat` , but used when only a date is displayed (e.g. when `showTime === false` or `disabledTime === true` ). Only numeric date formats are supported. dateFormat?: `string`¶
A custom date/time format according the Angular date pipe (see https://angular.dev/api/common/DatePipe ). Only numeric date formats are supported. The format is used to render the time of a date-time criterion. If not specified, `mediumTime` is used if the `showSeconds` flag is true, otherwise `shortTime` as default. For the date-only case, 'shortDate' is used. dateTimeFormat?: `string`¶
Defines the time is disabled when visible. Will also be updated on user change. Default is `false` . disabledTime?: `boolean` from `disabledTime`¶
Text or translation key for the `disabled` disable time. Default is `Ignore time` . disabledTimeText?: `TranslatableString` from `disabledTimeText`¶
Options to turn on date range selection. enableDateRange?: `boolean` from `enableDateRange`¶
Text or translation key for the `enabled` disable time. Default is `Consider time` . enabledTimeText?: `TranslatableString` from `enabledTimeText`¶
Consider time with minDate and maxDate enableTimeValidation?: `boolean` from `enableTimeValidation`¶
Option to use two months view for date range picking. enableTwoMonthDateRange?: `boolean` from `enableTwoMonthDateRange`¶
endTimeLabel?: `string` from `endTimeLabel`¶
hideLabels?: `boolean` from `hideLabels`¶
Configuration for hiding week numbers. Default is `false` . hideWeekNumbers?: `boolean` from `hideWeekNumbers`¶
hoursAriaLabel?: `string` from `hoursAriaLabel`¶
hoursLabel?: `string` from `hoursLabel`¶
hoursPlaceholder?: `string` from `hoursPlaceholder`¶
Hides disable time switch in the timepicker part and includes mandatory the time in the picker. mandatoryTime?: `boolean` from `mandatoryTime`¶
Maximal (latest) selectable date. maxDate?: `Date` from `maxDate`¶
meridians?: `string`[] from `meridians`¶
meridiansAriaLabel?: `string` from `meridiansAriaLabel`¶
meridiansLabel?: `string` from `meridiansLabel`¶
millisecondsAriaLabel?: `string` from `millisecondsAriaLabel`¶
millisecondsLabel?: `string` from `millisecondsLabel`¶
millisecondsPlaceholder?: `string` from `millisecondsPlaceholder`¶
Minimal (earliest) selectable date. minDate?: `Date` from `minDate`¶
minutesAriaLabel?: `string` from `minutesAriaLabel`¶
minutesLabel?: `string` from `minutesLabel`¶
minutesPlaceholder?: `string` from `minutesPlaceholder`¶
Only month and year are selectable. onlyMonthSelection?: `boolean` from `onlyMonthSelection`¶
secondsAriaLabel?: `string` from `secondsAriaLabel`¶
secondsLabel?: `string` from `secondsLabel`¶
secondsPlaceholder?: `string` from `secondsPlaceholder`¶
Defines the timepicker milliseconds visibility . Default is `false` . showMilliseconds?: `boolean` from `showMilliseconds`¶
Defines the timepicker minutes visibility. Default is `true` . showMinutes?: `boolean` from `showMinutes`¶
Defines the timepicker seconds visibility . Default is `false` . showSeconds?: `boolean` from `showSeconds`¶
Defines the timepicker visibility. Default is `false` . showTime?: `boolean` from `showTime`¶
startTimeLabel?: `string` from `startTimeLabel`¶
Text or translation key for today button title. Default is `Today` . todayText?: `TranslatableString` from `todayText`¶
Defines the starting day of the week. Default is `monday` . weekStartDay?: `WeekStart` from `weekStartDay`¶

DatepickerConfig

¶

Interface

Properties
Defines the time is disabled when visible. Will also be updated on user change. Default is `false` . disabledTime?: `boolean`¶
Text or translation key for the `disabled` disable time. Default is `Ignore time` . disabledTimeText?: `TranslatableString`¶
Options to turn on date range selection. enableDateRange?: `boolean`¶
Text or translation key for the `enabled` disable time. Default is `Consider time` . enabledTimeText?: `TranslatableString`¶
Consider time with minDate and maxDate enableTimeValidation?: `boolean`¶
Option to use two months view for date range picking. enableTwoMonthDateRange?: `boolean`¶
endTimeLabel?: `string`¶
hideLabels?: `boolean`¶
Configuration for hiding week numbers. Default is `false` . hideWeekNumbers?: `boolean`¶
hoursAriaLabel?: `string`¶
hoursLabel?: `string`¶
hoursPlaceholder?: `string`¶
Hides disable time switch in the timepicker part and includes mandatory the time in the picker. mandatoryTime?: `boolean`¶
Maximal (latest) selectable date. maxDate?: `Date`¶
meridians?: `string`[]¶
meridiansAriaLabel?: `string`¶
meridiansLabel?: `string`¶
millisecondsAriaLabel?: `string`¶
millisecondsLabel?: `string`¶
millisecondsPlaceholder?: `string`¶
Minimal (earliest) selectable date. minDate?: `Date`¶
minutesAriaLabel?: `string`¶
minutesLabel?: `string`¶
minutesPlaceholder?: `string`¶
Only month and year are selectable. onlyMonthSelection?: `boolean`¶
secondsAriaLabel?: `string`¶
secondsLabel?: `string`¶
secondsPlaceholder?: `string`¶
Defines the timepicker milliseconds visibility . Default is `false` . showMilliseconds?: `boolean`¶
Defines the timepicker minutes visibility. Default is `true` . showMinutes?: `boolean`¶
Defines the timepicker seconds visibility . Default is `false` . showSeconds?: `boolean`¶
Defines the timepicker visibility. Default is `false` . showTime?: `boolean`¶
startTimeLabel?: `string`¶
Text or translation key for today button title. Default is `Today` . todayText?: `TranslatableString`¶
Defines the starting day of the week. Default is `monday` . weekStartDay?: `WeekStart`¶

disabledTime? `boolean`¶ Property Defines the time is disabled when visible. Will also be updated on user change. Default is `false` .

TranslatableString (`string` & `Translatable`)¶ Type alias Represents a translatable string. This can either be a translation key, e.g. `ACTIONS.EDIT` that will be automatically translated when displayed on the UI or a pre-translated string, e.g. `Edit` . Equivalent to a normal string in usage and functionality.

disabledTimeText? `TranslatableString`¶ Property Text or translation key for the `disabled` disable time. Default is `Ignore time` .

enableDateRange? `boolean`¶ Property Options to turn on date range selection.

enabledTimeText? `TranslatableString`¶ Property Text or translation key for the `enabled` disable time. Default is `Consider time` .

enableTimeValidation? `boolean`¶ Property Consider time with minDate and maxDate

enableTwoMonthDateRange? `boolean`¶ Property Option to use two months view for date range picking.

endTimeLabel? `string`¶ Property

hideLabels? `boolean`¶ Property

hideWeekNumbers? `boolean`¶ Property Configuration for hiding week numbers. Default is `false` .

hoursAriaLabel? `string`¶ Property

hoursLabel? `string`¶ Property

hoursPlaceholder? `string`¶ Property

mandatoryTime? `boolean`¶ Property Hides disable time switch in the timepicker part and includes mandatory the time in the picker.

maxDate? `Date`¶ Property Maximal (latest) selectable date.

meridians? `string`[]¶ Property

meridiansAriaLabel? `string`¶ Property

meridiansLabel? `string`¶ Property

millisecondsAriaLabel? `string`¶ Property

millisecondsLabel? `string`¶ Property

millisecondsPlaceholder? `string`¶ Property

minDate? `Date`¶ Property Minimal (earliest) selectable date.

minutesAriaLabel? `string`¶ Property

minutesLabel? `string`¶ Property

minutesPlaceholder? `string`¶ Property

onlyMonthSelection? `boolean`¶ Property Only month and year are selectable.

secondsAriaLabel? `string`¶ Property

secondsLabel? `string`¶ Property

secondsPlaceholder? `string`¶ Property

showMilliseconds? `boolean`¶ Property Defines the timepicker milliseconds visibility . Default is `false` .

showMinutes? `boolean`¶ Property Defines the timepicker minutes visibility. Default is `true` .

showSeconds? `boolean`¶ Property Defines the timepicker seconds visibility . Default is `false` .

showTime? `boolean`¶ Property Defines the timepicker visibility. Default is `false` .

startTimeLabel? `string`¶ Property

todayText? `TranslatableString`¶ Property Text or translation key for today button title. Default is `Today` .

WeekStart (`"monday"` \| `"saturday"` \| `"sunday"` \| `undefined`)¶ Type alias

weekStartDay? `WeekStart`¶ Property Defines the starting day of the week. Default is `monday` .

Translatable ¶ import imported from @siemens/element-translate-ng

Except where otherwise noted, content on this site is licensed under MIT License.