Logo for jsDocs.io

rc-slider

  • Version 11.1.9
  • Published
  • 173 kB
  • 3 dependencies
  • MIT license

Install

npm i rc-slider
yarn add rc-slider
pnpm add rc-slider

Overview

Slider UI component for React

Index

Variables

Interfaces

Variables

variable Slider

const Slider: React.ForwardRefExoticComponent<any>;

    variable UnstableContext

    const UnstableContext: React.Context<UnstableContextProps>;

    • NOT PROMISE AVAILABLE. DO NOT USE IN PRODUCTION.

    Interfaces

    interface SliderProps

    interface SliderProps<ValueType = number | number[]> {}

      property activeDotStyle

      activeDotStyle?:
          | React.CSSProperties
          | ((dotValue: number) => React.CSSProperties);

        property activeHandleRender

        activeHandleRender?: HandlesProps['handleRender'];

          property allowCross

          allowCross?: boolean;

            property ariaLabelForHandle

            ariaLabelForHandle?: string | string[];

              property ariaLabelledByForHandle

              ariaLabelledByForHandle?: string | string[];

                property ariaRequired

                ariaRequired?: boolean;

                  property ariaValueTextFormatterForHandle

                  ariaValueTextFormatterForHandle?: AriaValueFormat | AriaValueFormat[];

                    property autoFocus

                    autoFocus?: boolean;

                      property className

                      className?: string;

                        property classNames

                        classNames?: SliderClassNames;

                          property count

                          count?: number;

                          • Deprecated

                            Use range.minCount or range.maxCount to handle this

                          property defaultValue

                          defaultValue?: ValueType;

                            property disabled

                            disabled?: boolean;

                              property dots

                              dots?: boolean;

                                property dotStyle

                                dotStyle?: React.CSSProperties | ((dotValue: number) => React.CSSProperties);

                                  property handleRender

                                  handleRender?: HandlesProps['handleRender'];

                                    property handleStyle

                                    handleStyle?: React.CSSProperties | React.CSSProperties[];

                                    • Deprecated

                                      Please use styles.handle instead

                                    property id

                                    id?: string;

                                      property included

                                      included?: boolean;

                                        property keyboard

                                        keyboard?: boolean;

                                          property marks

                                          marks?: Record<string | number, React.ReactNode | MarkObj>;

                                            property max

                                            max?: number;

                                              property min

                                              min?: number;

                                                property onAfterChange

                                                onAfterChange?: (value: ValueType) => void;

                                                • Deprecated

                                                  Use onChangeComplete instead

                                                property onBeforeChange

                                                onBeforeChange?: (value: ValueType) => void;

                                                • Deprecated

                                                  It's always better to use onChange instead

                                                property onBlur

                                                onBlur?: (e: React.FocusEvent<HTMLDivElement>) => void;

                                                  property onChange

                                                  onChange?: (value: ValueType) => void;

                                                    property onChangeComplete

                                                    onChangeComplete?: (value: ValueType) => void;

                                                      property onFocus

                                                      onFocus?: (e: React.FocusEvent<HTMLDivElement>) => void;

                                                        property prefixCls

                                                        prefixCls?: string;

                                                          property pushable

                                                          pushable?: boolean | number;

                                                            property railStyle

                                                            railStyle?: React.CSSProperties;

                                                            • Deprecated

                                                              Please use styles.rail instead

                                                            property range

                                                            range?: boolean | RangeConfig;

                                                              property reverse

                                                              reverse?: boolean;

                                                                property startPoint

                                                                startPoint?: number;

                                                                  property step

                                                                  step?: number | null;

                                                                    property style

                                                                    style?: React.CSSProperties;

                                                                      property styles

                                                                      styles?: SliderStyles;

                                                                        property tabIndex

                                                                        tabIndex?: number | number[];

                                                                          property track

                                                                          track?: boolean;

                                                                            property trackStyle

                                                                            trackStyle?: React.CSSProperties | React.CSSProperties[];

                                                                            • Deprecated

                                                                              Please use styles.track instead

                                                                            property value

                                                                            value?: ValueType;

                                                                              property vertical

                                                                              vertical?: boolean;

                                                                                interface SliderRef

                                                                                interface SliderRef {}

                                                                                  property blur

                                                                                  blur: () => void;

                                                                                    property focus

                                                                                    focus: () => void;

                                                                                      Package Files (3)

                                                                                      Dependencies (3)

                                                                                      Dev Dependencies (27)

                                                                                      Peer Dependencies (2)

                                                                                      Badge

                                                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/rc-slider.

                                                                                      • Markdown
                                                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/rc-slider)
                                                                                      • HTML
                                                                                        <a href="https://www.jsdocs.io/package/rc-slider"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>