diff --git a/docs/docs/widgets/icon.md b/docs/docs/widgets/icon.md index 3301fdd8d7..e4d7aa3278 100644 --- a/docs/docs/widgets/icon.md +++ b/docs/docs/widgets/icon.md @@ -1,21 +1,21 @@ --- id: icon -title: Icon +title: Icon --- An **Icon** widget can be used to add icons(sourced from icon library). It supports events like on hover and on click. -
+
## Properties -|
Properties
|
Description
|
Expected Value
| -|:----------- |:----------- |:-------------- | -| Icon | Use this to choose an icon form the list of available icons | You can also use the search bar in it to look for the icons | +|
Properties
|
Description
|
Expected Value
| +| :----------------------------------------------- | :---------------------------------------------------------- | :---------------------------------------------------------- | +| Icon | Use this to choose an icon form the list of available icons | You can also use the search bar in it to look for the icons |
-
+
## Events @@ -23,10 +23,10 @@ To add an event, click on the Icon widget's configuration handle to open the wid The Icon widget supports the following events: -|
Event
|
Description
| -|:----------- |:----------- | -| On hover | This event is triggered when the cursor is hovered over the icon| -| On click | This event is triggered when the icon is clicked | +|
Event
|
Description
| +| :------------------------------------------ | :--------------------------------------------------------------- | +| On hover | This event is triggered when the cursor is hovered over the icon | +| On click | This event is triggered when the icon is clicked | Just like any other event on ToolJet, you can set multiple handlers for any of the above-mentioned events. @@ -36,20 +36,20 @@ Check [Action Reference](/docs/category/actions-reference) docs to get the detai
-
+
## Component Specific Actions (CSA) Following actions of the component can be controlled using the component specific actions(CSA): -|
Actions
|
Description
|
How To Access
| -|:----------- |:----------- |:--------- | -| setVisibility | You can toggle the visibility of the Icon component via a component-specific action within any event handler. | Employ a RunJS query to execute component-specific actions such as `await components.icon1.setVisibility(false)` | -| click | You can trigger the click action on Icon component via a component-specific action within any event handler. | Employ a RunJS query to execute component-specific actions such as `await components.icon1.click()` | +|
Actions
|
Description
|
How To Access
| +| :-------------------------------------------- | :------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------- | +| setVisibility | You can toggle the visibility of the Icon component via a component-specific action within any event handler. | Employ a RunJS query to execute component-specific actions such as `await components.icon1.setVisibility(false)` | +| click | You can trigger the click action on Icon component via a component-specific action within any event handler. | Employ a RunJS query to execute component-specific actions such as `await components.icon1.click()` |
-
+
## Exposed Variables @@ -57,7 +57,7 @@ There are currently no exposed variables for the component.
-
+
## General @@ -65,29 +65,29 @@ There are currently no exposed variables for the component.
-
+
## Layout -|
Layout
|
Description
|
Expected Value
| -|:--------------- |:----------------------------------------- | :------------------------------------------------------------------------------------------------------------- | -| 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}}` | +|
Layout
|
Description
|
Expected Value
| +| :------------------------------------------- | :------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------- | +| 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}}` |
-
+
## Styles -|
Style
|
Description
|
Expected Value
| -|:----------- |:----------- |:------------- | -| Icon color | You can change the color of the Icon widget by entering the Hex color code or choosing a color of your choice from the color picker. | -| Visibility | This is to control the visibility of the widget. | If `{{false}}` the widget will not visible after the app is deployed. | It can only have boolean values i.e. either `{{true}}` or `{{false}}`. By default, it's set to `{{true}}`. | -| Box shadow | This property adds a shadow to the widget. | You can use different values for box shadow property like offsets, blur, spread, and the color code. | +|
Style
|
Description
|
Expected Value
| +| :------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| Icon color | You can change the color of the Icon widget by entering the Hex color code or choosing a color of your choice from the color picker. | +| Visibility | This is to control the visibility of the widget. | If `{{false}}` the widget will not visible after the app is deployed. | It can only have boolean values i.e. either `{{true}}` or `{{false}}`. By default, it's set to `{{true}}`. | +| Box shadow | This property adds a shadow to the widget. | You can use different values for box shadow property like offsets, blur, spread, and the color code. | :::info -Any property having `Fx` button next to its field can be **programmatically configured**. +Any property having **fx** button next to its field can be **programmatically configured**. ::: -
\ No newline at end of file +