ikr / react-star-rating-input

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

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

License:MIT License


Languages

Language:TypeScript 93.7%Language:HTML 3.8%Language:JavaScript 2.5%