rc-slider

  • Version 10.5.0
  • Published
  • 151 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

variable Slider

const Slider: React.ForwardRefExoticComponent<any>;

    Interfaces

    interface SliderProps

    interface SliderProps<ValueType = number | number[]> {}
    • New: - click mark to update range value - handleRender - Fix handle with count not correct - Fix pushable not work in some case - No more FindDOMNode - Move all position related style into inline style - Key: up is plus, down is minus - fix Key with step = null not align with marks - Change range should not trigger onChange - keyboard support pushable

    property activeDotStyle

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

      property allowCross

      allowCross?: boolean;

        property ariaLabelForHandle

        ariaLabelForHandle?: string | string[];

          property ariaLabelledByForHandle

          ariaLabelledByForHandle?: string | string[];

            property ariaValueTextFormatterForHandle

            ariaValueTextFormatterForHandle?: AriaValueFormat | AriaValueFormat[];

              property autoFocus

              autoFocus?: boolean;

                property className

                className?: string;

                  property classNames

                  classNames?: SliderClassNames;

                    property count

                    count?: number;

                      property defaultValue

                      defaultValue?: ValueType;

                        property disabled

                        disabled?: boolean;

                          property dots

                          dots?: boolean;

                            property dotStyle

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

                              property draggableTrack

                              draggableTrack?: boolean;
                              • range only

                              property handleRender

                              handleRender?: HandlesProps['handleRender'];

                                property handleStyle

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

                                  Please use styles.handle instead

                                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;

                                                        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 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 (2)

                                                                              Dependencies (3)

                                                                              Dev Dependencies (24)

                                                                              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>