Rate
Ant Design
The Rate component is Ant Design's star rating. Users give a score by clicking stars, for example to rate a supplier or a support reply.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Label | Text shown above the stars, or beside them when Layout is horizontal. | Text. Default: Rating |
| Extra | Help text shown under the field. A validation message replaces it while the value is not valid. | Text |
| Tooltip | Text shown from an info icon after the label. | Text |
| Layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | vertical, horizontal. Default: vertical |
| Value | Number of stars filled at the start. It's rounded to a whole star, or a half star with Allow half, and capped at Count. | Number. Default: 0 |
| Count | Number of stars shown, from 1 to 20. | Number. Default: 5 |
| Allow half | Lets the user pick half stars. | On or off. Default: Off |
| Allow clear | Clears the rating when the user clicks the star that is already picked. | On or off. Default: On |
| Tooltips | Text shown when hovering each star, one per star, such as ['Bad', 'Poor', 'Okay', 'Good', 'Great']. | Array |
Additional Actions​
Each of these can be switched on or off, or set with a logical expression by clicking fx.
Property | Description | Expected Value |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets the component grow with its content in the running app instead of keeping a fixed height. | On or off. Default: Off |
Devices​
Property | Description | Expected Value |
|---|---|---|
| Show on desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows the component in the mobile layout. | On or off. Default: Off |
Events​
Add a handler from the Events section of the properties panel. See Event Triggers for the steps.
Event | Description |
|---|---|
| On change | Triggers when the rating changes. |
Component Specific Actions (CSA)​
Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.
Action | Description | How To Access |
|---|---|---|
| Set field value | Sets the rating to the given Value. | components.rate1.setFieldValue("") |
| Reset field | Sets the rating back to the Value property. | components.rate1.resetFields() |
| Set visibility | Shows the component when true, hides it when false. | components.rate1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.rate1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.rate1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
label | Text shown above the stars, or beside them when Layout is horizontal. | {{components.rate1.label}} |
extra | Help text shown under the field. A validation message replaces it while the value is not valid. | {{components.rate1.extra}} |
tooltip | Text shown from an info icon after the label. | {{components.rate1.tooltip}} |
layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | {{components.rate1.layout}} |
value | Number of stars filled at the start. It's rounded to a whole star, or a half star with Allow half, and capped at Count. | {{components.rate1.value}} |
count | Number of stars shown, from 1 to 20. | {{components.rate1.count}} |
allowHalf | Lets the user pick half stars. | {{components.rate1.allowHalf}} |
allowClear | Clears the rating when the user clicks the star that is already picked. | {{components.rate1.allowClear}} |
tooltips | Text shown when hovering each star, one per star, such as ['Bad', 'Poor', 'Okay', 'Good', 'Great']. | {{components.rate1.tooltips}} |
isVisible | Whether the component is visible. | {{components.rate1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.rate1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.rate1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 0px 0px 0px #00000040 |
A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.