mirror of
https://github.com/wassname/slider.git
synced 2026-09-10 12:38:09 +08:00
154 lines
4.4 KiB
Markdown
154 lines
4.4 KiB
Markdown
# rc-slider
|
|
---
|
|
|
|
slider ui component for react
|
|
|
|
[![NPM version][npm-image]][npm-url]
|
|
[](http://spmjs.io/package/rc-slider)
|
|
[![build status][travis-image]][travis-url]
|
|
[![Test coverage][coveralls-image]][coveralls-url]
|
|
[![gemnasium deps][gemnasium-image]][gemnasium-url]
|
|
[![node version][node-image]][node-url]
|
|
[![npm download][download-image]][download-url]
|
|
[](https://saucelabs.com/u/rc-slider)
|
|
|
|
[](https://saucelabs.com/u/rc-slider)
|
|
|
|
[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.svg?style=flat-square
|
|
[travis-url]: https://travis-ci.org/react-component/slider
|
|
[coveralls-image]: https://img.shields.io/coveralls/react-component/slider.svg?style=flat-square
|
|
[coveralls-url]: https://coveralls.io/r/react-component/slider?branch=master
|
|
[gemnasium-image]: http://img.shields.io/gemnasium/react-component/slider.svg?style=flat-square
|
|
[gemnasium-url]: https://gemnasium.com/react-component/slider
|
|
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
|
|
[node-url]: http://nodejs.org/download/
|
|
[download-image]: https://img.shields.io/npm/dm/rc-slider.svg?style=flat-square
|
|
[download-url]: https://npmjs.org/package/rc-slider
|
|
|
|
## Screenshots
|
|
|
|
<img src="https://t.alipayobjects.com/images/T1ki8fXeprXXXXXXXX.png" width="550"/>
|
|
|
|
<img src="https://t.alipayobjects.com/images/T1pPhfXhBqXXXXXXXX.png" width="550"/>
|
|
|
|
<img src="https://t.alipayobjects.com/images/T1wO8fXd4rXXXXXXXX.png" width="550"/>
|
|
|
|
|
|
## Feature
|
|
|
|
* support ie8,ie8+,chrome,firefox,safari
|
|
|
|
### Keyboard
|
|
|
|
|
|
|
|
## install
|
|
|
|
[](https://npmjs.org/package/rc-slider)
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var Rcslider = require('rc-slider');
|
|
var React = require('react');
|
|
React.render(<Rcslider />, container);
|
|
```
|
|
|
|
## API
|
|
|
|
### props
|
|
|
|
<table class="table table-bordered table-striped">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 100px;">name</th>
|
|
<th style="width: 50px;">type</th>
|
|
<th style="width: 50px;">default</th>
|
|
<th>description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>className</td>
|
|
<td>String</td>
|
|
<td>rc-slider</td>
|
|
<td>additional css class of root dom node</td>
|
|
</tr>
|
|
<tr>
|
|
<td>min</td>
|
|
<td>number</td>
|
|
<td>0</td>
|
|
<td>The minimum value of the slider</td>
|
|
</tr>
|
|
<tr>
|
|
<td>max</td>
|
|
<td>number</td>
|
|
<td>100</td>
|
|
<td>The maximum value of the slider</td>
|
|
</tr>
|
|
<tr>
|
|
<td>step</td>
|
|
<td>number</td>
|
|
<td>1</td>
|
|
<td>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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>value</td>
|
|
<td>number</td>
|
|
<td>0</td>
|
|
<td>Determines the initial positions of the handles.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>marks</td>
|
|
<td>array</td>
|
|
<td>[]</td>
|
|
<td>mark every step for the slider, it will ignore the `step` parameter if it has been defined</td>
|
|
</tr>
|
|
<tr>
|
|
<td>isIncluded</td>
|
|
<td>boolean</td>
|
|
<td>true</td>
|
|
<td>if the value is true, it means a continuous value interval, otherwise, it is a independent value.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>index</td>
|
|
<td>number</td>
|
|
<td>0</td>
|
|
<td>For step or marks slider, determine the initial positions of the handles.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>disabled</td>
|
|
<td>boolean</td>
|
|
<td>false</td>
|
|
<td>If true the handles can't be moved.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
## Development
|
|
|
|
```
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
## Example
|
|
|
|
http://localhost:8000/examples/
|
|
|
|
online example: http://react-component.github.io/slider/build/examples/
|
|
|
|
## Test Case
|
|
|
|
http://localhost:8000/tests/runner.html?coverage
|
|
|
|
## Coverage
|
|
|
|
http://localhost:8000/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.
|