https://github.com/eperedo/osom_rating
the most fun way to get a rating component for your flutter apps
https://github.com/eperedo/osom_rating
docute flutter rating-stars
Last synced: about 2 months ago
JSON representation
the most fun way to get a rating component for your flutter apps
- Host: GitHub
- URL: https://github.com/eperedo/osom_rating
- Owner: eperedo
- License: mit
- Created: 2019-01-13T17:18:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-14T02:49:23.000Z (over 6 years ago)
- Last Synced: 2025-02-07T23:27:11.750Z (4 months ago)
- Topics: docute, flutter, rating-stars
- Language: Dart
- Homepage: https://osomrating.netlify.com
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# osom_rating
the most fun way to get a rating component for your flutter apps
### Installing
Add the osom_rating to your pubspec.yaml file
```yaml
dependencies:
osom_rating: 0.0.3
```
then install the package using the get command
```bash
flutter packages get
```
### Usage
import it inside your app
```dart
import 'package:osom_rating/osom_rating.dart';
```
then create a new instance of the component
```dart
// by default it will generate five stars
OsomRating();
```
### Options
| Parameter | Default | Description |
| ------------------ | ------------- | -------------------------------------------------------------------------------------------------------------- |
| `rating` | 0 | the rating value |
| `totalStars` | 5 | the quantity of stars to generate |
| `colorStar` | Colors.yellow | the color of the full star |
| `colorEmptyStar` | Colors.black | the color of the empty star |
| `sizeStar` | 60 | the size of the stars |
| `minimunHalfValue` | 5 | the decimal part to considered a star as a half value. 5 means any x.5 value will be considered as a half star |
### Events
| Event | Param |
| ---------------- | ------------------- |
| `onTapped` | current index value |
| `onDoubleTapped` | none |