https://github.com/wrathchaos/react-native-star-review

Fully customizable Star Review for React Native.
https://github.com/wrathchaos/react-native-star-review

Last synced: 5 months ago
JSON representation

Fully customizable Star Review for React Native.

• Host: GitHub
• URL: https://github.com/wrathchaos/react-native-star-review
• Owner: WrathChaos
• License: mit
• Created: 2019-04-20T20:08:09.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-10T09:12:02.000Z (about 2 years ago)
• Last Synced: 2025-05-05T00:30:51.233Z (6 months ago)
• Language: JavaScript
• Homepage: https://www.freakycoder.com
• Size: 3.49 MB
• Stars: 13
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


[![Battle Tested ✅](https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge)](https://github.com/WrathChaos/react-native-star-review)

[![Fully customizable Star Review for React Native](https://img.shields.io/badge/-Fully%20customizable%20Star%20Review%20for%20React%20Native-lightgrey?style=for-the-badge)](https://github.com/WrathChaos/react-native-star-review)

[![npm version](https://img.shields.io/npm/v/react-native-star-review.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-star-review)

[![npm](https://img.shields.io/npm/dt/react-native-star-review.svg?style=for-the-badge)](https://www.npmjs.com/package/react-native-star-review)

![expo-compatible](https://img.shields.io/badge/Expo-compatible-9cf.svg?style=for-the-badge)

![Platform - Android and iOS](https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)







## Installation

Add the dependency:

### Pure React Native:

```ruby

npm i react-native-star-review

```

## Peer Dependencies

###### IMPORTANT! You need install them.

```

"react": ">= 16.x.x",

"react-native": ">= 0.55.x",

"react-number-format": ">= 4.x.x",

"react-native-vector-icons": ">= 6.x.x",

"react-native-dynamic-vector-icons": ">= x.x.x"

// Expo Version

"react-native-dynamic-vector-icons": "WrathChaos/react-native-dynamic-vector-icons#expo"

```

## Basic Usage

```ruby

 

```

## Advanced Usage

You can check the example for the advanced usage

```ruby

```

### Configuration - Props

| Property          |   Type    |    Default    | Description                                                 |

| ----------------- | :-------: | :-----------: | ----------------------------------------------------------- |

| stars             |  number   |       5       | create stars as many as you want                            |

| reviews           |  number   |       0       | makes the stars fillable as many as you want                |

| reviewsText       |  string   |    reviews    | change the review's description text                        |

| reviewTextStyle   |   style   | default style | set your own text style for review text                     |

| starSize          |  number   |      16       | change the star icon's size                                 |

| starColor         |  string   |    #ffa114    | change the star icon's color                                |

| textColor         |  string   |    #757575    | change the text color                                       |

| iconComponent     | component |     Icon      | set your own Icon component instead of dynamic-vector-icons |

| enableStars       |  boolean  |     false     | shows the stars as text                                     |

| enableParentheses |  boolean  |     false     | reviews are shown inside of parentheses                     |

| disableReview     |  boolean  |     false     | disable the whole review part                               |

## Expo Compatibility

Star Review is usable with Expo. You just need to add a peer dependency:

```

"react-native-dynamic-vector-icons": "WrathChaos/react-native-dynamic-vector-icons#expo"

```

## Known Issues

### Android

#### Stars are not showing :O

-> You need to add this line of code into app/gradle

```ruby

apply from: "../../node_modules/react-native-vector-icons/fonts.gradle"

```

### Future Plans

- [x] ~~LICENSE~~

- [ ] Write an article about the lib on Medium

## Author

FreakyCoder, kurayogun@gmail.com

## License

React Native Star Review Library is available under the MIT license. See the LICENSE file for more info.