Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
* dev:
  cleanup readme file
  version upgraded since pub.dartlang.org would not allow resource update without incremented version
  screenshots

# Conflicts:
#	README.md
  • Loading branch information
thangmam committed Sep 2, 2018
2 parents cfa0937 + f73a420 commit 2f80afd
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@

A Star rating with touch swipe enabled increment/decrement
* Supports half rate and full rate (1.0 or 0.5)
* Swipe for incrementing/decrementing rate amount
* Change star body and boundary colors independently
* Control size of the star rating
* Set your desired total Star count
## Getting Started

In your flutter project add the dependency:
```
dependencies:
...
smooth_star_rating: ^0.0.4
```

## Usage example
```
import 'package:smooth_star_rating/smooth_star_rating.dart';
```

```java
StarRating(
allowHalfRating: false,
onRatingChanged: (v) {
rating = v;
setState(() {});
},
starCount: 5,
rating: rating,
size: 40.0,
color: Colors.green,
borderColor: Colors.green,
)
```

## Constructor parameters
```
allowHalfRating - Whether to use whole number for rating(1.0 or 0.5)
onRatingChanged(int rating) - Rating changed callback
starCount - The maximum amount of stars
rating - The current value of rating
size - The size of a single star
color - The body color of star
borderColor - The border color of star
```

### Screenshots

#### Full Rating
![alt text](https://raw.githubusercontent.com/thangmam/smoothratingbar/master/screenshots/fullrating.gif "Full rating")

#### Half Rating

![alt text](https://raw.githubusercontent.com/thangmam/smoothratingbar/master/screenshots/halfrating.gif "Half Rating")

0 comments on commit 2f80afd

Please sign in to comment.