react-star-rating 



> A simple star rating component built with React.

v1.4.0 coming soon.

Install

``sh
$ npm install react-star-rating --save
`


Usage

$3


`js
import React from 'react';
import StarRating from 'react-star-rating';

class FormComponent extends React.Component {
render() {
return (

Submit Rating

);
}
}

React.render(, document.getElementById('star-rating'));
`

$3


`js
var React = require('react');
var StarRating = require('react-star-rating');

var FormComponent = React.createClass({
render: function () {
return (

Submit Rating

);
}
});

React.render(, document.getElementById('star-rating'));
``

Options

- name={string} - name for form input (required)
- caption={string} - caption for rating (optional)
- totalStars={number} - rating amount (required, default: 5)
- rating={number} - a set rating between the rating amount (optional)
- disabled={boolean} - whether to disable the rating from being selected (optional)
- editing={boolean} - whether the rating is explicitly in editing mode (optional)
- size={number} - size of stars (optional)
- onRatingClick={function} - a handler function that gets called onClick of the rating (optional) - gets passed (event, {position, rating, caption, name})

Todo

- [x] Fix ES6 bug with bundling
- [x] Add svg stars
- [x] Double-check touch support works
- [ ] Re-implement star hovering (kinda janky right now)

License

MIT