@yandex/ui/Slider/Slider.d.ts

Yandex UI components

import React from 'react';
import { RenderOverride } from '../lib/render-override';
import { SliderThumbProps } from './Thumb/Slider-Thumb';
import { SliderTickLabelProps } from './TickLabel/Slider-TickLabel';
import './Slider.css';
export declare type SliderProps = {
    /**
     * Выбранные значения на слайдере
     */
    value: number[];
    /**
     * Дополнительный класс у корневого DOM-элемента
     */
    className?: string;
    /**
     * Неактивное состояние слайдера
     *
     * @default false
     */
    disabled?: boolean;
    /**
     * Минимальное число, которое можно выбрать на слайдере
     *
     * Может быть как положительным, так и отрицательным числом
     *
     * @default 0
     */
    min?: number;
    /**
     * Максимальное число, которое можно выбрать на слайдере
     *
     * Должен быть только положительным числом
     *
     * @default 100
     */
    max?: number;
    /**
     * Шаг, который делает бегунок за одно обновление
     *
     * Должен быть больше 0 и делиться на (max - min)
     *
     * @default 1
     */
    step?: number;
    /**
     * Отображает индикатор выбранного диапазона
     *
     * @default false
     */
    filled?: boolean;
    /**
     * Отображает слайдер в противоположном направлении
     *
     * @default false
     */
    reverse?: boolean;
    /**
     * Устанавливает слайдер в вертикальную ориентацию
     *
     * @default false
     */
    vertical?: boolean;
    /**
     * Обработчик, который вызывается при каждом обновлении бегунка
     */
    onInput: (event: any, value: number[]) => void;
    /**
     * Обработчик, который вызывается при окончательном выборе значения
     */
    onChange?: (event: any, value: number[]) => void;
    /**
     * Переопределяет компонент `SliderThumb`
     */
    renderThumb?: RenderOverride<SliderThumbProps>;
    /**
     * Переопределяет компонент `SliderTickLabel`
     *
     * @default $renderTickLabel
     */
    renderTickLabel?: RenderOverride<SliderTickLabelProps>;
    /**
     * Показывает метки на треке
     *
     * @default false
     */
    showTicks?: boolean;
    /**
     * Отображает значения на метках трека
     *
     * По умолчанию показывает только минимальное и максимальное значения
     *
     * @default false
     */
    showTickValues?: boolean;
    /**
     * Идентификатор, используемый в тестах
     *
     * @example
     *
     * {testId}-host
     */
    testId?: string;
};
/**
 * Компонент, позволяющий выбрать одно или два значения в пределах заданного диапазона.
 *
 * @param {SliderProps} props - Свойства компонента.
 */
export declare const Slider: React.ForwardRefExoticComponent<SliderProps & React.RefAttributes<HTMLDivElement>>;