react-simple-star-rating

v5.1.7

A simple react component for adding a star rating to your project. For more information about how to use this package see README

Latest version published 2 years ago

License: MIT

NPM

GitHub

Package Health Score

53 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
5.1.7	\|	11/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.1.1	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.0.0	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.0	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.0	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (17,780)

GitHub Stars: 136
Forks: 32
Contributors: 5

Direct Usage Popularity

The npm package react-simple-star-rating receives a total of 17,780 downloads a week. As such, we scored react-simple-star-rating popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package react-simple-star-rating, we found that it has been starred 136 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 5
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like react-simple-star-rating is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 28
Open PR: 5
Last Release: 2 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of react-simple-star-rating based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for react-simple-star-rating is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=14

Age: 4 years
Dependencies: 0 Direct
Versions: 28
Install Size: 44.8 kB
Dist-tags: 1
# of Files: 9
Maintainers: 1
TS Typings: No

react-simple-star-rating has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

React Simple Rating

> A simple react component for adding a star rating to your project.

screenshot

Install

npm

npm i react-simple-star-rating

Yarn

yarn add react-simple-star-rating

Usage

import React, { useState } from 'react'
import { Rating } from 'react-simple-star-rating'

export function MyComponent() {
  const [rating, setRating] = useState(0)

  // Catch Rating value
  const handleRating = (rate: number) =&gt; {
    setRating(rate)

    // other logic
  }
  // Optinal callback functions
  const onPointerEnter = () =&gt; console.log('Enter')
  const onPointerLeave = () =&gt; console.log('Leave')
  const onPointerMove = (value: number, index: number) =&gt; console.log(value, index)

  return (
    <div>
      
    </div>
  )
}

Reset Rating Value

import React, { useState } from 'react'
import { Rating } from 'react-simple-star-rating'

export function MyComponent() {
  const [rating, setRating] = useState(0)

  // Catch Rating value
  const handleRating = (rate: number) =&gt; {
    setRating(rate)
  }

  const handleReset = () =&gt; {
    // Set the initial value
    setRating(0)
  }

  return (
    <div>
      {/* set initial value */}
      

      <button>reset</button>
    </div>
  )
}

Available Props

Prop	Type	Options	Description	Default
`onClick`	function	Optional	callback with `hover`, `index` and `event` values passed	`-`
`onPointerMove`	function	Optional	callback with `hover`, `index` and `event` values passed	`-`
`onPointerEnter`	function	Optional	callback with `event` passed	`-`
`onPointerLeave`	function	Optional	callback with `event` passed	`-`
`initialValue`	number	Optional	Set initial value	`0`
`iconsCount`	number	Optional	Number of the icons	`5`
`readonly`	boolean	Optional	Readonly mode	`false`
`rtl`	boolean	Optional	RTL mode	`false`
`transition`	boolean	Optional	Adds a smooth transition effect on mouse hover	`false`
`allowFraction`	boolean	Optional	Enable a fractional icon (half icon)	`false`
`className`	string	Optional	Applied to the `main` span	`react-simple-star-rating`
`style`	CSSProperties	Optional	Inline style applied to the `main` span	`basic style`
`size`	number	Optional	SVG Icon width / height in `px`	`25`
`SVGstrokeColor`	string	Optional	SVG Icon stroke color	`currentColor`
`SVGstorkeWidth`	string \| number	Optional	SVG Icon storke width	`0`
`SVGclassName`	string	Optional	SVG Icon css class	`star-svg`
`SVGstyle`	CSSProperties	Optional	SVG inline style	`-`
`fillIcon`	ReactNode	Optional	Custom fill icon SVG	`null`
`fillColor`	string	Optional	Fill icons color	`#f1a545`
`fillColorArray`	array	Optional	Array of string to add color range	`[]`
`fillStyle`	CSSProperties	Optional	Inline style applied to `filled` icon span	`basic style`
`fillClassName`	string	Optional	Applied to the `filled` icon span	`filled-icons`
`emptyIcon`	ReactNode	Optional	Custom empty icon SVG	`null`
`emptyColor`	string	Optional	Empty icons color	`#cccccc`
`emptyStyle`	CSSProperties	Optional	Inline style applied to `empty` icon span	`basic style`
`emptyClassName`	string	Optional	Applied to the `empty` icon span	`empty-icons`
`customIcons`	array of object	Optional	Add a group of icons	`[]`
`allowHover`	boolean	Optional	Enable / Disable hover effect	`true`
`disableFillHover`	boolean	Optional	Enable / Disable hover effect on filled stars	`false`
`showTooltip`	string	Optional	Show a tooltip with live values	`false`
`tooltipDefaultText`	string	Optional	Initial tooltip text if no rating value	`Your Rate`
`tooltipArray`	array	Optional	Array of strings to show inside tooltip	`[]`
`tooltipClassName`	string	Optional	Tooltip CSS class	`rating-tooltip`
`tooltipStyle`	CSSProperties	Optional	Inline style applied to the `tooltip` span	`basic style`
`titleSeparator`	string	Optional	Separator word in a title of a rating star `(1 out of 5)`	`out of`

BREAKING CHANGES: version 4.1.0 (2022-10-03)

old	new	changes
`allowHalfIcon`	`allowFraction`	`Renamed`
`fullIcon`	`fillIcon`	`Renamed`
`fullStyle`	`fillStyle`	`Renamed`
`fullClassName`	`fillClassName`	`Renamed`
`ratingValue`	`-`	`Removed`

Demos

See all demos and usage examples in action.

License

MIT © awran5

FAQs

What is react-simple-star-rating?

A simple react component for adding a star rating to your project. Visit Snyk Advisor to see a full health score report for react-simple-star-rating, including popularity, security, maintenance & community analysis.

Is react-simple-star-rating popular?

The npm package react-simple-star-rating receives a total of 17,780 weekly downloads. As such, react-simple-star-rating popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-simple-star-rating well maintained?

We found indications that react-simple-star-rating is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is react-simple-star-rating safe to use?

The npm package react-simple-star-rating was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 18:52 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (17,780)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

React Simple Rating

Install

npm

Yarn

Usage

Reset Rating Value

Available Props

BREAKING CHANGES: version 4.1.0 (2022-10-03)

Demos

License