Skip to content

Latest commit

 

History

History
76 lines (63 loc) · 2.46 KB

README.md

File metadata and controls

76 lines (63 loc) · 2.46 KB
Raw

starreviews

A flutter package for displaying detailed star reviews

Install

dependencies:  
  starreviews: ^1.0.4
$  flutter pub get
import  'package:starreviews/starreviews.dart';

Usage

List<String> _names = ['Star 5', 'Star 4', 'Star 3', 'Star 2', 'Star 1'];  
List<double> _values = [0.5, 0.2, 0.8, 0.5, 0.1];
StarReviews(  
    total: 20,  
    starNames: _names,  
    values: _values,  
    showPercentage: true,  
    average: 3.2,
)
StarReviewsHorizontal(
    total: 30,
    starNames: _names,
    showProgressBarBorder: false,
    valueColor: Colors.black,
    progressBarBackgroundColor: Colors.grey.withOpacity(0.4),
    values: _values,
    showPercentage: true,
    starColor: Colors.black,
    average: 4.2,
)

Customization

Here is a list of properties available to customize the widget:

Name Type Description
total int total numbers of reviews
showHeader bool if false, hides header
showBottom bool if false, hides bottom reviews
showPercentage bool if false, hides rating number
starNames List list of star names (max 5)
percentageStyle TextStyle style applied to percentage
showPercentage bool if false, hides percentage
valueColor Color color of the progressbar
progressBarBackgroundColor Color color of the progress bar background
values List list of review values as double
starSize double the size of the stars
starColor Color the color of the stars
average double the average number that'll be displayed
showProgressBarBorder bool option to hide borders of the progress bar
lineHeight double height of the progress bar
spaceBetween double the space between progress bars

Contributions

Contributions of any kind are more than welcome! Feel free to fork and improve in any way you want, make a pull request, or open an issue.