Rating
The icons represent the average object rating value through several states: on, off, and half. The states of these icons depict a rating from a scale of one to five.
Type | Resource |
---|---|
Design | Figma |
Mobile | Mobile Storybook |
Code | Gitlab |
Usage
import id.co.biofarma.binduiandroid.components.rating.Rating
Rating(
variant = "stars",
max = 5,
readOnly = true,
disabled = true,
value = currentRating,
onChange = { newRating ->
currentRating = newRating
},
)
Examples
Variant (optional)
Use variant rating by using stars or thumb icon.
Mode (optional)
Use mode to use dark or light
Props
Props | Required | Default | Type | description |
---|---|---|---|---|
id | false | - | string | A unique identifier for the rating. |
variant | false | star | star , thumb | Unique identifier for ratings with a specific icon. |
max | false | 5 | int | The indexes of the items to be added by default. |
value | false | - | int | Value with status rating whose status is active. |
disabled | false | false | boolean | If true, rating will be set to disabled state. |
readOnly | false | false | boolean | If true, the rating will be set to viewed only. |
onChange | false | - | (Int) -> Unit = {} | Callback function to run when the rating is clicked. |