Rating

This item is for capturing a number value, on a scale starting from 1.

See also the Slider item when the range of values is large.

Preview

../../../_images/rating.png

The rating field consists of selecting icons.

Design

Definition

The standard properties apply:

Property

Definition

Type

The type of item (see above).

Name

The name of the item is not visible. It is a “variable” name that will be associated to the data collected. You will refer to this variable name when writing condition and/or validation scripts.

Label

The label is usually a question or a title.

Description

The description gives some guidance about how to enter data, what are their meaning etc.

Required

Whether an input is mandatory.
Note that this does not apply when the visibility Condition is not satisfied.

The following dynamic properties apply:

Property

Definition

Condition

The condition makes an item visible or not, depending of other data. It is a small script which returns a logical value: true when item is visible.
When no condition is specified (which is the default), the item is visible.

Validation

The validation specifies whether the data entry is correct. It is a small script which returns a logical value: true when item value is valid.
Note that this validation script is not evaluated when the visibility Condition is not satisfied.

Validation error message

The validation error message to be displayed when validation fails.

Settings

Property

Definition

Default

The default value. Make sure it is in the right format.

Maximum

Maximum possible value (starting from 1).

Style

Property

Definition

Label class

CSS class to apply to the field label. See How to style a form item?

Icon

The name of the Material Icon to display. Default is star.

Size

Size of the icon in CSS units, including unit name or standard size name (xs|sm|md|lg|xl). Examples: 16px, 2rem, xs, md.

Color

Color name in the color palette.