@skbkontur/react-ui 6.1.7-c386f.0 → 6.1.7

package/components/TimePicker/TimePicker.d.ts

@@ -1,153 +0,0 @@
-import type { AriaAttributes, HTMLAttributes, ReactNode } from 'react';
-import React from 'react';
-import type { CommonProps } from '../../internal/CommonWrapper/index.js';
-import type { SizeProp } from '../../lib/types/props.js';
-import { type NoInfer } from '../../lib/utils.js';
-import type { MenuItemState } from '../MenuItem/index.js';
-import { type TimeFormat, type TimeItemValue, type TimePickerSource, type TimePickerValue, type TimePickerValueToItem } from './helpers/TimePicker.shared.js';
-import { validateTimePicker } from './helpers/validateTimePicker.js';
-export interface TimePickerProps<T extends TimeItemValue = string> extends CommonProps, Pick<AriaAttributes, 'aria-describedby' | 'aria-label'>, Pick<HTMLAttributes<HTMLElement>, 'id'> {
-    /** Устанавливает формат времени @default HH:mm */
-    format?: TimeFormat;
-    /** Задает источник элементов выпадающего списка.
-     * Можно передать массив или функцию, которая получает текущий запрос и возвращает массив либо Promise с массивом.
-     * Запрос — это введенные цифры сегментов с сохранением их позиций: `12`, `12:3`, а если заполнены только минуты — `:30`.
-     * Элемент задается строкой со временем — `'09:00'` — или объектом `{ value, label?, disabled? }`
-     * с любыми дополнительными полями. Выбранный элемент приходит в `onValueChange` в той же форме.
-     * Кроме значений времени можно передать React-элементы или функции, возвращающие React-элемент:
-     * например, `MenuHeader`, `MenuFooter`, `MenuSeparator` или `MenuItem`.
-     * Такие элементы отображаются в меню, но не участвуют в фильтрации и выборе значения.
-     * Полученные элементы всегда фильтруются компонентом одинаково для массива и функции:
-     * введенные цифры сегмента сравниваются с началом соответствующего сегмента элемента.
-     * В выпадающем списке не может быть двух элементов с одинаковым временем:
-     * из элементов с одинаковым временем компонент оставляет первый.
-     * Пустые элементы из условного рендера — `isVisible && item` — пропускаются.
-     * Пока Promise не разрешился и предыдущих результатов нет, в выпадающем меню показывается спиннер загрузки.
-     * Если предыдущие результаты есть, подходящие элементы остаются видимыми до прихода новых,
-     * а индикация загрузки показывается в правой иконке поля.
-     * Замена функции не перезапрашивает уже открытый список: актуальная функция используется при следующем запросе. */
-    source?: TimePickerSource<T>;
-    /** Отрисовывает значение времени в выпадающем списке. Не применяется к React-элементам из `source`. */
-    renderItem?: (item: T, state: MenuItemState) => ReactNode;
-    /** Задает нижнюю границу времени. Элементы за границей становятся заблокированными. */
-    minTime?: string;
-    /** Задает верхнюю границу времени. Элементы за границей становятся заблокированными. */
-    maxTime?: string;
-    /** Задает значение поля: элемент того же типа, что в `source`, либо строку в формате `HH:mm[:ss]`.
-     * Из элемента-объекта используется только время `value`, `label` в поле не отображается.
-     * Пустое значение можно передать как `''` или `null`.
-     * Если проп не задан, компонент неконтролируемый: он хранит значение сам и сообщает о нем через `onValueChange`. */
-    value?: TimePickerValue<T>;
-    /** Преобразует время в элемент.
-     * Применяется ко временам, которые пользователь не выбрал из `source`:
-     * ручной ввод, изменение стрелками, вставка из буфера, нативный пикер.
-     * По умолчанию компонент повторяет форму элементов `source` и `value`:
-     * для строк отдает строку, для объектов — `{ value }`.
-     * Форму элементов функции-источника компонент узнает только после первого ответа,
-     * поэтому до него — и всегда в режиме нативного пикера — время без этого пропа уходит строкой.
-     * Задавайте этот проп, если элементы содержат поля, кроме `value`, `label` и `disabled`.
-     * @default (value) => value | ({ value }) */
-    valueToItem?: TimePickerValueToItem<T>;
-    /** Устанавливает фокус на поле ввода после окончания загрузки страницы @default false */
-    autoFocus?: boolean;
-    /** Делает компонент заблокированным. */
-    disabled?: boolean;
-    /** Переводит контрол в состояние валидации ошибки. */
-    error?: boolean;
-    /** Переводит контрол в состояние валидации предупреждения. */
-    warning?: boolean;
-    /** Включает нативный системный выбор времени на мобильных устройствах. */
-    useMobileNativeTimePicker?: boolean;
-    /** Расположение выпадающего меню. */
-    menuPos?: 'top' | 'bottom';
-    /** Выравнивание выпадающего меню. */
-    menuAlign?: 'left' | 'right';
-    /** Ширина выпадающего меню. По умолчанию — минимальная ширина поля ввода, расширяется по контенту. */
-    menuWidth?: string | number;
-    /** Задает ширину поля. */
-    width?: string | number;
-    /** Переопределяет иконку или скрывает, если передать `null`.
-     * Пока элементы уже показаны, а новый запрос к функции-источнику еще выполняется,
-     * вместо иконки показывается индикатор загрузки. */
-    rightIcon?: React.ReactNode | (() => React.ReactNode);
-    /** Устанавливает суффикс после значения и перед иконкой. */
-    suffix?: ReactNode;
-    /** Размер поля ввода и выпадающего меню. */
-    size?: SizeProp;
-    /** Устанавливает радиус скруглений углов.
-     * @ignore */
-    corners?: Partial<Pick<React.CSSProperties, 'borderTopRightRadius' | 'borderBottomRightRadius' | 'borderBottomLeftRadius' | 'borderTopLeftRadius'>>;
-    /** Задает функцию, которая вызывается при нажатии на контрол. */
-    onClick?(event: React.MouseEvent<HTMLElement>): void;
-    /**
-     * Событие изменения значения `value`.
-     * Вызывается при коммите значения: потере фокуса, нажатии Enter, выборе элемента из списка
-     * или изменении в нативном пикере.
-     * Первым аргументом приходит элемент в той же форме, в которой элементы переданы в `source`:
-     * при выборе из выпадающего списка — тот же элемент, в остальных случаях — результат `valueToItem`,
-     * а при пустом значении — `null`.
-     * Вторым аргументом приходит полностью нормализованное время в формате `HH:mm[:ss]` или пустая строка.
-     * Тип элемента выводится из `source` и `value`, но не из этого обработчика,
-     * иначе `onValueChange={setItem}` сузил бы его до `TimeItem`.
-     */
-    onValueChange?(item: NoInfer<T> | null, value: string): void;
-    /**
-     * Событие изменения значения в процессе ввода.
-     * Значение частично нормализуется по сегментам, например `1` => `01`, незаполненный хвост отбрасывается.
-     * Промежуточное значение может не соответствовать полной форме `HH:mm[:ss]`, поэтому тип — произвольная строка.
-     */
-    onInputValueChange?(value: string): void;
-    /**
-     * Событие некорректного ввода: пользователь ввел или вставил значение, которое не может быть временем.
-     * Вызывается с нажатой клавишей — например `а` или `,` — либо со значением из буфера,
-     * из которого не получилось собрать время.
-     * Значение вне диапазона `minTime`/`maxTime` некорректным вводом не считается,
-     * его можно проверить через `TimePicker.validate`.
-     * Вторым аргументом передается метод вспыхивания рамки поля.
-     * Если обработчик не задан, поле вспыхивает само.
-     * Обработчик может подставить значение вместо некорректного ввода — например разобрать вставку
-     * в собственном формате: возвращенный элемент коммитится и приходит в `onValueChange`,
-     * `null` очищает поле, а `undefined` оставляет значение прежним.
-     */
-    onUnexpectedInput?(value: string, blink: () => void): void | NoInfer<T> | null;
-    /** Событие потери фокуса. */
-    onBlur?(event: React.FocusEvent<HTMLElement>): void;
-    /** Событие получения фокуса. */
-    onFocus?(event: React.FocusEvent<HTMLElement>): void;
-    /** Событие нажатия клавиши. */
-    onKeyDown?(event: React.KeyboardEvent<HTMLElement>): void;
-    /** Событие вставки из буфера. */
-    onPaste?(event: React.ClipboardEvent<HTMLElement>): void;
-}
-export interface TimePickerRef {
-    /** Устанавливает фокус на поле ввода.
-     * С опцией `withoutOpenDropdown` фокус не открывает выпадающее меню. */
-    focus(options?: {
-        withoutOpenDropdown?: boolean;
-    }): void;
-    /** Снимает фокус с поля ввода. */
-    blur(): void;
-    /** Открывает выпадающее меню, установив фокус на поле.
-     * В режиме нативного пикера открывает системный пикер. */
-    open(): void;
-    /** Закрывает выпадающее меню. */
-    close(): void;
-    /** Запускает анимацию blink у поля ввода времени. */
-    blink(): void;
-    /** Возвращает корневой DOM-узел компонента. */
-    getRootNode(): HTMLElement | null;
-}
-export type TimePicker = TimePickerRef;
-interface TimePickerComponent {
-    <T extends TimeItemValue = string>(props: TimePickerProps<T> & React.RefAttributes<TimePickerRef>): React.ReactElement | null;
-    displayName?: string;
-    __KONTUR_REACT_UI__: string;
-    /** Проверяет, что значение полностью заполнено, соответствует формату и попадает в диапазон `minTime`/`maxTime`. */
-    validate: typeof validateTimePicker;
-}
-/** Поле с временем помогает пользователю быстро и удобно указать время в правильном формате.
- * В поле можно ввести время с клавиатуры либо выбрать из выпадающего списка,
- * передав массив или функцию в проп `source`.
- */
-export declare const TimePicker: TimePickerComponent;
-export {};