# Rating

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-2c2e46c76a6ef1313f7a2191a5a11c0d6251a7d1%2Fimage%20(455).png?alt=media" alt=""><figcaption></figcaption></figure>

## Basic

#### Default Value

Enter the default number to decide the rate when the widget is loaded. This can also be retrieved from the backend using query or loaded using low-code.

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-f5c4f423b7116942d156c3a455f2d0da7f803edf%2Fimage%20(76).png?alt=media" alt=""><figcaption></figcaption></figure>

#### Max Rating

The value set here will be the maximum rate value for the widget. Any value beyond this will be considered as the maximum rating. Typically, it is 5 for collecting feedback from users.

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-95cd46b76715aca530685d5cc66d6e301e2b3fd3%2Fimage%20(378).png?alt=media" alt=""><figcaption></figcaption></figure>

## Interaction

#### Event Handlers

| Event                                         | Description                                                                                                                                                                                                                                                                                                                                                                     |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <mark style="color:blue;">**`Change`**</mark> | <p>The "Change" event is activated when the value of the widget is changed. When this event triggers, the associated action gets executed.<br><br><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-672dfcc7057f6d8ef62e8b3d953d6023b9a31a4c%2Fimage%20(315).png?alt=media" alt=""></p> |

#### Disabled

Disables the user interaction with the element on the page. It visually indicates that the element is inactive and prevents users from interacting with it when applied. Shows a red-crossed warning symbol and can be customized to disable the widget according to certain conditions using low-code.

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-695f356d5e8bc58072102f50922157508eb6122b%2Fimage%20(224).png?alt=media" alt=""><figcaption><p>Read-only</p></figcaption></figure>

#### Hide

This sets whether the widget has to be displayed on the screen when the program is loaded. This shows/hides the widget both on desktop and mobile devices.

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-4aaa812d0b623487c085a616219a4515138079fb%2Fimage%20(211).png?alt=media" alt="" width="338"><figcaption><p>Set the visibility</p></figcaption></figure>

## Advanced

#### Allow Half Rating Points

The user can pick half rate and submit the value only if this is enabled using the boolean value `True`. For example - the user can click part of the rate start to set 2.5/5.

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-d5fff545b99f775ca567e07a0a5b506738beac49%2Fimage%20(379).png?alt=media" alt=""><figcaption></figcaption></figure>

## Layout

#### Widget Tooltip

This tooltip pops up when the user moves the mouse over the input area of the widget. It is commonly used to hint at the type of input the user needs to provide.

The tooltip will be immediately shown when the user's mouse hovers over the widget, and immediately hides when the user's mouse leaves. This information will be contextual, useful, and informative.

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-89524ae742842de4c5d1c9d12e083378841ab3ae%2Fimage%20(456).png?alt=media" alt=""><figcaption></figcaption></figure>

## Label

Represents the caption for the widget in the user interface. It is recommended to keep the label string short and convey the usage of the widget in the UI

#### Position

| Property | Description                                                                                                                                                                                                                                                                                  |
| :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  `Left`  | <p>Shows the label on the left side of the widget entry<br><br><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-f84aa15799aa2f74b301a6b145e4a266c6dbdd5e%2Fimage%20(458).png?alt=media" alt=""></p> |
|   `Top`  | <p>Shows the label on top of the widget entry<br><br><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-1d81b4b96fe76ba6cc10eec9b109635d373bb87d%2Fimage%20(460).png?alt=media" alt=""><br></p>       |

#### Alignment

| Property | Description                                                                                                                                                                                                                                                                                                     |
| :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  `Left`  | <p>Align the text on the left corner of the label area<br><br><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-f84aa15799aa2f74b301a6b145e4a266c6dbdd5e%2Fimage%20(459).png?alt=media" alt=""></p>                     |
|  `Right` | <p>Align the text on the right corner of the label area near the tree view<br><br><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-4349f2e65a0f2282183f1da514d43ce6a36c75af%2Fimage%20(461).png?alt=media" alt=""></p> |

#### Width

Enter a number value to set the width of the widget. It can be set in terms of pixels and percentage.

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-d9be94a993ae1150c38142b56dedb303a7b487eb%2Fimage%20(94).png?alt=media" alt=""><figcaption></figcaption></figure>

<figure><img src="https://125370873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzdpN2Lz0hzXpnNScDzVt%2Fuploads%2Fgit-blob-9c4ec770d5e987d374a18dc814e06c349e3f7749%2Fimage%20(95).png?alt=media" alt=""><figcaption></figcaption></figure>

## Style

<table><thead><tr><th width="218" align="center">Property</th><th>Description</th></tr></thead><tbody><tr><td align="center">Label</td><td>Set the colour for the label text. Recommended to set in contrast with the background.</td></tr><tr><td align="center">Checked</td><td>Set the colour for the checked or marked review star. It is set to yellow usually.</td></tr><tr><td align="center">Unchecked</td><td>Set the colour for the unchecked or unmarked review star. It is set to light gray or white, usually.</td></tr><tr><td align="center">Margin</td><td>This value is set in terms of "px" number which creates the space between the border and the content of the widget.</td></tr><tr><td align="center">Padding</td><td>This value is set in terms of "px" number which creates the space between the border and outer elements.</td></tr></tbody></table>
