Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs]: Fix documentation for Star Rating component #10943

Merged
merged 3 commits into from
Oct 15, 2024
Merged

[docs]: Fix documentation for Star Rating component #10943

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
255e2aa
Made the desired changes
OlibhiaGhosh Oct 10, 2024
a90e915
Made the further suggested changes
OlibhiaGhosh Oct 11, 2024
333bb4c
Made the default color value changes
OlibhiaGhosh Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Made the further suggested changes
  • Loading branch information
@OlibhiaGhosh
OlibhiaGhosh committed Oct 11, 2024
commit a90e9154c72f51affd6c90c208974ef6f2e026d0
12 changes: 6 additions & 6 deletions docs/docs/widgets/star-rating.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The **Star Rating** component can be used to display as well as input ratings. T
| Label | The text to be used as the label for the star rating. | This field expects a `String` value. |
| Number of stars | Initial number of stars in the list on initial load. `default: 5`. | This field expects an integer value. |
| Default no of selected stars | This property specifies the default count of stars that are selected on the initial load. `default: 5` (integer). | This field expects an integer value. |
| Enable half star | Toggle `on` to allow selection of half stars. `default: false` (bool). | Click on **`fx`** to programmatically define the value `{{true}}` or `{{false}}`. |
| Enable half star | Toggle `on` to allow selection of half stars. `default: false` (bool). | Click on **fx** to programmatically define the value `{{true}}` or `{{false}}`. |
| Tooltips | This is used for displaying informative tooltips on each star, and it is mapped to the index of the star. | `default: []` (array of strings ). |

</div>
Expand Down Expand Up @@ -48,7 +48,7 @@ There are currently no CSA (Component-Specific Actions) implemented to regulate

| <div style={{ width:"100px"}}> Variables </div> | <div style={{ width:"135px"}}> Description </div> | <div style={{ width:"135px"}}> How To Access </div> |
|:----------- |:----------- |:--------- |
| value | This variable holds the value whenever a rating is added on the component. The variable holds a numerical value. | Access the value dynamically using JS: `{{components.colorpicker1.selectedColorHex}}`|
| value | This variable holds the value whenever a rating is added on the component. The variable holds a numerical value. | Access the value dynamically using JS: `{{components.colorpicker1.selectedColorHex}}`.|

</div>

Expand All @@ -69,8 +69,8 @@ Under the <b>General</b> accordion, you can set the value in the string format.

| <div style={{ width:"100px"}}> Layout </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> |
|:--------------- |:----------------------------------------- | :------------------------------------------------------------------------------------------------------------- |
| Show on desktop | Toggle on or off to display desktop view. | You can programmatically determining the value by clicking on **`fx`** to set the value `{{true}}` or `{{false}}` |
| Show on mobile | Toggle on or off to display mobile view. | You can programmatically determining the value by clicking on **`fx`** to set the value `{{true}}` or `{{false}}` |
| Show on desktop | Toggle on or off to display desktop view. | You can programmatically determining the value by clicking on **fx** to set the value `{{true}}` or `{{false}}`. |
| Show on mobile | Toggle on or off to display mobile view. | You can programmatically determining the value by clicking on **fx** to set the value `{{true}}` or `{{false}}`. |

</div>

Expand All @@ -84,7 +84,7 @@ Under the <b>General</b> accordion, you can set the value in the string format.
|:------------ |:-------------|:--------- |
| Star Color | Display color of the star. `default: #ffb400` (color hex). Change color by providing `Hex color code` or choosing one from the picker. | |
RudraPratik30 marked this conversation as resolved.
Show resolved Hide resolved
| Label color | Change the color of label in component by providing `Hex color code` or choosing one from the picker. | |
| Visibility | Toggle on or off to control the visibility of the component. You can programmatically change its value by clicking on the **`fx`** button next to it. If `{{false}}` the component will not be visible after the app is deployed. | By default, it's set to `{{true}}` |
| Disable | This is `off` by default, toggle `on` the switch to lock the component and make it non-functional. You can also programmatically set the value by clicking on the **`fx`** button next to it. If set to `{{true}}`, the component will be locked and becomes non-functional. | By default, its value is set to `{{false}}` |
| Visibility | Toggle on or off to control the visibility of the component. You can programmatically change its value by clicking on the **fx** button next to it. If `{{false}}` the component will not be visible after the app is deployed. | By default, it's set to `{{true}}`. |
| Disable | This is `off` by default, toggle `on` the switch to lock the component and make it non-functional. You can also programmatically set the value by clicking on the **fx** button next to it. If set to `{{true}}`, the component will be locked and becomes non-functional. | By default, its value is set to `{{false}}`. |

</div>
12 changes: 6 additions & 6 deletions docs/versioned_docs/version-2.50.0-LTS/widgets/star-rating.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The **Star Rating** component can be used to display as well as input ratings. T
| Label | The text to be used as the label for the star rating. | This field expects a `String` value. |
| Number of stars | Initial number of stars in the list on initial load. `default: 5`. | This field expects an integer value. |
| Default no of selected stars | This property specifies the default count of stars that are selected on the initial load. `default: 5` (integer). | This field expects an integer value. |
| Enable half star | Toggle `on` to allow selection of half stars. `default: false` (bool). | Click on **`fx`** to programmatically define the value `{{true}}` or `{{false}}`. |
| Enable half star | Toggle `on` to allow selection of half stars. `default: false` (bool). | Click on **fx** to programmatically define the value `{{true}}` or `{{false}}`. |
| Tooltips | This is used for displaying informative tooltips on each star, and it is mapped to the index of the star. | `default: []` (array of strings ). |

</div>
Expand Down Expand Up @@ -48,7 +48,7 @@ There are currently no CSA (Component-Specific Actions) implemented to regulate

| <div style={{ width:"100px"}}> Variables </div> | <div style={{ width:"135px"}}> Description </div> | <div style={{ width:"135px"}}> How To Access </div> |
|:----------- |:----------- |:--------- |
| value | This variable holds the value whenever a rating is added on the component. The variable holds a numerical value. | Access the value dynamically using JS: `{{components.colorpicker1.selectedColorHex}}`|
| value | This variable holds the value whenever a rating is added on the component. The variable holds a numerical value. | Access the value dynamically using JS: `{{components.colorpicker1.selectedColorHex}}`.|

</div>

Expand All @@ -69,8 +69,8 @@ Under the <b>General</b> accordion, you can set the value in the string format.

| <div style={{ width:"100px"}}> Layout </div> | <div style={{ width:"100px"}}> Description </div> | <div style={{ width:"135px"}}> Expected Value </div> |
|:--------------- |:----------------------------------------- | :------------------------------------------------------------------------------------------------------------- |
| Show on desktop | Toggle on or off to display desktop view. | You can programmatically determining the value by clicking on **`fx`** to set the value `{{true}}` or `{{false}}` |
| Show on mobile | Toggle on or off to display mobile view. | You can programmatically determining the value by clicking on **`fx`** to set the value `{{true}}` or `{{false}}` |
| Show on desktop | Toggle on or off to display desktop view. | You can programmatically determining the value by clicking on **fx** to set the value `{{true}}` or `{{false}}`. |
| Show on mobile | Toggle on or off to display mobile view. | You can programmatically determining the value by clicking on **fx** to set the value `{{true}}` or `{{false}}`. |

</div>

Expand All @@ -84,7 +84,7 @@ Under the <b>General</b> accordion, you can set the value in the string format.
|:------------ |:-------------|:--------- |
| Star Color | Display color of the star. `default: #ffb400` (color hex). Change color by providing `Hex color code` or choosing one from the picker. | |
| Label color | Change the color of label in component by providing `Hex color code` or choosing one from the picker. | |
| Visibility | Toggle on or off to control the visibility of the component. You can programmatically change its value by clicking on the **`fx`** button next to it. If `{{false}}` the component will not be visible after the app is deployed. | By default, it's set to `{{true}}` |
| Disable | This is `off` by default, toggle `on` the switch to lock the component and make it non-functional. You can also programmatically set the value by clicking on the **`fx`** button next to it. If set to `{{true}}`, the component will be locked and becomes non-functional. | By default, its value is set to `{{false}}` |
| Visibility | Toggle on or off to control the visibility of the component. You can programmatically change its value by clicking on the **fx** button next to it. If `{{false}}` the component will not be visible after the app is deployed. | By default, it's set to `{{true}}`. |
| Disable | This is `off` by default, toggle `on` the switch to lock the component and make it non-functional. You can also programmatically set the value by clicking on the **fx** button next to it. If set to `{{true}}`, the component will be locked and becomes non-functional. | By default, its value is set to `{{false}}`. |

</div>