@mui/x-date-pickers/PickersSectionList/PickersSectionList.types.d.ts

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

import type * as React from 'react';
import type { SlotComponentProps } from '@mui/utils/types';
import type { PickersSectionListClasses } from "./pickersSectionListClasses.js";
import type { PickerOwnerState } from "../models/index.js";
import type { UseFieldDOMGetters } from "../internals/hooks/useField/useField.types.js";
export interface PickersSectionListSlots {
  /**
   * The component that renders the root.
   * @default PickersSectionListRoot
   */
  root: React.ElementType;
  /**
   * The component that renders a section.
   * @default PickersSectionListSection
   */
  section: React.ElementType;
  /**
   * The component that renders the separator before or after a section.
   * @default PickersSectionListSectionSeparator
   */
  sectionSeparator: React.ElementType;
  /**
   * The component that renders the editable content of a section.
   * @default PickersSectionListSectionContent
   */
  sectionContent: React.ElementType;
}
export interface PickerSectionSeparatorOwnerState extends PickerOwnerState {
  /**
   * The position of the separator.
   * `before` if the separator is rendered before the section content.
   * `after` if the separator is rendered after the section content.
   */
  separatorPosition: 'before' | 'after';
}
export interface PickersSectionListSlotProps {
  root?: SlotComponentProps<'div', {}, PickerOwnerState>;
  section?: SlotComponentProps<'span', {}, PickerOwnerState>;
  sectionSeparator?: SlotComponentProps<'span', {}, PickerSectionSeparatorOwnerState>;
  sectionContent?: SlotComponentProps<'span', {}, PickerOwnerState>;
}
export interface PickersSectionElement {
  container: React.HTMLAttributes<HTMLSpanElement>;
  content: React.HTMLAttributes<HTMLSpanElement> & {
    'data-range-position': string | undefined;
  };
  before: React.HTMLAttributes<HTMLSpanElement>;
  after: React.HTMLAttributes<HTMLSpanElement>;
}
export interface PickersSectionListRef extends Omit<UseFieldDOMGetters, 'isReady'> {}
export interface ExportedPickersSectionListProps extends Pick<React.HTMLAttributes<HTMLDivElement>, 'tabIndex'> {
  /**
   * The elements to render.
   * Each element contains the prop to edit a section of the value.
   */
  elements: PickersSectionElement[];
  /**
   * The ref used to access the DOM elements of the sections.
   */
  sectionListRef: React.Ref<PickersSectionListRef>;
  /**
   * If true, the whole element is editable.
   * Useful when all the sections are selected.
   */
  contentEditable: boolean;
}
export interface PickersSectionListProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'contentEditable'>, ExportedPickersSectionListProps {
  /**
   * Overridable component slots.
   */
  slots?: PickersSectionListSlots;
  /**
   * The props used for each component slot.
   */
  slotProps?: PickersSectionListSlotProps;
  /**
   * Override or extend the styles applied to the component.
   */
  classes?: Partial<PickersSectionListClasses>;
}