@mui/x-date-pickers/locales/utils/pickersLocaleTextApi.d.ts

The community edition of the Date and Time Picker components (MUI X).

import { TimeViewWithMeridiem } from '../../internals/models';
import { DateView, TimeView, MuiPickersAdapter, FieldSectionContentType, PickerValidDate } 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 extends PickerValidDate> {
    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;
    startDate: string;
    startTime: string;
    endDate: string;
    endTime: string;
    cancelButtonLabel: string;
    clearButtonLabel: string;
    okButtonLabel: string;
    todayButtonLabel: string;
    clockLabelText: (view: TimeView, 
    /**
     * @deprecated Use `formattedTime` instead
     */
    time: TDate | null, 
    /**
     * @deprecated Use `formattedTime` instead
     */
    utils: MuiPickersAdapter<TDate>, formattedTime?: string | null) => string;
    hoursClockNumberText: (hours: string) => string;
    minutesClockNumberText: (minutes: string) => string;
    secondsClockNumberText: (seconds: string) => string;
    selectViewText: (view: TimeViewWithMeridiem) => string;
    openDatePickerDialogue: (
    /**
     * @deprecated Use `formattedTime` instead
     */
    date: TDate | null, 
    /**
     * @deprecated Use `formattedTime` instead
     */
    utils: MuiPickersAdapter<TDate>, formattedDate: string | null) => string;
    openTimePickerDialogue: (
    /**
     * @deprecated Use `formattedTime` instead
     */
    date: TDate | null, 
    /**
     * @deprecated Use `formattedTime` instead
     */
    utils: MuiPickersAdapter<TDate>, formattedTime: string | null) => 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;
    year: string;
    month: string;
    day: string;
    weekDay: string;
    hours: string;
    minutes: string;
    seconds: string;
    meridiem: string;
    empty: string;
}
export interface PickersLocaleText<TDate extends PickerValidDate> extends PickersComponentAgnosticLocaleText<TDate>, PickersComponentSpecificLocaleText {
}
export type PickersInputLocaleText<TDate extends PickerValidDate> = 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 PickerValidDate> 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 extends PickerValidDate, Props extends {
    localeText?: PickersInputComponentLocaleText<TDate>;
}> = Omit<Props, 'localeText'> & {
    localeText?: PickersInputLocaleText<TDate>;
};