Skip to content
Rating - Web Component
The Rating component can be used imported from:
Playground
Parameters
The Web component uses the <z-rating>
tag:
By default, all the parameters are optional or can be set in different, except for the ones marked as required
The parametrization of the component can be done with the following custom HTML params:
Name | Type | Description | Slot | A11y |
---|---|---|---|---|
model | number | The current score of the rating. It can be a number between 0 and 5. | ||
readonly | boolean | If `true`, the rating will be displayed as a score. | ||
disabled | boolean | Blocks the interaction with the input component. | ||
show-score | boolean | If `true`, the rating will be displayed with a score. |
Events
This component has events. Check the documentation about how to use the events.
Name | Payload | Description |
---|---|---|
change | number | Returns the new value of the "value" attribute |
restarted | void | Emitted on value reset |
Slots
This component has slots. Check the documentation about how to use the slots.
Name | Tags | Description |
---|
Parameters use
model
The value
parameter is used to set the value of the rating.
Flags
readonly
The readonly
parameter is used to set the rating in a read-only state.
disabled
The disabled
parameter is used to block the interaction with the component.
show-score
The show-score
parameter is used to display the score of the rating.
Methods
reset()
We can all the reset()
method of the WebComponent in order to reset the value. This will clean the internal states and emit the nullable value with the change
event, plus a restarted
event:
In this example, the button triggers the method:
Value:
undefined
Browser support
Detected engine:
Chromium
Webkit
Gecko