Toggle

toggle · Elements · interactive

A switch.

Import

cpp

#include "gbui/widgets/toggle.hpp"

Nothing is downloaded until you press it.

cpp

[[nodiscard]] bool toggle(Ui& ui, const Interaction& input, std::string_view id, bool on, const ToggleOptions& options = {});

Same contract as the checkbox; the difference is only that a switch reads as "on now" and a checkbox as "will apply".

Option	Type	Default	What it does
`disabled`	`bool`	`false`
`label`	`std::string_view`
`name`	`std::string_view`		What a reader is told this is, when the label is not it. The label by default, which is right whenever there is one. Needed where the words are drawn beside the control rather than by it — a row that lays out its own caption and passes an empty `label` — because then there is nothing for the control to borrow and "switch, on" is all a reader gets.
`width`	`float`	`0.0f`	Zero takes the active design's track and thumb.
`height`	`float`	`0.0f`