apeman-react-range
Version:
apeman react package for range input component.
175 lines (110 loc) • 4.51 kB
Markdown
apeman-react-range
==========
<!---
This file is generated by ape-tmpl. Do not update manually.
--->
<!-- Badge Start -->
<a name="badges"></a>
[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[bd_repo_url]: https://github.com/apeman-react-labo/apeman-react-range
[bd_travis_url]: http://travis-ci.org/apeman-react-labo/apeman-react-range
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-react-labo/apeman-react-range.svg?style=flat
[bd_license_url]: https://github.com/apeman-react-labo/apeman-react-range/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-react-labo/apeman-react-range
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-react-labo/apeman-react-range.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-react-labo/apeman-react-range.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-react-labo/apeman-react-range
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-react-labo/apeman-react-range.svg
[bd_npm_url]: http://www.npmjs.org/package/apeman-react-range
[bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-react-range.svg?style=flat
[bd_bower_badge_url]: https://img.shields.io/bower/v/apeman-react-range.svg?style=flat
<!-- Badge End -->
<!-- Description Start -->
<a name="description"></a>
apeman react package for range input component.
<!-- Description End -->
<!-- Overview Start -->
<a name="overview"></a>
<!-- Overview End -->
<!-- Sections Start -->
<a name="sections"></a>
<!-- Section from "doc/readme/01.Installation.md.hbs" Start -->
<a name="section-doc-readme-01-installation-md"></a>
Installation
-----
```bash
$ npm install apeman-react-range --save
```
<!-- Section from "doc/readme/01.Installation.md.hbs" End -->
<!-- Section from "doc/readme/02.Demo.md.hbs" Start -->
<a name="section-doc-readme-02-demo-md"></a>
Demo
-----
[Live demo][demo_url] is hosted on GitHub Pages.
[][demo_url]
[demo_url]: http://apeman-react-labo.github.io/apeman-react-range/demo/demo.html
<!-- Section from "doc/readme/02.Demo.md.hbs" End -->
<!-- Section from "doc/readme/03.Usage.md.hbs" Start -->
<a name="section-doc-readme-03-usage-md"></a>
Usage
---------
```jsx
var React = require('react');
var apemanReactRange = require('apeman-react-range');
var ApRange = apemanReactRange.ApRange,
ApRangeStyle = apemanReactRange.ApRangeStyle;
var style = <ApRangeStyle></ApRangeStyle>,
element = <ApRange min={0} max={100} onChange={(from, to)=>{console.log(from, to)}}></ApRange>;
var html = (
<html>
<head>{style}</head>
<body>{element}</body>
</html>
);
```
<!-- Section from "doc/readme/03.Usage.md.hbs" End -->
<!-- Section from "doc/readme/04.Components.md.hbs" Start -->
<a name="section-doc-readme-04-components-md"></a>
Components
-----
### ApRange
Range component.
**Props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| from | number | 25 | Range from value. |
| to | number | 75 | Range to value. |
| min | number | | Min value. |
| max | number | 100 | Max value. |
| step | number | 0.01 | Step for value. |
| onChange | function | callback when value changed. |
| barOnly | boolean | Show bar only, no text labels. |
### ApRangeStyle
Style for range.
**Props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| scope | boolean | false | Render as scoped style. |
| style | object | {} | Style object. |
| handleSize | number | 24 | Size for handle icon. |
| highlightColor | string | '#38E' | Highlight color. |
<!-- Section from "doc/readme/04.Components.md.hbs" End -->
<!-- Sections Start -->
<!-- LICENSE Start -->
<a name="license"></a>
License
-------
This software is released under the [MIT License](https://github.com/apeman-react-labo/apeman-react-range/blob/master/LICENSE).
<!-- LICENSE End -->
<!-- Links Start -->
<a name="links"></a>
Links
------
+ [apeman](https://github.com/apeman-labo/apeman)
+ [apeman-react-labo](https://github.com/apeman-react-labo)
+ [React](https://facebook.github.io/react/)
+ [Demo of apeman-react-range](http://apeman-react-labo.github.io/apeman-react-range/demo/demo.html)
<!-- Links End -->