@progress/kendo-angular-dateinputs
Version:
Kendo UI for Angular Date Inputs Package - Everything you need to add date selection functionality to apps (DatePicker, TimePicker, DateInput, DateRangePicker, DateTimePicker, Calendar, and MultiViewCalendar).
67 lines (66 loc) • 2.52 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
/**
* The interface which defines a custom-format placeholder structure in the DateInput component.
*
* @example
* ```ts
* _@Component({
* selector: 'my-app',
* template: `
* <kendo-dateinput format="G"
* [formatPlaceholder]="{
* year: 'y', month: 'M', day: 'd',
* hour: 'h', minute: 'm', second: 's'
* }"
* ></kendo-dateinput>
* `
* })
* export class AppComponent { }
* ```
*/
export interface DateInputCustomFormatPlaceholder {
/**
* Defines the description for the `year` format section.
*/
year?: string;
/**
* Defines the description for the `month` format section.
*/
month?: string;
/**
* Defines the description for the `day` format section.
*/
day?: string;
/**
* Defines the description for the `hour` format section.
*/
hour?: string;
/**
* Defines the description for the `minute` format section.
*/
minute?: string;
/**
* Defines the description for the `second` format section.
*/
second?: string;
/**
* Defines the description for the `millisecond` format section.
*/
millisecond?: string;
}
/**
* The union type which defines all possible format options of the DateInput placeholder.
*
* The available options are:
* * `'wide'`—Displays the full description of the format section. For example, turns `MM` into `month`.
* Retrieved from [CLDR](https://github.com/telerik/kendo-intl/blob/develop/docs/cldr/index.md).
* * `'narrow'`—Displays the narrow description of the format section. For example, turns `MM` into `mo.`.
* Retrieved from [CLDR](https://github.com/telerik/kendo-intl/blob/develop/docs/cldr/index.md).
* * `'short'`—Displays the short description of the format section. For example, turns `MM` into `mo.`.
* Retrieved from [CLDR](https://github.com/telerik/kendo-intl/blob/develop/docs/cldr/index.md).
* *`'formatPattern'`—Directly displays the format section. For example, turns `MM` into `MM`.
*/
export type DateInputFormatPlaceholder = 'wide' | 'narrow' | 'short' | 'formatPattern' | DateInputCustomFormatPlaceholder;