本文へスキップ
QuickGUI

Checkbox

独立してスタイルできるインジケーターを持つ、二値または不定状態の選択コントロールです。

デモを読み込み中…

#インポート

github.com/egoist/quickgui/go/ui から ui をインポートします。

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

#使い方

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"),
	)
}

インジケーターには既定のスタイルがありません。この例では枠を保持し、選択時だけ SVG を表示します。ReadOnly: true を設定すると、フォーカスを保ちながら、ポインターやキーボード操作による値の変更を防ぎます。

#構成

  • checkbox.Root
  • checkbox.Indicator

#API リファレンス

項目を展開すると説明と完全なシグネチャが表示されます。ダッシュは宣言に既定値が記載されていないことを示します。

NewCheckbox

ソースを見る
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)
ソースを見る
Styleany—

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

any
ソースを見る
ChildrenPartChildren—

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

PartChildren
ソースを見る
Disabledany—

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

any
ソースを見る
Rolestring—

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

string
ソースを見る
FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any
ソースを見る
Groupany—

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

any
ソースを見る
AriaLabelany—

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

any
ソースを見る
TabIndex*float64—

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

*float64
ソースを見る
OnClickfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnDoubleClickfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnContextMenufunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnPointerfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnMouseEnterfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnMouseLeavefunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnMouseDownfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnMouseUpfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnKeyDownfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnKeyUpfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnFocusfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnBlurfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
Valuestring—

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

string
ソースを見る
Parentbool—

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

bool
ソースを見る
ChildrenCheckedfunc() []bool—

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

func() []bool
ソースを見る
ReadOnlybool—

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

bool
ソースを見る
Checkedfunc() CheckedState—

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

func() CheckedState
ソースを見る
DefaultCheckedCheckedState—

Initial checked state when no controlled Checked accessor is supplied.

CheckedState
ソースを見る
OnCheckedChangefunc(bool, *native.Event)—

Reports the next checked state after user interaction.

func(bool, *native.Event)
ソースを見る

Checkbox.Disabled

ソースを見る
checkbox.Disabled(value any) *CheckboxComponent

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

Checkbox.Value

ソースを見る
checkbox.Value(value string) *CheckboxComponent

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

Checkbox.Parent

ソースを見る
checkbox.Parent(value bool) *CheckboxComponent

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

Checkbox.ChildrenChecked

ソースを見る
checkbox.ChildrenChecked(value any) *CheckboxComponent

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

Checkbox.ReadOnly

ソースを見る
checkbox.ReadOnly(value bool) *CheckboxComponent

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

Checkbox.Checked

ソースを見る
checkbox.Checked(value any) *CheckboxComponent

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

Checkbox.DefaultChecked

ソースを見る
checkbox.DefaultChecked(value CheckedState) *CheckboxComponent

Initial checked state when no controlled Checked accessor is supplied.

Checkbox.OnCheckedChange

ソースを見る
checkbox.OnCheckedChange(value func(bool, *native.Event)) *CheckboxComponent

Reports the next checked state after user interaction.

Checkbox.Root

ソースを見る
checkbox.Root() *Element

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

Checkbox.Indicator

ソースを見る
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)
ソースを見る
Styleany—

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

any
ソースを見る
ChildrenPartChildren—

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

PartChildren
ソースを見る
Disabledany—

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

any
ソースを見る
Rolestring—

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

string
ソースを見る
FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any
ソースを見る
Groupany—

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

any
ソースを見る
AriaLabelany—

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

any
ソースを見る
TabIndex*float64—

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

*float64
ソースを見る
OnClickfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnDoubleClickfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnContextMenufunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnPointerfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnMouseEnterfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnMouseLeavefunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnMouseDownfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnMouseUpfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnKeyDownfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnKeyUpfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnFocusfunc(*native.Event)—

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

func(*native.Event)
ソースを見る
OnBlurfunc(*native.Event)—

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

func(*native.Event)
ソースを見る

Element

ソースを見る
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
ソースを見る
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
ソースを見る
StyleStyle(style StyleBuilder) *Element—

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

Style(style StyleBuilder) *Element
ソースを見る
OnClickOnClick(handler func()) *Element—

OnClick handles a click without an unused event parameter. 

OnClick(handler func()) *Element
ソースを見る
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
ソースを見る