apeman-react-range
Version:
apeman react package for range input component.
204 lines (132 loc) • 5.16 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]
[![JS Standard][bd_standard_shield_url]][bd_standard_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_travis_com_url]: http://travis-ci.com/apeman-react-labo/apeman-react-range
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-react-labo/apeman-react-range.svg?token=
[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_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
<!-- 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/guides/01.Installation.md.hbs" Start -->
<a name="section-doc-guides-01-installation-md"></a>
Installation
-----
```bash
$ npm install apeman-react-range --save
```
<!-- Section from "doc/guides/01.Installation.md.hbs" End -->
<!-- Section from "doc/guides/02.Demo.md.hbs" Start -->
<a name="section-doc-guides-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/guides/02.Demo.md.hbs" End -->
<!-- Section from "doc/guides/03.Usage.md.hbs" Start -->
<a name="section-doc-guides-03-usage-md"></a>
Usage
---------
```jsx
'use strict'
import React from 'react'
import {ApRange, ApRangeStyle} from 'apeman-react-range'
const html = (
<html>
<head>
<ApRangeStyle></ApRangeStyle>
</head>
<body>
<ApRange min={ 0 } max={ 100 }
onChange={ (from, to)=>{console.log(from, to)} } />
</body>
</html>
)
```
<!-- Section from "doc/guides/03.Usage.md.hbs" End -->
<!-- Section from "doc/guides/04.Components.md.hbs" Start -->
<a name="section-doc-guides-04-components-md"></a>
Components
-----
### ApRangeHandle
**Props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| onMove | func | | | Handle for move |
| shouldMove | func | | | |
| x | number | | | |
| minX | number | | | |
| maxX | number | | | |
### ApRangeLabel
**Props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| value | number | null | | |
### ApRangeStyle
**Props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| style | object | {} | | |
| handleSize | number | 24 | | |
| barHeight | number | 4 | | |
| highlightColor | string | '#38E' | | |
### ApRange
**Props**
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| from | number | 25 | | Range from value |
| to | number | 75 | | Range to value |
| min | number | 0 | | Min value for range from |
| max | number | 100 | | Max value for range to |
| step | number | 0.01 | | Step for value |
| onChange | func | | | Handler for change |
| barOnly | bool | false | | |
<!-- Section from "doc/guides/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][apeman_url]
+ [apeman-react-labo][apeman_react_labo_url]
+ [React][react_url]
+ [Demo of apeman-react-range][demo_of_apeman_react_range_url]
[apeman_url]: https://github.com/apeman-labo/apeman
[apeman_react_labo_url]: https://github.com/apeman-react-labo
[react_url]: https://facebook.github.io/react/
[demo_of_apeman_react_range_url]: http://apeman-react-labo.github.io/apeman-react-range/demo/demo.html
<!-- Links End -->