Checkbox

A binary or indeterminate choice with a separately styled indicator.

Loading interactive demo…

func CheckboxExample() *ui.Element {
	checked, setChecked := ui.CreateSignal(false)
	checkbox := ui.NewCheckbox(ui.CheckboxProps{Checked: func() ui.CheckedState {
		return checked()
	}, OnCheckedChange: func(next bool, _ *native.Event) {
		setChecked(next)
	}})
	return checkbox.Root().Children(
		checkbox.Indicator().
			Width(16).Height(16).
			BorderWidth(1).BorderRadius(4).BorderColor("#2563eb").
			Display("flex").AlignItems("center").JustifyContent("center").
			Child(ui.Show(checked, func() *ui.Element {
				return ui.SVG().Value(`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 12 12"><path d="M3 6l2 2 4-4" fill="none" stroke="#2563eb" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round"/></svg>`).Width(12).Height(12)
			})),
		ui.Text("Remember me"),
	)
}

#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 CheckboxExample() *ui.Element {
	checked, setChecked := ui.CreateSignal(false)
	checkbox := ui.NewCheckbox(ui.CheckboxProps{Checked: func() ui.CheckedState {
		return checked()
	}, OnCheckedChange: func(next bool, _ *native.Event) {
		setChecked(next)
	}})
	return checkbox.Root().Children(
		checkbox.Indicator().
			Width(16).Height(16).
			BorderWidth(1).BorderRadius(4).BorderColor("#2563eb").
			Display("flex").AlignItems("center").JustifyContent("center").
			Child(ui.Show(checked, func() *ui.Element {
				return ui.SVG().Value(`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 12 12"><path d="M3 6l2 2 4-4" fill="none" stroke="#2563eb" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round"/></svg>`).Width(12).Height(12)
			})),
		ui.Text("Remember me"),
	)
}

The indicator is unstyled. This example keeps its outline mounted and shows the SVG only when checked. Set ReadOnly: true to preserve focus while preventing value changes from pointer or keyboard activation.

#Anatomy

checkbox.Root
checkbox.Indicator

#API reference

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

`NewCheckbox`

View source

ui.NewCheckbox(props ...CheckboxProps) *CheckboxComponent

NewCheckbox declares a Checkbox 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

Valuestring—

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

string

View source

Parentbool—

Marks a checkbox as a parent whose state is derived from its children.

bool

View source

ChildrenCheckedfunc() []bool—

Reads the checked states used to derive a parent checkbox’s on, off, or mixed state.

func() []bool

View source

ReadOnlybool—

Preserves the current value while keeping the control available for focus and inspection.

bool

View source

Checkedfunc() CheckedState—

Controlled selection state. A checkbox also accepts the indeterminate state where supported.

func() CheckedState

View source

DefaultCheckedCheckedState—

Initial checked state when no controlled Checked accessor is supplied.

CheckedState

View source

OnCheckedChangefunc(bool, *native.Event)—

Reports the next checked state after user interaction.

func(bool, *native.Event)

View source

`Checkbox.Disabled`

View source

checkbox.Disabled(value any) *CheckboxComponent

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

`Checkbox.Value`

View source

checkbox.Value(value string) *CheckboxComponent

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

`Checkbox.Parent`

View source

checkbox.Parent(value bool) *CheckboxComponent

Marks a checkbox as a parent whose state is derived from its children.

`Checkbox.ChildrenChecked`

View source

checkbox.ChildrenChecked(value any) *CheckboxComponent

Reads the checked states used to derive a parent checkbox’s on, off, or mixed state.

`Checkbox.ReadOnly`

View source

checkbox.ReadOnly(value bool) *CheckboxComponent

Preserves the current value while keeping the control available for focus and inspection.

`Checkbox.Checked`

View source

checkbox.Checked(value any) *CheckboxComponent

Controlled selection state. A checkbox also accepts the indeterminate state where supported.

`Checkbox.DefaultChecked`

View source

checkbox.DefaultChecked(value CheckedState) *CheckboxComponent

Initial checked state when no controlled Checked accessor is supplied.

`Checkbox.OnCheckedChange`

View source

checkbox.OnCheckedChange(value func(bool, *native.Event)) *CheckboxComponent

Reports the next checked state after user interaction.

`Checkbox.Root`

View source

checkbox.Root() *Element

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

`Checkbox.Indicator`

View source

checkbox.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