spark/com.adevinta.spark.components.rating

Package-level declarations

Types

RatingDefault

object RatingDefault

RatingDefaults

object RatingDefaults

RatingLabelSide

enum RatingLabelSide : Enum<RatingLabelSide>

RatingStarState

enum RatingStarState : Enum<RatingStarState>

Enum that represents possible star states.

Functions

RatingDisplay

@Composable

fun RatingDisplay(@FloatRange(from = 0.0, to = 5.0) value: Float, modifier: Modifier = Modifier, size: Dp = RatingDefault.SmallStarSize)

A display for a rating value.

RatingFull

@Composable

fun RatingFull(@FloatRange(from = 0.0, to = 5.0) value: Float, modifier: Modifier = Modifier, commentCount: Int? = null, label: String? = null, locale: Locale? = firstLocale())

Display the value rating of an user with stars optionally followed by a label and/or commentCount in the following form 3,4 ★★★☆☆ Communication (5)

RatingInput

@Composable

fun RatingInput(@IntRange(from = 0, to = 5) value: Int, onRatingChanged: (Int) -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, stateDescription: (Int) -> String = { "$it stars" }, allowSemantics: Boolean = true, testTag: String? = null)

A rating input component that allows the user to select a rating from 0 to 5. This component can have it's value changed either by a tap on the star or dragging horizontally.

RatingSimple

@Composable

fun RatingSimple(@FloatRange(from = 0.0, to = 5.0) value: Float, modifier: Modifier = Modifier, commentCount: Int? = null, locale: Locale = firstLocale(), labelSide: RatingLabelSide = RatingDefault.LabelSide)

Component that displays a compressed version of user rating

RatingSimpleLarge

@Composable

fun RatingSimpleLarge(@FloatRange(from = 0.0, to = 5.0) value: Float, modifier: Modifier = Modifier, locale: Locale = firstLocale(), labelSide: RatingLabelSide = RatingDefault.LabelSide)

This function displays a large simple version of user rating.

RatingStar

@Composable

fun RatingStar(modifier: Modifier = Modifier, size: Dp = RatingDefault.SmallStarSize, state: RatingStarState = RatingStarState(1), enabled: Boolean = true)

RatingStar is the atomic element of rating components

RatingStarState

fun RatingStarState(isFilled: Boolean): RatingStarState

Return corresponding RatingStarState based on a Boolean representation

fun RatingStarState(@FloatRange(from = 0.0, to = 1.0) starValue: Double): RatingStarState

Return corresponding RatingStarState based on a Double representation

fun RatingStarState(@FloatRange(from = 0.0, to = 1.0) starValue: Float): RatingStarState

Return corresponding RatingStarState based on a Float representation

fun RatingStarState(@IntRange(from = 0, to = 1) starValue: Int): RatingStarState

Return corresponding RatingStarState based on a Int representation