Toggle switch
Toggle switch is used to immediately toggle a setting on or off.
On this page
Description
The ToggleSwitch component is a button that toggles between two boolean states. It is meant to be used for settings that should cause an immediate update. If configured with a "src" attribute, the component will make a POST request containing data of the form "value: 0 | 1".
Arguments
Name | Default | Description |
---|---|---|
src |
| String The URL to POST to when the toggle switch is toggled. If |
csrf_token |
| String A CSRF token that will be sent to the server as "authenticity_token" when the toggle switch is toggled. Unused if |
checked |
| Boolean Whether the toggle switch is on or off. |
enabled |
| Boolean Whether or not the toggle switch responds to user input. |
size |
| Symbol What size toggle switch to render. One of |
status_label_position |
| Symbol Which side of the toggle switch to render the status label. One of |
system_arguments | N/A | Hash |