Skip to content

RatingItem


When assigning a rule to a property of RatingItem, the rule will be passed an instance of the following proxy class as an argument:


RatingItem Properties

Property Type Required
IconOff Image No
IconOn Image No
Label string No
Score number No
Styles object No
_Name string No
_Type const No

IconOff

Supported in iOS only. Custom icon to replace default empty star icon.


IconOn

Supported in iOS only. Custom icon to replace default filled star icon.


Label

A label to provide additional information to the rating score, e.g. total votes received for the rating score.

  • type: string

Score

A numeric score to be displayed as stars rating. Supports value from 1-5. Half points are not supported.

  • type: number

Styles

Style to be applied on the RatingItem.

  • type: object with following properties.
Property Type Required Default
Label string No
IconOn string No
IconOff string No
Score string No

Label

The string value is a style class name for Label.

IconOn

The string value is a style class name for IconOn. Only applicable if IconOn property is defined.

IconOff

The string value is a style class name for IconOff. Only applicable if IconOff property is defined.

Score

The string value is a style class name for Score. This style class is applicable to IconOn and IconOff as well if the respective properties do not have custom style defined.


_Name

  • type: string

_Type

  • type: const

The value of this property must be:

"CardHeaderExtendedHeader.Type.Rating"