Skip to content

Repository files navigation

rc-slider


slider ui component for react

NPM versionbuild statusTest coveragegemnasium depsnode versionnpm downloadSauce Test Status

Sauce Test Status

Screenshots

Feature

  • support ie8,ie8+,chrome,firefox,safari

Keyboard

install

rc-slider

Usage

require('rc-slider/assets/index.css');varReact=require('react');varReactDOM=require('react-dom');varRcslider=require('rc-slider');ReactDOM.render(<Rcslider/>,container);

API

props

nametypedefaultdescription
classNameStringrc-sliderAdditional css class for the root dom node
minnumber0The minimum value of the slider
maxnumber100The maximum value of the slider
marksobject{number: string} or object{number: object{ style, label }}{}Mark 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.
stepnumber or `null`1Value to be added or subtracted on each step the slider makes. Must be greater than zero. 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.
rangeboolean or numberfalseDetermines the type of slider. If range is `true`, two handles will be rendered in order to select a range. If range is a number, multiple handles will be rendered (number + 1). Using `range={true}` is equivalent to `range={1}`.
allowCrossbooleantrueWhen `range` is `true`, `allowCross` could be set as `true` to allow those handles to cross.
pushableboolean or numbertrueWhen `range` is `true`, `pushable` could be set as `true` to allow pushing of surrounding handles when moving an handle. When set to a number, the number will be the minimum ensured distance between handles. Example:
verticalbooleanfalseIf vertical is `true`, the slider will be vertical.
defaultValuenumber or [number, number, ...]0 or [0, 0]Set initial positions of handles. If range is `false`, the type of `defaultValue` should be `number`. Otherwise, `[number, number, ...]`
valuenumber or [number, number, ...]Set current positions of handles. If range is `false`, the type of `defaultValue` should be `number`. Otherwise, `[number, number, ...]`
handleComponentProvide a custom Handle to use in the slider by passing a component. This component will have a `value` and `offset` props used to define custom styling/content.
includedbooleantrueIf the value is `true`, it means a continuous value interval, otherwise, it is a independent value.
disabledbooleanfalseIf `true`, handles can't be moved.
tipTransitionNamestring''Set the animation for tooltip if it shows.
tipFormatterfunction or `null`Format the value of the tooltip if it shows. If `null` the tooltip will always be hidden.
dotsboolfalseWhen the `step` value is greater than 1, you can set the `dots` to `true` if you want to render the slider with dots.
onChangefunctionNOOP`onChange` will be triggered while the value of Slider changing.
onAfterChangefunctionNOOP`onAfterChange` will be triggered when `ontouchend` or `onmouseup` is triggered.

Development

npm install
npm start

Example

http://localhost:8005/examples/

online example: http://react-component.github.io/slider/

Test Case

http://localhost:8005/tests/runner.html?coverage

Coverage

http://localhost:8005/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8088/tests/runner.html?coverage

License

rc-slider is released under the MIT license.

About

React Slider

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages