1.0.1 • Published 3 years ago

react-native-simple-star-rating-widget v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

react-native-simple-star-rating-widget

A customizable, animated star rating component for React Native. Compatible with iOS and Android. Written in Typescript.

Installation

  1. install react-native-star-rating-widget npm install react-native-star-rating-widget --save or yarn add react-native-star-rating-widget
  2. if not already installed, add react-native-svg

Usage

import StarRating from "react-native-star-rating-widget";

const Example = () => {
    const [rating, setRating] = useState(0);
    return <StarRating rating={rating} onChange={setRating} />;
};

Props

NameTypeDefaultDescription
ratingnumberREQUIREDRating Value. Should be between 0 and maxStars
onChange(number) => voidREQUIREDcalled when rating changes
maxStarsnumber5number of stars
minRatingnumber0.5minimum selectable rating
starSizenumber32star size
colorstring"#fdd835"star color
emptyColorstringsame as colorempty star color
styleobjectundefinedoptional style
enableHalfStarbooleantrueenable or disable display of half stars
animationConfigsee AnimationConfigsee AnimationConfiganimation configuration object

AnimationConfig

NameTypeDefaultDescription
scalenumber1.2star animation scale value
durationnumber300animation duration
delaynumber300animation delay when interaction has ended
easing(number) => numberEasing.elastic(2)animation easing function