@gluestack-ui/slider/lib/types.d.ts

A universal headless slider component for React Native, Next.js & React

export interface InterfaceSliderProps {
    /** The current value of the Slider */
    value?: number;
    /** The default value (uncontrolled). */
    defaultValue?: number;
    /** Handler that is called when the value changes. */
    onChange?: (value: number) => void;
    children?: any;
    /**
     * If true, the value will be incremented or decremented in reverse.
     */
    isReversed?: boolean;
    /**
     * The orientation of the Slider.
     * @default 'horizontal'
     */
    orientation?: 'horizontal' | 'vertical';
    /** Whether the whole Slider is disabled. */
    isDisabled?: boolean;
    /** Fired when the slider stops moving, due to being let go. */
    onChangeEnd?: (value: number) => void;
    /**
     * The slider's minimum value.
     * @default 0
     */
    minValue?: number;
    /**
     * The slider's maximum value.
     * @default 100
     */
    maxValue?: number;
    /**
     * The slider's step value.
     * @default 1
     */
    step?: number;
    /** Whether the whole Slider is readonly. */
    isReadOnly?: boolean;
    /** Prop applied to change slider track height */
    sliderTrackHeight?: (string & {}) | number;
    /**Prop applied to change size of slider thumb */
    thumbSize?: (string & {}) | number;
    isHovered?: boolean;
    isFocused?: boolean;
    isFocusVisible?: boolean;
    isPressed?: boolean;
}
export interface ISliderTrackProps {
    /** Whether the whole Slider is readonly. */
    isReadOnly?: boolean;
    children?: any;
}
export interface ISliderTrackFilledProps {
    /** Whether the whole Slider is readonly. */
    isReadOnly?: boolean;
}
export interface ISliderThumbProps {
    /**
     * The orientation of the Slider.
     * @default 'horizontal'
     */
    orientation?: 'horizontal' | 'vertical';
    /** Whether the Thumb is disabled. */
    isDisabled?: boolean;
    /** Whether the whole Slider is readonly. */
    isReadOnly?: boolean;
    onFocus?: (e: any) => void;
    onBlur?: (e: any) => void;
    scaleOnPressed?: any;
}
export type ISliderComponentType<StyledSlider, StyledSliderThumb, StyledSliderTrack, StyledSliderFilledTrack> = React.ForwardRefExoticComponent<InnerForwardRefExoticComponent<StyledSlider> & ISliderProps> & {
    Thumb: React.ForwardRefExoticComponent<InnerForwardRefExoticComponent<StyledSliderThumb> & ISliderThumbProps>;
    Track: React.ForwardRefExoticComponent<InnerForwardRefExoticComponent<StyledSliderTrack> & ISliderTrackProps>;
    FilledTrack: React.ForwardRefExoticComponent<InnerForwardRefExoticComponent<StyledSliderFilledTrack> & ISliderTrackFilledProps>;
};
export type ISliderProps = InterfaceSliderProps;
type InnerForwardRefExoticComponent<T> = React.PropsWithoutRef<T> & React.RefAttributes<T>;
export {};