stupa-pdf-api/frontend/node_modules/@mui/x-date-pickers/models/fields.d.ts

import * as React from 'react';
import type { BaseFieldProps } from '../internals/models/fields';
export type FieldSectionType = 'year' | 'month' | 'day' | 'weekDay' | 'hours' | 'minutes' | 'seconds' | 'meridiem';
export type FieldSectionContentType = 'digit' | 'digit-with-letter' | 'letter';
export type FieldValueType = 'date' | 'time' | 'date-time';
export interface FieldSection {
    /**
     * Value of the section, as rendered inside the input.
     * For example, in the date `May 25, 1995`, the value of the month section is "May".
     */
    value: string;
    /**
     * Format token used to parse the value of this section from the date object.
     * For example, in the format `MMMM D, YYYY`, the format of the month section is "MMMM".
     */
    format: string;
    /**
     * Maximum length of the value, only defined for "digit" sections.
     * Will be used to determine how many leading zeros should be added to the value.
     */
    maxLength: number | null;
    /**
     * Placeholder rendered when the value of this section is empty.
     */
    placeholder: string;
    /**
     * Type of the section.
     */
    type: FieldSectionType;
    /**
     * Type of content of the section.
     * Will determine if we should apply a digit-based editing or a letter-based editing.
     */
    contentType: FieldSectionContentType;
    /**
     * If `true`, the value of this section is supposed to have leading zeroes when parsed by the date library.
     * For example, the value `1` should be rendered as "01" instead of "1".
     * @deprecated Will be removed in v7, use `hasLeadingZerosInFormat` instead.
     */
    hasLeadingZeros: boolean;
    /**
     * If `true`, the value of this section is supposed to have leading zeroes when parsed by the date library.
     * For example, the value `1` should be rendered as "01" instead of "1".
     */
    hasLeadingZerosInFormat: boolean;
    /**
     * If `true`, the value of this section is supposed to have leading zeroes when rendered in the input.
     * For example, the value `1` should be rendered as "01" instead of "1".
     */
    hasLeadingZerosInInput: boolean;
    /**
     * If `true`, the section value has been modified since the last time the sections were generated from a valid date.
     * When we can generate a valid date from the section, we don't directly pass it to `onChange`,
     * Otherwise, we would lose all the information contained in the original date, things like:
     * - time if the format does not contain it
     * - timezone / UTC
     *
     * To avoid losing that information, we transfer the values of the modified sections from the newly generated date to the original date.
     */
    modified: boolean;
    /**
     * Start index of the section in the format
     */
    start: number;
    /**
     * End index of the section in the format
     */
    end: number;
    /**
     * Start index of the section value in the input.
     * Takes into account invisible unicode characters such as \u2069 but does not include them
     */
    startInInput: number;
    /**
     * End index of the section value in the input.
     * Takes into account invisible unicode characters such as \u2069 but does not include them
     */
    endInInput: number;
    /**
     * Separator displayed before the value of the section in the input.
     * If it contains escaped characters, then it must not have the escaping characters.
     * For example, on Day.js, the `year` section of the format `YYYY [year]` has an end separator equal to `year` not `[year]`
     */
    startSeparator: string;
    /**
     * Separator displayed after the value of the section in the input.
     * If it contains escaped characters, then it must not have the escaping characters.
     * For example, on Day.js, the `year` section of the format `[year] YYYY` has a start separator equal to `[year]`
     */
    endSeparator: string;
}
export interface FieldRef<TSection extends FieldSection> {
    /**
     * Returns the sections of the current value.
     * @returns {TSection[]} The sections of the current value.
     */
    getSections: () => TSection[];
    /**
     * Returns the index of the active section (the first focused section).
     * If no section is active, returns `null`.
     * @returns {number | null} The index of the active section.
     */
    getActiveSectionIndex: () => number | null;
    /**
     * Updates the selected sections.
     * @param {FieldSelectedSections} selectedSections The sections to select.
     */
    setSelectedSections: (selectedSections: FieldSelectedSections) => void;
}
export type FieldSelectedSections = number | FieldSectionType | null | 'all' | {
    startIndex: number;
    endIndex: number;
};
/**
 * Props the single input field can receive when used inside a picker.
 * Only contains what the MUI component are passing to the field, not what users can pass using the `props.slotProps.field`.
 */
export interface BaseSingleInputFieldProps<TValue, TDate, TSection extends FieldSection, TError> extends BaseFieldProps<TValue, TDate, TSection, TError> {
    label?: React.ReactNode;
    id?: string;
    name?: string;
    inputRef?: React.Ref<HTMLInputElement>;
    onKeyDown?: React.KeyboardEventHandler;
    onBlur?: React.FocusEventHandler;
    focused?: boolean;
    InputProps?: {
        ref?: React.Ref<any>;
        endAdornment?: React.ReactNode;
        startAdornment?: React.ReactNode;
    };
    inputProps?: {
        'aria-label'?: string;
    };
    slots?: {};
    slotProps?: {};
    clearable?: boolean;
    onClear?: React.MouseEventHandler;
}