UNPKG

@mui/x-date-pickers

Version:

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

49 lines (48 loc) 2.46 kB
import * as React from 'react'; import { ExportedPickersLayoutSlots, ExportedPickersLayoutSlotProps } from '../../../PickersLayout/PickersLayout.types'; import { BasePickerProps } from '../../models/props/basePickerProps'; import { UsePickerParams } from '../usePicker'; import { UsePickerViewsProps } from '../usePicker/usePickerViews'; import { FieldSection, PickerValidDate } from '../../../models'; import { DateOrTimeViewWithMeridiem } from '../../models'; export interface UseStaticPickerSlots<TDate extends PickerValidDate, TView extends DateOrTimeViewWithMeridiem> extends ExportedPickersLayoutSlots<TDate | null, TDate, TView> { } export interface UseStaticPickerSlotProps<TDate extends PickerValidDate, TView extends DateOrTimeViewWithMeridiem> extends ExportedPickersLayoutSlotProps<TDate | null, TDate, TView> { } export interface StaticOnlyPickerProps { /** * Force static wrapper inner components to be rendered in mobile or desktop mode. * @default "mobile" */ displayStaticWrapperAs: 'desktop' | 'mobile'; /** * If `true`, the view is focused during the first mount. * @default false */ autoFocus?: boolean; /** * Callback fired when component requests to be closed. * Can be fired when selecting (by default on `desktop` mode) or clearing a value. * @deprecated Please avoid using as it will be removed in next major version. */ onClose?: () => void; } export interface UseStaticPickerProps<TDate extends PickerValidDate, TView extends DateOrTimeViewWithMeridiem, TError, TExternalProps extends UsePickerViewsProps<TDate | null, TDate, TView, any, any>> extends BasePickerProps<TDate | null, TDate, TView, TError, TExternalProps, {}>, StaticOnlyPickerProps { /** * Overridable component slots. * @default {} */ slots?: UseStaticPickerSlots<TDate, TView>; /** * The props used for each component slot. * @default {} */ slotProps?: UseStaticPickerSlotProps<TDate, TView>; } export interface UseStaticPickerParams<TDate extends PickerValidDate, TView extends DateOrTimeViewWithMeridiem, TExternalProps extends UseStaticPickerProps<TDate, TView, any, TExternalProps>> extends Pick<UsePickerParams<TDate | null, TDate, TView, FieldSection, TExternalProps, {}>, 'valueManager' | 'valueType' | 'validator'> { props: TExternalProps; /** * Ref to pass to the root element */ ref?: React.Ref<HTMLDivElement>; }