React Native Rating Element
A simple rating library for react native supporting:
- a11y ready
⚛️ - decimal points like 3.7, 4.2 etc,
- direction aware icons (like you can pass direction as “column” or “row-reverse”),
- custom icon set from Ionicons,
- custom images (You can add any suitable image as per your wish),
- and interact and record rating given by users.
Installation · Usage · API Documentation · Sample Output ·
Please note: This package depends on react-native-vector-icons. Please configure it for iOS and android before using this package.
- For iOS, you will need to addIonicons.ttffile fromnode_modules/react-native-vector-iconstoFontsfolder and then editInfo.plist. Try this article
- For android - Please follow these instruction.
Installation
Use the package manager npm to install react-native-rating-element.
npm install react-native-rating-elementUsage
import { Rating } from "react-native-rating-element";
<Rating
rated={3.7}
totalCount={5}
ratingColor="#f1c644"
ratingBackgroundColor="#d4d4d4"
size={24}
readonly // by default is false
icon="ios-star"
direction="row" // anyOf["row" (default), "row-reverse", "column", "column-reverse"]
/>
**Custom Image, onIconTap and bottom to top direction**
<Rating
rated={3.7}
totalCount={5}
size={42}
onIconTap={position => console.log(`User pressed: ${position}`)}
direction="column-reverse"
type="custom" // default is always to "icon"
selectedIconImage={require('./filled.png')}
emptyIconImage={require('./empty.png')}
/>API
| prop | default | type | description |
|---|---|---|---|
rated |
0 | number | Represents Initial value for the rating. |
totalCount |
5 | number | Number of background stars to show. For ex. Rated 5 out of 10 stars. The 10 value is totalCount |
type |
icon |
string | If you want custom images, then pass custom as prop value. In case of custom, Make sure to pass selectedIconImage and emptyIconImage. |
selectedIconImage |
- | image path (node) | Pass in custom path for selected icon. For ex. selectedIconImage={require('../pathToImage/image.png}. |
emptyIconImage |
- | image path (node) | Pass in custom path for selected icon. For ex. emptyIconImage={require('../pathToImage/image.png}. |
readonly |
false | bool | If passed true, onIconTap event won't be fired. |
direction |
'row' | string | Pass any value from [ "row", "row-reverse", "column", "column-reverse"]. |
onIconTap |
- | func | On press of star icon by user, this function will be invoked with position paramter. For ex. when user taps on 4 rating, this function will be invoked and in position parameter you will get value 4. Please note: This won't be triggered if readonly is passed as true. |
ratingColor |
#f1c644 | string (color) | Pass in a custom color to fill-color the rating icon. |
ratingBackgroundColor |
#d4d4d4 | string (color) | Pass in a custom fill-color for the background of rating icon. It is sometimes referred as empty icon. |
size |
24 | number | Pass in a custom font size for the icon |
icon |
'ios-star' | string | Pass in a custom text for the icon. For ex. 'beer', 'bulb'. These icons are imported from package react-native-vector-icons. Please Note: For now this package only support Ionicons |
marginBetweenRatingIcon |
1 | number | Pass in custom number to manage space or margin between the rating icons. |
Output
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.