ToggleSwitch: switches

Build switches with ToggleSwitch. This page includes a runnable example, all props, and behavior constraints.

Complete example

Complete environment setup first. Copy this complete main.go and run go run ..

package main

import (
	"fmt"
	"github.com/dxui-org/dxui"
	"log"
)

func main() {
	checked := false
	app := dxui.NewApp(dxui.AppOptions{
		Title:      "ToggleSwitch",
		Width:      640,
		Height:     480,
		Background: dxui.RGBA(248, 250, 252, 255),
	})
	if err := app.Run(func() dxui.View {
		return dxui.Box(
			dxui.BoxProps{
				Gap: 16,
				Style: dxui.Style{
					Padding: dxui.Padding(24),
				},
			},
			dxui.Box(
				dxui.BoxProps{
					Gap: 12,
				},
				dxui.ToggleSwitch(dxui.ToggleSwitchProps{
					Checked:  checked,
					OnChange: dxui.Assign(&checked),
				}),
				dxui.Label(fmt.Sprint(checked)),
			),
		)
	}); err != nil {

		log.Fatal(err)
	}
}

Parameters and API

func ToggleSwitch(props ToggleSwitchProps) View

Field	Type	Purpose, defaults, and constraints
Key	string	Stable unique identity within one parent; empty by default. Use business IDs in dynamic lists, not changing indices.
Style	Style	Local layout, paint, and text styling; zero uses intrinsic sizes and theme defaults.
Token	ComponentToken	Component theme entry; empty selects its default.
States	StateStyles	Paint patches for actual interaction states; cannot fabricate state or change layout.
Pointer	PointerBehavior	Defaults to PointerAuto; PointerNone excludes the entire subtree from pointer participation, unlike Disabled.
Checked	bool	Controlled boolean, default false; accept changes in OnChange.
Disabled	bool	Defaults to false; true removes focus and cancels interaction on interactive components.
OnChange	func(bool)	Proposes a complete new value; write it to state for the next build. See behavior for nil callbacks.

Behavior and limitations

Checked/OnChange follow Checkbox, with pointer or Space proposals. Theme metrics set the default size (40×24 logical units). No built-in text label; compose Text/Label. Nil callbacks retain interaction appearance.

All components share identity, style, and pointer rules. See full declarations for referenced enums, structs, and comments. Running examples explains build verification.