Skip to main content

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
LabelText shown above the stars, or beside them when Layout is horizontal.Text. Default: Rating
ExtraHelp text shown under the field. A validation message replaces it while the value is not valid.Text
TooltipText shown from an info icon after the label.Text
LayoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.vertical, horizontal. Default: vertical
ValueNumber 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
CountNumber of stars shown, from 1 to 20.Number. Default: 5
Allow halfLets the user pick half stars.On or off. Default: Off
Allow clearClears the rating when the user clicks the star that is already picked.On or off. Default: On
TooltipsText 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
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets 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 desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows 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 changeTriggers 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 valueSets the rating to the given Value.components.rate1.setFieldValue("")
Reset fieldSets the rating back to the Value property.components.rate1.resetFields()
Set visibilityShows the component when true, hides it when false.components.rate1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.rate1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.rate1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the stars, or beside them when Layout is horizontal.{{components.rate1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is not valid.{{components.rate1.extra}}
tooltipText shown from an info icon after the label.{{components.rate1.tooltip}}
layoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.{{components.rate1.layout}}
valueNumber 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}}
countNumber of stars shown, from 1 to 20.{{components.rate1.count}}
allowHalfLets the user pick half stars.{{components.rate1.allowHalf}}
allowClearClears the rating when the user clicks the star that is already picked.{{components.rate1.allowClear}}
tooltipsText shown when hovering each star, one per star, such as ['Bad', 'Poor', 'Okay', 'Good', 'Great'].{{components.rate1.tooltips}}
isVisibleWhether the component is visible.{{components.rate1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.rate1.isLoading}}
isDisabledWhether the component is disabled.{{components.rate1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 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.