Blazorise Rating API
Explore the Blazorise Rating API reference for parameters, events, methods, and related types.
For examples and usage guidance, see the Rating documentation.
API
Parameters
| Parameter | Default | Type |
|---|---|---|
Color | Color.Warning | Color |
Specifies the contextual or custom CSS color of the rating icons. | ||
Disabled | false | bool |
Prevent the user interactions and make it appear lighter. | ||
EmptyIcon | Star | object |
Specifies the non-selected icon name. | ||
EmptyIconStyle | Regular | IconStyle? |
Specifies the non-selected icon style. | ||
FullIcon | Star | object |
Specifies the selected icon name. | ||
FullIconStyle | Solid | IconStyle? |
Specifies the selected icon style. | ||
Intent | Warning | Intent |
Specifies the intent of the rating icons. Derived from Color. | ||
MaxValue | 5 | int |
Maximum rating value that is allowed to be selected. Default is 5. | ||
RatingItemsClass | — | string |
User class names for RatingItems, separated by space | ||
RatingItemsStyle | — | string |
User styles for RatingItems. | ||
ReadOnly | false | bool |
Prevent the user interactions and make it appear normal. | ||
SelectedValue | 0 | int |
Specifies the currently selected rating value. | ||
Events
| Event | Type |
|---|---|
GetTooltip | Func<int, RatingTooltip> |
Expression that provides the tooltip for the rating item to have additional user-friendly information. The expression receives the rating item Value to determine the result. | |
HoveredValueChanged | EventCallback<int?> |
Occurs after the HoveredValue has changed. | |
SelectedValueChanged | EventCallback<int> |
Occurs after the SelectedValue has changed. | |
Methods
| Method | Return | Parameters |
|---|---|---|
IsHoveredRange | bool | int value |
Indicates if item value is in the hovered range.
| ||
IsSelectedRange | bool | int value |
Indicates if item value is in the selected range.
| ||