100 lines
4.1 KiB
TypeScript
100 lines
4.1 KiB
TypeScript
import { TimeViewWithMeridiem } from '../../internals/models';
|
|
import { DateView, TimeView, MuiPickersAdapter, FieldSectionContentType } from '../../models';
|
|
export interface PickersComponentSpecificLocaleText {
|
|
/**
|
|
* Title displayed in the toolbar of the `DatePicker` and its variants.
|
|
* Will be overridden by the `toolbarTitle` translation key passed directly on the picker.
|
|
*/
|
|
datePickerToolbarTitle: string;
|
|
/**
|
|
* Title displayed in the toolbar of the `TimePicker` and its variants.
|
|
* Will be overridden by the `toolbarTitle` translation key passed directly on the picker.
|
|
*/
|
|
timePickerToolbarTitle: string;
|
|
/**
|
|
* Title displayed in the toolbar of the `DateTimePicker` and its variants.
|
|
* Will be overridden by the `toolbarTitle` translation key passed directly on the picker.
|
|
*/
|
|
dateTimePickerToolbarTitle: string;
|
|
/**
|
|
* Title displayed in the toolbar of the `DateRangePicker` and its variants.
|
|
* Will be overridden by the `toolbarTitle` translation key passed directly on the picker.
|
|
*/
|
|
dateRangePickerToolbarTitle: string;
|
|
}
|
|
export interface PickersComponentAgnosticLocaleText<TDate> {
|
|
previousMonth: string;
|
|
nextMonth: string;
|
|
calendarWeekNumberHeaderLabel: string;
|
|
calendarWeekNumberHeaderText: string;
|
|
calendarWeekNumberAriaLabelText: (weekNumber: number) => string;
|
|
calendarWeekNumberText: (weekNumber: number) => string;
|
|
openPreviousView: string;
|
|
openNextView: string;
|
|
calendarViewSwitchingButtonAriaLabel: (currentView: DateView) => string;
|
|
start: string;
|
|
end: string;
|
|
cancelButtonLabel: string;
|
|
clearButtonLabel: string;
|
|
okButtonLabel: string;
|
|
todayButtonLabel: string;
|
|
clockLabelText: (view: TimeView, time: TDate | null, adapter: MuiPickersAdapter<TDate>) => string;
|
|
hoursClockNumberText: (hours: string) => string;
|
|
minutesClockNumberText: (minutes: string) => string;
|
|
secondsClockNumberText: (seconds: string) => string;
|
|
selectViewText: (view: TimeViewWithMeridiem) => string;
|
|
openDatePickerDialogue: (date: TDate | null, utils: MuiPickersAdapter<TDate>) => string;
|
|
openTimePickerDialogue: (date: TDate | null, utils: MuiPickersAdapter<TDate>) => string;
|
|
fieldClearLabel: string;
|
|
timeTableLabel: string;
|
|
dateTableLabel: string;
|
|
fieldYearPlaceholder: (params: {
|
|
digitAmount: number;
|
|
format: string;
|
|
}) => string;
|
|
fieldMonthPlaceholder: (params: {
|
|
contentType: FieldSectionContentType;
|
|
format: string;
|
|
}) => string;
|
|
fieldDayPlaceholder: (params: {
|
|
format: string;
|
|
}) => string;
|
|
fieldWeekDayPlaceholder: (params: {
|
|
contentType: FieldSectionContentType;
|
|
format: string;
|
|
}) => string;
|
|
fieldHoursPlaceholder: (params: {
|
|
format: string;
|
|
}) => string;
|
|
fieldMinutesPlaceholder: (params: {
|
|
format: string;
|
|
}) => string;
|
|
fieldSecondsPlaceholder: (params: {
|
|
format: string;
|
|
}) => string;
|
|
fieldMeridiemPlaceholder: (params: {
|
|
format: string;
|
|
}) => string;
|
|
}
|
|
export interface PickersLocaleText<TDate> extends PickersComponentAgnosticLocaleText<TDate>, PickersComponentSpecificLocaleText {
|
|
}
|
|
export type PickersInputLocaleText<TDate> = Partial<PickersLocaleText<TDate>>;
|
|
/**
|
|
* Translations that can be provided directly to the picker components.
|
|
* It contains some generic translations like `toolbarTitle`
|
|
* which will be dispatched to various translations keys in `PickersLocaleText`, depending on the pickers received them.
|
|
*/
|
|
export interface PickersInputComponentLocaleText<TDate> extends Partial<PickersComponentAgnosticLocaleText<TDate>> {
|
|
/**
|
|
* Title displayed in the toolbar of this picker.
|
|
* Will override the global translation keys like `datePickerToolbarTitle` passed to the `LocalizationProvider`.
|
|
*/
|
|
toolbarTitle?: string;
|
|
}
|
|
export type PickersTranslationKeys = keyof PickersLocaleText<any>;
|
|
export type LocalizedComponent<TDate, Props extends {
|
|
localeText?: PickersInputComponentLocaleText<TDate>;
|
|
}> = Omit<Props, 'localeText'> & {
|
|
localeText?: PickersInputLocaleText<TDate>;
|
|
};
|