Back to Fluentui

React Slider.Api

packages/react-components/react-slider/library/etc/react-slider.api.md

4.40.2-hotfix22.4 KB
Original Source

API Report File for "@fluentui/react-slider"

Do not edit this file. It is a report generated by API Extractor.

ts

import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { JSXElement } from '@fluentui/react-utilities';
import * as React_2 from 'react';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public
export const renderSlider_unstable: (state: SliderState) => JSXElement;

// @public
export const Slider: ForwardRefComponent<SliderProps>;

// @public (undocumented)
export const sliderClassNames: SlotClassNames<SliderSlots>;

// @public (undocumented)
export const sliderCSSVars: {
    sliderDirectionVar: string;
    sliderInnerThumbRadiusVar: string;
    sliderProgressVar: string;
    sliderProgressColorVar: string;
    sliderRailSizeVar: string;
    sliderRailColorVar: string;
    sliderStepsPercentVar: string;
    sliderThumbColorVar: string;
    sliderThumbSizeVar: string;
};

// @public (undocumented)
export type SliderOnChangeData = {
    value: number;
};

// @public (undocumented)
export type SliderProps = Omit<ComponentProps<Partial<SliderSlots>, 'input'>, 'defaultValue' | 'onChange' | 'size' | 'value'> & {
    defaultValue?: number;
    disabled?: boolean;
    max?: number;
    min?: number;
    size?: 'small' | 'medium';
    step?: number;
    value?: number;
    vertical?: boolean;
    onChange?: (ev: React_2.ChangeEvent<HTMLInputElement>, data: SliderOnChangeData) => void;
};

// @public (undocumented)
export type SliderSlots = {
    root: NonNullable<Slot<'div'>>;
    rail: NonNullable<Slot<'div'>>;
    thumb: NonNullable<Slot<'div'>>;
    input: NonNullable<Slot<'input'>> & {
        orient?: 'horizontal' | 'vertical';
    };
};

// @public (undocumented)
export type SliderState = ComponentState<SliderSlots> & Pick<SliderProps, 'disabled' | 'size' | 'vertical'>;

// @public (undocumented)
export const useSlider_unstable: (props: SliderProps, ref: React_2.Ref<HTMLInputElement>) => SliderState;

// @public (undocumented)
export const useSliderState_unstable: (state: SliderState, props: SliderProps) => SliderState;

// @public
export const useSliderStyles_unstable: (state: SliderState) => SliderState;

// (No @packageDocumentation comment for this package)