Toggle

A pressable control that retains an on or off pressed state.

Loading interactive demo…

func ToggleExample() *ui.Element {
	on, setOn := ui.CreateSignal(false)
	toggle := ui.NewToggle(ui.ToggleProps{Pressed: on, OnPressedChange: func(next bool, _ *native.Event) {
		setOn(next)
	}})
	return toggle.Root().Children(
		toggle.Indicator(),
		ui.Text("Notifications"),
	)
}

#Import

Import ui from github.com/egoist/quickgui/go/ui.

import (
	"github.com/egoist/quickgui/go/native"
	"github.com/egoist/quickgui/go/ui"
)

#Usage

func ToggleExample() *ui.Element {
	on, setOn := ui.CreateSignal(false)
	toggle := ui.NewToggle(ui.ToggleProps{Pressed: on, OnPressedChange: func(next bool, _ *native.Event) {
		setOn(next)
	}})
	return toggle.Root().Children(
		toggle.Indicator(),
		ui.Text("Notifications"),
	)
}

#Anatomy

toggle.Root
toggle.Indicator

#API reference

Expand an entry for its description and complete signature. A dash means no declaration default is documented.

`NewToggle`

View source

ui.NewToggle(props ...ToggleProps) *ToggleComponent

NewToggle declares a Toggle instance. Optional props provide initial settings.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

View source

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

View source

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

View source

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

View source

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

View source

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

View source

Groupany—

Names this element as a group for descendant interaction-state styling.

any

View source

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

View source

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

View source

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

View source

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

View source

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

View source

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

View source

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

View source

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

View source

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

View source

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

View source

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

View source

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

View source

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

View source

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

View source

Pressedfunc() bool—

Controlled pressed state of a toggle.

func() bool

View source

DefaultPressedbool—

Initial pressed state for an uncontrolled toggle.

bool

View source

OnPressedChangefunc(bool, *native.Event)—

Reports the next pressed state after activation.

func(bool, *native.Event)

View source

`Toggle.Disabled`

View source

toggle.Disabled(value any) *ToggleComponent

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

`Toggle.Pressed`

View source

toggle.Pressed(value any) *ToggleComponent

Controlled pressed state of a toggle.

`Toggle.DefaultPressed`

View source

toggle.DefaultPressed(value bool) *ToggleComponent

Initial pressed state for an uncontrolled toggle.

`Toggle.OnPressedChange`

View source

toggle.OnPressedChange(value func(bool, *native.Event)) *ToggleComponent

Reports the next pressed state after activation.

`Toggle.Root`

View source

toggle.Root() *Element

Configures root for this part. The declared type and source define the accepted value.

`Toggle.Indicator`

View source

toggle.Indicator(options ...PartProps) *Element

Configures indicator for this part. The declared type and source define the accepted value.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)

View source

Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any

View source

ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren

View source

Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any

View source

Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string

View source

FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any

View source

Groupany—

Names this element as a group for descendant interaction-state styling.

any

View source

AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any

View source

TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64

View source

OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)

View source

OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)

View source

OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)

View source

OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)

View source

OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)

View source

OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)

View source

OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)

View source

OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)

View source

OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)

View source

OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)

View source

OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)

View source

OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)

View source

`Element`

View source

part.Child(content).Style(style)

Every part returns a fluent element. Strings, numbers, elements, and deferred child factories compose directly.

ChildChild(child any) *Element—

Child appends content and returns this element. Content can be an element, native node, scalar, accessor, or node-returning construction callback.

Child(child any) *Element

View source

ChildrenChildren(children ...any) *Element—

Children appends multiple children in order without replacing existing content. It also accepts []any, []*Element, and []*native.Node slices as arguments. Read the retained child nodes through element.Node.Children.

Children(children ...any) *Element

View source

StyleStyle(style StyleBuilder) *Element—

Style merges a reusable style. Scalar accessors retain independent native bindings.

Style(style StyleBuilder) *Element

View source

OnClickOnClick(handler func()) *Element—

OnClick handles a click without an unused event parameter.

OnClick(handler func()) *Element

View source

RefRef(handler func(*native.Node)) *Element—

Ref exposes the native handle once at this point in the declaration chain.

Ref(handler func(*native.Node)) *Element

View source