@mui/x-date-pickers/internals/components/PickersArrowSwitcher/PickersArrowSwitcher.types.d.ts

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

import * as React from 'react';
import { SlotComponentProps } from '@mui/utils';
import IconButton from '@mui/material/IconButton';
import SvgIcon from '@mui/material/SvgIcon';
import { PickersArrowSwitcherClasses } from './pickersArrowSwitcherClasses';
export interface ExportedPickersArrowSwitcherProps {
    /**
     * Overridable component slots.
     * @default {}
     */
    slots?: PickersArrowSwitcherSlots;
    /**
     * The props used for each component slot.
     * @default {}
     */
    slotProps?: PickersArrowSwitcherSlotProps;
    /**
     * Override or extend the styles applied to the component.
     */
    classes?: Partial<PickersArrowSwitcherClasses>;
    /**
     * Format used to display the date.
     * @default `${adapter.formats.month} ${adapter.formats.year}`
     */
    format?: string;
}
export interface PickersArrowSwitcherProps extends ExportedPickersArrowSwitcherProps, Omit<React.HTMLProps<HTMLDivElement>, 'ref' | 'as'> {
    children?: React.ReactNode;
    isPreviousDisabled: boolean;
    isPreviousHidden?: boolean;
    onGoToPrevious: () => void;
    previousLabel: string;
    isNextDisabled: boolean;
    isNextHidden?: boolean;
    onGoToNext: () => void;
    nextLabel: string;
    labelId?: string;
}
export type PickersArrowSwitcherOwnerState = PickersArrowSwitcherProps;
export interface PickersArrowSwitcherSlotPropsOverrides {
}
export interface PickersArrowSwitcherSlots {
    /**
     * Button allowing to switch to the left view.
     * @default IconButton
     */
    previousIconButton?: React.ElementType;
    /**
     * Button allowing to switch to the right view.
     * @default IconButton
     */
    nextIconButton?: React.ElementType;
    /**
     * Icon displayed in the left view switch button.
     * @default ArrowLeft
     */
    leftArrowIcon?: React.ElementType;
    /**
     * Icon displayed in the right view switch button.
     * @default ArrowRight
     */
    rightArrowIcon?: React.ElementType;
}
export interface PickersArrowSwitcherButtonSlotOwnerState extends PickersArrowSwitcherOwnerState {
    hidden?: boolean;
}
export interface PickersArrowSwitcherSlotProps {
    previousIconButton?: SlotComponentProps<typeof IconButton, PickersArrowSwitcherSlotPropsOverrides, PickersArrowSwitcherButtonSlotOwnerState>;
    nextIconButton?: SlotComponentProps<typeof IconButton, PickersArrowSwitcherSlotPropsOverrides, PickersArrowSwitcherButtonSlotOwnerState>;
    leftArrowIcon?: SlotComponentProps<typeof SvgIcon, PickersArrowSwitcherSlotPropsOverrides, PickersArrowSwitcherButtonSlotOwnerState>;
    rightArrowIcon?: SlotComponentProps<typeof SvgIcon, PickersArrowSwitcherSlotPropsOverrides, PickersArrowSwitcherButtonSlotOwnerState>;
}