A simple star rating component built with React.
v1.4.0 coming soon.
Install
$ npm install react-star-rating --save
Usage
ES6
;; Component { return <form action="/api" method="POST"> <StarRating name="airbnb-rating" caption="Rate your stay!" ratingAmount=5 /> <button type="submit" className="btn btn-submit">Submit Rating</button> </form> ; } React;
ES5
var React = ;var StarRating = ; var FormComponent = React; React;
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
- Fix ES6 bug with bundling
- Add svg stars
- Double-check touch support works
- Re-implement star hovering (kinda janky right now)