/slider

React Slider

Primary LanguageJavaScript

rc-slider


slider ui component for react

NPM version build status Test coverage gemnasium deps node version npm download Sauce Test Status

Sauce Test Status

Screenshots

Feature

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

Keyboard

install

rc-slider

Usage

var React = require('react');
var ReactDOM = require('react-dom');
var Rcslider = require('rc-slider');
ReactDOM.render(<Rcslider />, container);

API

props

name type default description
className String rc-slider 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
marks object {number: string} {} Mark on the slider. The key determines the position, and the value determines what will show.
step number or `null` 1 Value 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.
range boolean false Determines the type of slider. If range is `true`, two handles will be rendered in order to select a range.
allowCross boolean true When `range` is `true`, `allowCross` could be set as `true` to allow those two handles cross.
defaultValue number 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]`
value number or [number, number] Set current positions of handles. If range is `false`, the type of `defaultValue` should be `number`. Otherwise, `[number, number]`
included boolean true If the value is `true`, it means a continuous value interval, otherwise, it is a independent value.
disabled boolean false If `true`, handles can't be moved.
tipTransitionName string '' Set the animation for tooltip if it shows.
tipFormatter function Format the value of the tooltip if it shows.
dots bool 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.
onChange function NOOP `onChange` will be triggered while the value of Slider changing.
onAfterChange function NOOP `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.