# Toggle Button

## Basic #### Default Value Enter the default boolean-string to set the state of the widget when the widget is loaded. This can also be retrieved from the backend using query or loaded using low-code.

## Interaction #### Event Handlers | Event | Description | | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`Change`** |

The "Change" event is activated when the value of the widget is changed. When this event triggers, the associated action gets executed.

| #### 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.

#### 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.

#### Loading It will be useful when there is a process to be carried out, like running a query to fetch data, before the widget is loaded. The `loading` boolean value can be utilized to show the spinner till the process is complete.

## Advanced #### Show Text | Property | Description | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Text for True |

The string to be displayed when the toggle state is ON

| | Text for False |

The string to be displayed when the toggle state is OFF

| #### Icon for True Choose one from the set of icons that will be displayed as a logo, when the toggle state is ON.

#### Icon for False Choose one from the set of icons that will be displayed as a logo, when the toggle state is OFF.

#### Icon Position | Property | Description | | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Left |

The logo icon is displayed at the left to the widget text

| | Right |

The logo icon is displayed at the left to the widget text

| #### Alignment | Property | Layout | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | |

| `Left` - The content is attached to the left side of the screen | |

| `Center` - The content is placed at the center part of the screen | |

| `Right` - The content is attached to the right side of the screen | |

| Justify - The content is adjusted and justified to the width of the screen. | ## Style #### Show Border Makes the border of the widget visible on the screen. The 'Border Color' and 'Border Width' styles are applied to this when enabled.

Property	Description
Background	Users can change the colour of the text background using this property. It has all the RGB colour ranges to pick from. It is recommended to use a corresponding background colour that shows the font clearly.
Hover Color	Set the background colour for the widget when the user moves the mouse over it.
Box Shadow	The is the colour of the shadow that is generated behind the widget box. The X and Y axis values can be altered such that the shadow can be set to fall anywhere behind the widget area. "x-offset" - a positive number specifies the shadow will be on the right of the box, and a negative number will put the shadow on the left of the box. "y-offset" - a negative one means the shadow will be above the box, and a positive number means the shadow will be below the box. "Blur" - if the number is set to 0 then the shadow will be sharp. It will more blurred as the number goes higher, and the shadow will extend further away. "Color" - sets the colour of the shadow. If the colour is not set, the box shadows are drawn in the foreground colour.
Text	Set the colour of the text. Recommended to set in contrast with the background.
Loader Color	Pick the colour to the loading spinner when the component shows the loader before getting displayed.
Text Transform	This property specifies how to capitalize an element's text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized. MDN web docs
Text Decoration	This property sets the appearance of decorative lines on text. Types are "underline", "overline", "line-though", "overline-underline".
Text Size	Set the size of the text in px value - 12px
Text Weight	Increase or decrease the thickness of the font using the list of numbers from 100-800.
Font Family	Type the name of the font family. The reference to the list of font families can be found here: MDN web docs
Font Style	There are 3 types of styles that can be applied: "normal" - The text is shown normally, no style applied. "italic" - The text is cursive. "oblique" - A sloped version of the normal text.
Border Color	Set the colour to the border lines. The border lines will be shown only if that is enabled.
Margin	This value is set in terms of "px" number which creates the space between the border and the content of the widget.
Padding	This value is set in terms of "px" number which creates the space between the border and outer elements.
Border Radius	This sets the radius of the widget's corners, enabling rounded corners on the widget. This value is defined in "px" terms.
Border Width	Set the thickness of the border of the widget using this value. It is defined using "px" terms.