react-native-custom-star-rating
v1.0.6
Published
This component allows for rating using swipe and tap gestures, and it can be customized
Downloads
25
Maintainers
Readme
React Native Custom Star Rating
This library enables the use of both Swipe and Tap rating features in a single component and is compatible with both Android and iOS platforms.
Features
- Support Swipe and Tap Gesture rating.
- You can enable half star Rating.
- You can update the images for both the filled and unfilled states.
Installation
$ yarn add react-native-custom-star-rating
Or
$ npm install react-native-custom-star-rating
Usage
import Rating from "react-native-custom-star-rating";
const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: "center",
},
});
const App = () => {
return (
<View style={styles.container}>
<Rating
filledImage={require(./yourImage.png)} //@notRequired
unfilledImage={require(./yourImage.png)} //@notRequired
onResult={result => {
console.log('result : ', result);
}}
/>
</View>
);
};
export default App;
Install
npm i [email protected]
npm i [email protected]
Props
| prop | default | type | description | | ----------------- | ---------------- | ---------------------- | ---------------------------------------------------------------------------------------------- | | initialRating | 1 | number | Initial value for the rating | | renderStars | 5 | number | For Render numbers of Stars | | starHeight | 40 | number | Height and Width of Stars | | onResult | | function(value:number) | The "onResult" is a callback function that provides the final rating output. | | spaceBetween | 0 | number | spaceBetween prop is used for provide space between stars | | filledImage | FilledStar.png | ImageRequireSource | The "filledImage" property is used to specify your own image for the filled star. | | unfilledImage | UnFilledStar.png | ImageRequireSource | The "unfilledImage" property is used to specify your own image for the unfilled star. | | isHalf | false | boolean | The "isHalf" property is used to enable the functionality of half-star rating. | | swipeEnabled | true | boolean | The "swipeEnabled" property is used to enable the Swipe functionality in Rating component. | | tapEnabled | true | boolean | The "tapEnabled" property is used to enable the Tap functionality in Rating component. | | activeTintColor | | string | The "activeTintColor" property is used to specify your own color for the filled starcomponent. | | inActiveTintColor | | string | The "inActiveTintColor" property is used to specify your own color for the unfilled star. |