Skip to main content

Rate

Rate records a numeric rating with stars and optional labels. It participates in the state, validation, and submission boundary of its Form.

1. When to use it​

Typical uses:

  • Satisfaction scores
  • Quality or priority ratings
  • Fine-grained ratings with half stars

2. Add and configure​

  1. Add Rate to the Fields slot of a Form Section.
  2. Set a stable, unique Field Key / Name that matches the backend DTO property.
  3. Configure the component properties below, then add Required, Help Text, Full row, or conditions as needed.
  4. Check the initial value and layout in Design Preview, then use Form Validate / Submit to test the full data path.

3. Main properties​

PropertyPurpose
Total StarsLimits the allowed count, length, or value range.
Allow HalfEnables or disables this behavior.
Allow ClearEnables or disables this behavior.
Default ValueSets the initial value, content, or format used by the field.
TooltipsControls how the field is displayed in Design Preview and Runtime.

Common properties such as Field Key, Required, Help Text, Full row, and Visible When come from the Form field contract. The table highlights the settings most relevant to Rate.

4. Form value and backend contract​

Submitted value: A number.

4.5

The example shows the data shape only. The API must still validate type, range, and authorization against its business DTO.

5. Validation, conditions, and interactions​

Every field can use Form properties such as Required, Visible When, Disabled When, Required When, Dependencies, and Clear When Hidden. Conditions improve interaction but never replace backend validation or authorization.

Component capabilities: Supports onChange, onFocus, and setValue.

6. Recommendations​

Recommendations: Validate minimum, maximum, and precision on both client and server. Visual marks never replace submission validation.

Return to the Form overview for layout, validation, submission, drafts, and backend protocol guidance.

Last updated on