> For the complete documentation index, see [llms.txt](https://docs.wem.io/platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wem.io/platform/wemtipsandtricks/widgets/advanced-input/on-off-switch.md).

# On/Off switch

The Toggle Switch Widget is a user-friendly component that allows for easy toggling of boolean values. With smooth animations and customizable text, it provides a sleek and interactive solution for controlling settings and preferences.

<div data-full-width="true"><figure><img src="https://1449034948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-L_NpOsk0sjotPXNy29Q%2Fuploads%2F8kJHV289Doqzq40mhfCC%2Fezgif.com-video-to-gif(10).gif?alt=media&amp;token=6f8203b9-556a-4a72-8a94-01c7da046615" alt=""><figcaption></figcaption></figure></div>

### Properties

| Property            | Type               | Description                                                                                                                        |
| ------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| Data field          | datafield, boolean | Use the on/off switch to change the value of this datafield (boolean)                                                              |
| On change           | dropdown           | When the user switches the on/off button, the following actions can be performed: do nothing, refresh screen or execute flowchart. |
| Animation time (ms) | number             | The duration of the animation in milliseconds when switching between on and off. Minimum value: 0. Maximum value: 500.             |
| On text             | expression, text   | Display this text when the switch is 'on'. A long text value results in a large on/off switch                                      |
| Off text            | Expression, text   | Display this text when the switch is 'off'. A long text value results in a large on/off switch.                                    |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.wem.io/platform/wemtipsandtricks/widgets/advanced-input/on-off-switch.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.