Socket
Socket
Sign inDemoInstall

stars-rating

Package Overview
Dependencies
0
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

stars-rating

star rating component


Version published
Maintainers
1
Weekly downloads
114
decreased by-43.56%

Weekly downloads

Readme

Source

stars-rating :star:

A simple star rating component for your React projects (now with half stars and custom characters)

stars-rating

Get started quickly

Install stars-rating package with NPM:

npm install stars-rating --save

Then in your project include the component:

import StarsRating from 'stars-rating'
import React from 'react'
import { render } from 'react-dom'

const ratingChanged = (newRating) => {
  console.log(newRating)
}

render(<StarsRating
  count={5}
  onChange={ratingChanged}
  size={24}
  color2={'#ffd700'} />,

  document.getElementById('where-to-render')
);

API

This a list of props that you can pass down to the component:

PropertyDescriptionDefault valuetype
classNameName of parent classnullstring
countHow many total stars you want5number
valueSet rating value0number
charWhich character you want to use as a starstring
color1Color of inactive star (this supports any CSS valid value)graystring
color2Color of selected or active star#ffd700string
sizeSize of stars (in px)15pxstring
editShould you be able to select rating or just see rating (for reusability)trueboolean
halfShould component use half stars, if not the decimal part will be dropped otherwise normal algebra rools will apply to round to half starstrueboolean
onChange(new_rating)Will be invoked any time the rating is changednullfunction

Help improve the component

Build on your machine:
# Clone the repo
git clone git@github.com:daluobohao/stars-rating.git
# Go into project folder
cd stars-rating
# Install dependancies
npm install

Build the component:

npm build

Run the examples (dev):

npm run dev-example

Build the examples (production):

npm run build-example

Then in your browser go to: http://127.0.0.1:8080/example

Requirements

You will need to have React in your project in order to use the component, I didn't bundle React in the build, because it seemed like a crazy idea.

Todo

  • Make better docs
  • Better state management
  • Write tests

Keywords

FAQs

Last updated on 03 Jan 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc