Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

cc-rate

React Star Rate Component with custom Array of characters

react, react-component, react-rate, rate

readme

rc-rate


React Rate Component

NPM version build status Test coverage gemnasium deps npm download

Screenshots

Development

npm install
npm start

Example

http://localhost:8000/examples/

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

install

rc-rate

Usage

var Rate = require('rc-rate');
var React = require('react');
React.render(<Rate />, container);

API

props

name type default description
count number 5 star numbers
value number controlled value
defaultValue number 0 initial value
allowHalf bool false support half star
allowClear bool true reset when click again
style object {}
onChange function(value: Number) `onChange` will be triggered when click.
onHoverChange function(value: Number) `onHoverChange` will be triggered when hover on stars.
character ReactNode The each character of rate
disabled bool false

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

open coverage/ dir

License

rc-rate is released under the MIT license.

changelog

2.4.1

  • Better accessibility support.

2.4.0

  • Add allowClear support.

2.3.0

  • Add keyboard support.
  • Add focus() blur() and autoFocus.

2.1.0

  • Fix typo charactor to character.

2.0.0

  • Add character.
  • Add className.
  • Add onHoverChange(value).