@sima-land/ui-nucleons 45.0.0-alpha.5 → 45.0.0-alpha.50

package/carousel/index.d.ts

@@ -1,311 +0,0 @@
-import { Component } from 'react';
-import { Control } from './draggable';
-import { IPoint } from '../helpers/point';
-import { ArrowButtonProps } from '../arrow-button';
-import { DraggableEvent } from './helpers/draggable-event';
-export interface CarouselProps {
-    /** Список элементов. */
-    items?: any[];
-    /** На сколько элементов прокручивать за раз. */
-    step?: number;
-    /** Можно ли перетаскивать мышью. */
-    draggable?: boolean | 'auto';
-    /** Активирует бесконечную прокрутку. */
-    infinite?: boolean;
-    /** Вертикальный режим. */
-    vertical?: boolean;
-    /** Включена ли автоматическая прокрутка. */
-    autoplay?: boolean;
-    /** Таймаут автоматической прокрутки. */
-    autoplayTimeout?: number;
-    /** Нужно ли останавливать авто-прокрутку при наведении мыши. */
-    autoplayHoverPause?: boolean;
-    /** Показывать ли кнопки. */
-    withControls?: boolean;
-    /** Индекс элемента к которому нужно прокрутиться. */
-    targetIndex?: number;
-    /** Сработает при монтировании. */
-    onReady?: (currentIndex: number) => void;
-    /** Вернет содержимое элемента. */
-    renderItem?: typeof Carousel.defaultRenderItem;
-    /** Вернет содержимое кнопки. */
-    renderControl?: typeof Carousel.defaultRenderControl;
-    /** Сработает при смене индекса текущего элемента. */
-    onChangeTargetIndex?: (newIndex: number) => void;
-    /** Свойства контейнера. */
-    containerProps?: React.HTMLAttributes<HTMLDivElement>;
-    /** Свойства элемента, формирующего viewport карусели. */
-    viewportElementProps?: React.HTMLAttributes<HTMLDivElement>;
-    /** Свойства кнопок. */
-    controlProps?: ArrowButtonProps;
-}
-interface State {
-    currentOffset: number;
-    isAllItemsVisible: boolean;
-}
-interface ControlData {
-    canUse: boolean;
-    onUse: () => void;
-    type: 'forward' | 'backward';
-    vertical?: boolean;
-}
-interface ElementPredicate {
-    (sibling: Element): boolean;
-}
-/**
- * Карусель.
- */
-export declare class Carousel extends Component<CarouselProps, State> {
-    infinite: boolean;
-    dragStartClient: IPoint;
-    dragStartOffset: IPoint;
-    currentIndex: number;
-    containerRef: React.RefObject<HTMLDivElement>;
-    rootElementRef: React.RefObject<HTMLDivElement>;
-    wrapperRef: React.RefObject<HTMLDivElement>;
-    timerId?: number;
-    canAutoMove?: boolean;
-    mounted?: boolean;
-    offWindowResize: () => void;
-    toggleDragTransition: Control['toggleTransition'];
-    setDragOffset: Control['setOffset'];
-    isGrabbed: Control['isGrabbed'];
-    isTransitionEnabled: Control['isTransitionEnabled'];
-    /**
-     * Конструктор.
-     * @param props Свойства.
-     */
-    constructor(props: CarouselProps);
-    /**
-     * Возвращает элемент списка.
-     * @param item Элемент списка.
-     * @param index Индекс.
-     * @return Элемент списка.
-     */
-    static defaultRenderItem(item: any, index: number): JSX.Element;
-    /**
-     * Возвращает кнопку управления.
-     * @param data Данные для вывода кнопки.
-     * @param data.canUse Можно ли использовать кнопку.
-     * @param data.onUse Выполнится при нажатии на кнопку.
-     * @param props Свойства ArrowButton.
-     * @return Кнопка управления.
-     */
-    static defaultRenderControl({ canUse, onUse, type, vertical }: ControlData, props?: ArrowButtonProps): JSX.Element;
-    /**
-     * Возвращает функцию для поиска наиболее отдаленного элемента карусели от стартовой границы viewport'а.
-     * @param data Данные.
-     * @param data.viewport Область видимости галереи.
-     * @param data.vertical Показывает, что прокрутка выполняется по вертикали.
-     * @return Функция для поиска наиболее отдаленного элемента.
-     */
-    static makeFurthestSiblingChecker({ vertical, viewport, }: {
-        vertical: boolean;
-        viewport?: DOMRect | null;
-    }): ElementPredicate;
-    /**
-     * Возвращает функцию для поиска наиболее близкого элемента карусели к viewport'у.
-     * @param data Данные.
-     * @param data.viewport Область видимости галереи.
-     * @param data.vertical Показывает, что прокрутка выполняется по вертикали.
-     * @param data.backward Показывает, что прокрутка выполняется к началу списка.
-     * @return Функция для поиска наиболее близкого элемента.
-     */
-    static makeNearestSiblingChecker({ viewport, vertical, backward, }: {
-        backward: boolean;
-        vertical: boolean;
-        viewport?: DOMRect | null;
-    }): ElementPredicate;
-    /**
-     * Геттер элемента списка.
-     * @return Элемент списка или null.
-     */
-    get listElement(): HTMLDivElement | null;
-    /**
-     * Выполняет подписку на глобальное событие "resize".
-     * Запускает прокрутку до текущего элемента.
-     * Обновляет информацию о состоянии отображения элементов.
-     */
-    componentDidMount(): void;
-    /**
-     * Подписывается на изменение размера корневого элемента.
-     * @param Observer Класс ResizeObserver.
-     */
-    observeResize(Observer?: typeof ResizeObserver): void;
-    /**
-     * Корректирует смещение при изменении размеров.
-     */
-    handleResize(): void;
-    /**
-     * По необходимости обновляет индекс текущего элемента.
-     * Обновляет информацию о состоянии отображения элементов.
-     * @param prevProps Предыдущие свойства.
-     */
-    componentDidUpdate(prevProps: CarouselProps): void;
-    /**
-     * Выполняет отписку от глобального события "resize".
-     * Отключает таймер автоматической прокрутки.
-     */
-    componentWillUnmount(): void;
-    /**
-     * Включает автоматическую прокрутку.
-     */
-    enableAutoplay(): void;
-    /**
-     * Отключает автоматическую прокрутку.
-     */
-    disableAutoplay(): void;
-    /**
-     * Переключает флаг возможности автоматической прокрутки.
-     * @param canAutoMove Флаг возможности автоматической прокрутки.
-     */
-    toggleAutoMove(canAutoMove: boolean): void;
-    /**
-     * Переключает флаг, определяющий, что компонент смонтирован.
-     * @param mounted Флаг.
-     */
-    toggleMounted(mounted: boolean): void;
-    /**
-     * Определяет, можно ли перетаскивать карусель.
-     * @return Можно ли перетаскивать карусель?
-     */
-    canDrag(): boolean;
-    /**
-     * Обновляет информацию о состоянии отображения элементов.
-     */
-    updateItemsVisibility(): void;
-    /**
-     * По возможности выполняет прокрутку карусели вперед.
-     */
-    moveForward(): void;
-    /**
-     * Выполняет конечную прокрутку карусели вперед.
-     * @param step На сколько элементов надо прокрутить карусель.
-     */
-    moveForwardFinite(step: number): void;
-    /**
-     * По возможности выполняет прокрутку карусели назад.
-     */
-    moveBackward(): void;
-    /**
-     * Выполняет конечную прокрутку карусели назад.
-     * @param step На сколько элементов надо прокрутить карусель.
-     */
-    moveBackwardFinite(step: number): void;
-    /**
-     * Выполняет прокрутку в бесконечном режиме.
-     * @param step Количество элементов для прокрутки.
-     * @param forward Нужно выполнить прокрутку вперед?
-     */
-    moveInfinite(step: number, forward: boolean): void;
-    /**
-     * Сохраняет смещение элементов карусели и позицию при захвате мышкой.
-     * Отключает плавную прокрутку.
-     * @param dragEvent Событие.
-     */
-    onDragStart(dragEvent: DraggableEvent): void;
-    /**
-     * При необходимости запускает корректировку смещения.
-     * @param dragEvent Событие.
-     */
-    onDragMove(dragEvent: DraggableEvent): void;
-    /**
-     * Корректирует смещение в бесконечном режиме.
-     * @param dragEvent Событие.
-     */
-    correctInfiniteOffset(dragEvent: DraggableEvent): void;
-    /**
-     * Определяет начальную границу (левую или верхнюю) списка не клонированных элементов.
-     * @return Начальную граница.
-     */
-    findRealItemsStartBound(): number;
-    /**
-     * Выполняет прокрутку к элементу, который наиболее близок к стартовой границе viewport'а.
-     * @param dragEvent Событие.
-     */
-    onDragEnd({ offset: endOffset, client: endClient }: DraggableEvent): void;
-    /**
-     * Определяет информацию о направлении между двумя точками.
-     * @param start Точка.
-     * @param end Точка.
-     * @return Информация.
-     */
-    defineDirection(start: IPoint, end: IPoint): {
-        forward: boolean;
-        backward: boolean;
-    };
-    /**
-     * Устанавливает индекс элемента к которому прокручена карусель.
-     * @param newIndex Индекс элемента к которому прокручена карусель.
-     * @param options Опции.
-     * @param options.withScroll Нужна ли прокрутка.
-     * @param options.needTransition Нужна ли анимация при прокрутке.
-     */
-    setCurrentIndex(newIndex: number, { withScroll, needTransition }?: {
-        withScroll?: boolean | undefined;
-        needTransition?: boolean | undefined;
-    }): void;
-    /**
-     * Прокручивает галерею к заданному элементу по индексу.
-     * @param options Свойства.
-     * @param options.targetIndex Индекс.
-     * @param options.needTransition Нужна ли плавная анимация прокрутки.
-     */
-    scrollToItem({ targetIndex, needTransition }?: {
-        targetIndex?: number | undefined;
-        needTransition?: boolean | undefined;
-    }): void;
-    /**
-     * Определяет, видны ли все элементы галереи.
-     * @return Видны ли все элементы галереи.
-     */
-    isAllItemsVisible(): boolean;
-    /**
-     * Определяет минимально возможное смещение списка элементов карусели.
-     * @return Минимально возможное смещение.
-     */
-    defineMinOffset(): number;
-    /**
-     * Возвращает длину/ширину списка элементов (в зависимости от ориентации карусели).
-     * @return Длина/ширина списка элементов.
-     */
-    getRealItemsSize(): number;
-    /**
-     * Возвращает длину/ширину области видимости карусели (в зависимости от ориентации).
-     * @return Длина/ширина области видимости.
-     */
-    getViewportSize(): number;
-    /**
-     * Возвращает данные прямоугольной области видимости карусели.
-     * @return Данные прямоугольной области видимости карусели.
-     */
-    getViewport(): DOMRect | null;
-    /**
-     * Сохраняет смещение карусели и позицию из события при старте захвата.
-     * @param dragEvent Нестандартное событие из компонента Draggable.
-     * @param dragEvent.offset Смещение.
-     * @param dragEvent.client Позиция.
-     */
-    saveDragStartData({ offset, client }: DraggableEvent): void;
-    /**
-     * Сохраняет в состоянии смещение карусели.
-     * @param newOffset Смещение.
-     * @param options Опции.
-     */
-    setCurrentOffset(newOffset: number, { withStateUpdate }?: {
-        withStateUpdate?: boolean | undefined;
-    }): void;
-    /**
-     * Получает управление от Draggable.
-     * @param control Функции управления Draggable.
-     */
-    takeDragControl(control: Control): void;
-    /** @inheritdoc */
-    render(): JSX.Element;
-    /**
-     * Формирует список элементов карусели с учетом необходимости клонирования.
-     * @return Список элементов карусели.
-     */
-    renderItems(): JSX.Element[];
-}
-export {};