Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.86 KB

README.md

File metadata and controls

62 lines (45 loc) · 2.86 KB

Rating Star

A nice-looking new concept for rating bars implemented for Android.

Platform API Download GitHub issues License

The concept looks like a flower with every petal representing a specific rating.
The idea of this project is originally inspired by this concept.

Example

Installation

Add This dependency to your module-level gradle file:

dependencies {
    implementation 'com.github.mohaka:rating-star:0.1.1'
}

For an iOS implementation please check this repository.

Usage

  • Please check the example in the source code for more detailed information, or check the table below for a list of available properties.
<!--You need to provide an id in order to save and restore view state-->
<com.github.mohaka.ratingstar.RatingStar
    android:id="@+id/star"  
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    app:rating="1" />
  • List of available properties:
Attribute Name Default Value Description
app:rating 0 The initial rating of the view.
app:showNumbers true Determines weather to show numbers on the petals of the star.
app:starColor R.attr.primaryColor The color of the star.
app:highlightColor R.attr.accentColor The color of highlighted petals of the star.

Roadmap

The library is still not as elegant as the original concept, so I might work more on adding some animations in my spare time. (But unfortunately since I have another job, I can't give any promises or deadlines).

Contributing

If you encounter a bug or you have a feature in mind please make a pull request and i will merge it as soon as possible, if you can't (for some reason) make a pull request please open an issue and i will happily do respond to it.

Versioning

I use SemVer for versioning. For the versions available, see the tags on this repository.
I will try to provide release notes with future releases.

License

This project is licensed under the Apache-2.0 license - see the LICENSE.md file for more details.