Skip to content
QuickGUI

ToggleGroup

Coordinates single or multiple pressed values with roving keyboard focus.

Loading interactive demo…

#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 ToggleGroupExample() *ui.Element {
	values, setValues := ui.CreateSignal([]string{"bold"})
	group := ui.NewToggleGroup(ui.ToggleGroupProps{Multiple: true, Value: values, Items: []ui.ComponentItem{{Value: "bold"}, {Value: "italic"}}, OnValueChange: func(next []string, _ *native.Event) {
		setValues(next)
	}})
	return group.Root().Children(
		group.Item("bold").Child("Bold"),
		group.Item("italic").Child("Italic"),
	)
}

#Anatomy

  • toggleGroup.Root
  • toggleGroup.Item

#API reference

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

NewToggleGroup

View source
ui.NewToggleGroup(props ...ToggleGroupProps) *ToggleGroupComponent

NewToggleGroup declares a ToggleGroup 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
Items[]ComponentItem—

Items made available to the control. Use stable item values to preserve selection.

[]ComponentItem
View source
Valuefunc() []string—

The current controlled value. Update application state from the change callback to accept a new value.

func() []string
View source
DefaultValue[]string—

Initial value for uncontrolled state. Use Value when the application should own subsequent changes.

[]string
View source
OnValueChangefunc([]string, *native.Event)—

Reports an accepted value change. Use the callback payload to update controlled state.

func([]string, *native.Event)
View source
Multiplebool—

Allows more than one selected value.

bool
View source

ToggleGroup.Disabled

View source
toggleGroup.Disabled(value any) *ToggleGroupComponent

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

ToggleGroup.Items

View source
toggleGroup.Items(value []ComponentItem) *ToggleGroupComponent

Items made available to the control. Use stable item values to preserve selection.

ToggleGroup.Value

View source
toggleGroup.Value(value any) *ToggleGroupComponent

The current controlled value. Update application state from the change callback to accept a new value.

ToggleGroup.DefaultValue

View source
toggleGroup.DefaultValue(value []string) *ToggleGroupComponent

Initial value for uncontrolled state. Use Value when the application should own subsequent changes.

ToggleGroup.OnValueChange

View source
toggleGroup.OnValueChange(value func([]string, *native.Event)) *ToggleGroupComponent

Reports an accepted value change. Use the callback payload to update controlled state.

ToggleGroup.Multiple

View source
toggleGroup.Multiple(value bool) *ToggleGroupComponent

Allows more than one selected value.

ToggleGroup.Root

View source
toggleGroup.Root() *Element

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

ToggleGroup.Item

View source
toggleGroup.Item(value string, options ...ToggleGroupItemProps) *Element

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

ToggleGroup.ItemWith

View source
toggleGroup.ItemWith(props ToggleGroupItemProps) *Element

ItemWith supplies explicit properties for this part.

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
Valuestring—

The current controlled value. Update application state from the change callback to accept a new value.

string
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