Rating

A star rating component that allows users to provide ratings using customizable icons. Features half-star support, custom colors for selected and unselected states, and configurable maximum rating values. Ideal for collecting user feedback or displaying rating scores.


Extends: fieldComponent


Fields

Name

Code

Data Type

Description

Maximum Value

max

text

Maximum rating value allowed

Color

color

text

Color of unselected rating icons

Color Selected

colorSelected

text

Color of selected rating icons

Icon

icon

text

Icon to use for rating units

Icon Half

iconHalf

text

Icon to use for half rating units

Icon Selected

iconSelected

text

Icon to use for selected rating units

Dimming

dimming

boolean

Enables dimming effect for unselected icons

Size

size

text

Size of the rating icons

Label

label

multi-locale

Label for the rating component

ID

resourceId

text

Unique identifier for the component

Style Classes

styleClasses

text

CSS classes for styling

Style

style

text

Inline styles for the component

Width

widthClass

text

Controls component width

Visible

isVisible

boolean

Controls component visibility

Enabled

enabled

boolean

Controls whether component is enabled

Outlined

outlined

text

Shows component with outlined style

Value

value

text

Current rating value


Events

Name

Description

onChange

Triggered when the rating value changes

onBlur

Triggered when the rating component loses focus

onFocus

Triggered when the rating component gains focus