Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.08 KB

README.md

File metadata and controls

36 lines (21 loc) · 1.08 KB

Build Status

About

React.js components for entering 0—N stars (N is 5 by default), or displaying 0—N stars. See the demo.

It's published to npm compiled to ES5, and should work in IE11, if Promise gets polyfilled.

Installation

npm install --save react-star-rating-input

The two main exports are: {StarRatingInput, StarRating}. The former is for an interactive input control, the latter is for passive star rating display. Star rasters and CSS is exported as the {css} string.

Usage

See the code of the demo mentioned above.

StarRatingInput props

Static layout

  • size — how many stars to display. The default value is 5

Interaction

  • value — how many stars are selected
  • onChange: (value: number) => void — your value change handler

StarRating props

  • value — how many stars are displayed