# rc-slider Slider UI component for React [![NPM version][npm-image]][npm-url] [![npm download][download-image]][download-url] [![build status][github-actions-image]][github-actions-url] [![Codecov][codecov-image]][codecov-url] [![bundle size][bundlephobia-image]][bundlephobia-url] [![dumi][dumi-image]][dumi-url] [npm-image]: http://img.shields.io/npm/v/rc-slider.svg?style=flat-square [npm-url]: http://npmjs.org/package/rc-slider [travis-image]: https://img.shields.io/travis/react-component/slider/master?style=flat-square [travis-url]: https://travis-ci.com/react-component/slider [github-actions-image]: https://github.com/react-component/slider/workflows/CI/badge.svg [github-actions-url]: https://github.com/react-component/slider/actions [codecov-image]: https://img.shields.io/codecov/c/github/react-component/slider/master.svg?style=flat-square [codecov-url]: https://app.codecov.io/gh/react-component/slider [david-url]: https://david-dm.org/react-component/slider [david-image]: https://david-dm.org/react-component/slider/status.svg?style=flat-square [david-dev-url]: https://david-dm.org/react-component/slider?type=dev [david-dev-image]: https://david-dm.org/react-component/slider/dev-status.svg?style=flat-square [download-image]: https://img.shields.io/npm/dm/rc-slider.svg?style=flat-square [download-url]: https://npmjs.org/package/rc-slider [bundlephobia-url]: https://bundlephobia.com/package/rc-slider [bundlephobia-image]: https://badgen.net/bundlephobia/minzip/rc-slider [dumi-url]: https://github.com/umijs/dumi [dumi-image]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square ## Install [![rc-slider](https://nodei.co/npm/rc-slider.png)](https://npmjs.org/package/rc-slider) ## Example `npm start` and then go to http://localhost:8000 Online examples: https://slider.react-component.now.sh/ ## Usage ## Slider ```js import Slider from 'rc-slider'; import 'rc-slider/assets/index.css'; export default () => ( <> ); ``` ## Range Please refer to [#825](https://github.com/react-component/slider/issues/825) for information regarding usage of `Range`. An example: ```js import Slider, { Range } from 'rc-slider'; import 'rc-slider/assets/index.css'; export default () => ( <> ); ``` ## Compatibility | [

](http://godban.github.io/browsers-support-badges/)
IE / Edge | [

](http://godban.github.io/browsers-support-badges/)
Firefox | [

](http://godban.github.io/browsers-support-badges/)
Chrome | [

](http://godban.github.io/browsers-support-badges/)
Safari | [

](http://godban.github.io/browsers-support-badges/)
Electron | | --- | --- | --- | --- | --- | | IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions | ## API ### createSliderWithTooltip(Slider | Range) => React.Component An extension to make Slider or Range support Tooltip on handle. ```js const Slider = require('rc-slider'); const createSliderWithTooltip = Slider.createSliderWithTooltip; const Range = createSliderWithTooltip(Slider.Range); ``` [Online demo](http://react-component.github.io/slider/?path=/story/rc-slider--handle) After Range or Slider was wrapped by createSliderWithTooltip, it will have the following props: | Name | Type | Default | Description | | ------------ | ------- | ------- | ----------- | | tipFormatter | (value: number): React.ReactNode | `value => value` | A function to format tooltip's overlay | | tipProps | Object | `{`
`placement: 'top',`
` prefixCls: 'rc-slider-tooltip',`
`overlay: tipFormatter(value)`
`}` | A function to format tooltip's overlay | ### Common API The following APIs are shared by Slider and Range. | Name | Type | Default | Description | | ------------ | ------- | ------- | ----------- | | className | string | `''` | Additional CSS class for the root DOM node | | min | number | `0` | The minimum value of the slider | | max | number | `100` | The maximum value of the slider | | id | string | `''` | Unique identifier for the component, used for accessibility | | marks | `{number: ReactNode}` or`{number: { style, label }}` | `{}` | Marks on the slider. The key determines the position, and the value determines what will show. If you want to set the style of a specific mark point, the value should be an object which contains `style` and `label` properties. | | step | number or `null` | `1` | Value to be added or subtracted on each step the slider makes. Must be greater than zero, and `max` - `min` should be evenly divisible by the step value.
When `marks` is not an empty object, `step` can be set to `null`, to make `marks` as steps. | | vertical | boolean | `false` | If vertical is `true`, the slider will be vertical. | | handle | (props) => React.ReactNode | | A handle generator which could be used to customized handle. | | included | boolean | `true` | If the value is `true`, it means a continuous value interval, otherwise, it is a independent value. | | reverse | boolean | `false` | If the value is `true`, it means the component is rendered reverse. | | disabled | boolean | `false` | If `true`, handles can't be moved. | | keyboard | boolean | `true` | Support using keyboard to move handlers. | | dots | boolean | `false` | When the `step` value is greater than 1, you can set the `dots` to `true` if you want to render the slider with dots. | | onBeforeChange | Function | NOOP | `onBeforeChange` will be triggered when `ontouchstart` or `onmousedown` is triggered. | | onChange | Function | NOOP | `onChange` will be triggered while the value of Slider changing. | | onChangeComplete | Function | NOOP | `onChangeComplete` will be triggered when `ontouchend` or `onmouseup` is triggered. | | minimumTrackStyle | Object | | please use `trackStyle` instead. (`only used for slider, just for compatibility , will be deprecate at rc-slider@9.x `) | | maximumTrackStyle | Object | | please use `railStyle` instead (`only used for slider, just for compatibility , will be deprecate at rc-slider@9.x`) | | handleStyle | Array[Object] \| Object | `[{}]` | The style used for handle. (`both for slider(`Object`) and range(`Array of Object`), the array will be used for multi handle following element order`) | | trackStyle | Array[Object] \| Object | `[{}]` | The style used for track. (`both for slider(`Object`) and range(`Array of Object`), the array will be used for multi track following element order`)| | railStyle | Object | `{}` | The style used for the track base color. | | dotStyle | Object \| (dotValue) => Object | `{}` | The style used for the dots. | | activeDotStyle | Object \| (dotValue) => Object | `{}` | The style used for the active dots. | ### Slider | Name | Type | Default | Description | | ------------ | ------- | ------- | ----------- | | defaultValue | number | `0` | Set initial value of slider. | | value | number | - | Set current value of slider. | | startPoint | number | `undefined` | Track starts from this value. If `undefined`, `min` is used. | | tabIndex | number | `0` | Set the tabIndex of the slider handle. | | ariaLabelForHandle | string | - | Set the `aria-label` attribute on the slider handle. | | ariaLabelledByForHandle | string | - | Set the `aria-labelledby` attribute on the slider handle. | | ariaRequired | boolean | - | Set the `aria-required` attribute on the slider handle. | | ariaValueTextFormatterForHandle | (value) => string | - | A function to set the `aria-valuetext` attribute on the slider handle. It receives the current value of the slider and returns a formatted string describing the value. See [WAI-ARIA Authoring Practices 1.1](https://www.w3.org/TR/wai-aria-practices-1.1/#slider) for more information. | ### Range | Name | Type | Default | Description | | ------------ | ------- | ------- | ----------- | | defaultValue | `number[]` | `[0, 0]` | Set initial positions of handles. | | value | `number[]` | | Set current positions of handles. | | tabIndex | number[] | `[0, 0]` | Set the tabIndex of each handle. | | ariaLabelGroupForHandles | Array[string] | - | Set the `aria-label` attribute on each handle. | | ariaLabelledByGroupForHandles | Array[string] | - | Set the `aria-labelledby` attribute on each handle. | | ariaValueTextFormatterGroupForHandles | Array[(value) => string] | - | A function to set the `aria-valuetext` attribute on each handle. It receives the current value of the slider and returns a formatted string describing the value. See [WAI-ARIA Authoring Practices 1.1](https://www.w3.org/TR/wai-aria-practices-1.1/#slider) for more information. | | count | number | `1` | Determine how many ranges to render, and multiple handles will be rendered (number + 1). | | allowCross | boolean | `true` | `allowCross` could be set as `true` to allow those handles to cross. | | pushable | boolean or number | `false` | `pushable` could be set as `true` to allow pushing of surrounding handles when moving a handle. When set to a number, the number will be the minimum ensured distance between handles. Example: ![](http://i.giphy.com/l46Cs36c9HrHMExoc.gif) | | draggableTrack | boolean | `false` | Open the track drag. open after click on the track will be invalid. | ### SliderTooltip The Tooltip Component that keep following with content. ## Development ``` npm install npm start ``` ## Test Case `npm run test` ## Coverage `npm run coverage` ## License `rc-slider` is released under the MIT license.

Package	Téléchargements	Stars	Taille	Issues	Publication	Licence

rc-slider	2,568,250	3,076	173 kB	280	il y a 6 mois	MIT