Toolbar

Groups actions and inputs under one roving-focus keyboard model.

Loading interactive demo…

func ToolbarExample() *ui.Element {
	toolbar := ui.NewToolbar(ui.ToolbarRootProps{Items: []ui.ComponentItem{{Value: "select"}, {Value: "draw"}}, DefaultActive: "select"})
	return toolbar.Root().Children(
		toolbar.Item(ui.ToolbarItemProps{Value: "select"}).Child("Select"),
		toolbar.Item(ui.ToolbarItemProps{Value: "draw"}).Child("Draw"),
	)
}

#Import

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

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

#Usage

func ToolbarExample() *ui.Element {
	toolbar := ui.NewToolbar(ui.ToolbarRootProps{Items: []ui.ComponentItem{{Value: "select"}, {Value: "draw"}}, DefaultActive: "select"})
	return toolbar.Root().Children(
		toolbar.Item(ui.ToolbarItemProps{Value: "select"}).Child("Select"),
		toolbar.Item(ui.ToolbarItemProps{Value: "draw"}).Child("Draw"),
	)
}

#Anatomy

toolbar.Root
toolbar.Item
toolbar.Button
toolbar.Link
toolbar.Input
toolbar.Group
toolbar.Separator

#API reference

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

`NewToolbar`

View source

ui.NewToolbar(props ...ToolbarRootProps) *ToolbarComponent

NewToolbar declares a Toolbar 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

Activefunc() *string—

Controlled item holding the active or roving focus state.

func() *string

View source

DefaultActivestring—

Initial active item for an uncontrolled component.

string

View source

Orientationstring—

Direction used for layout and keyboard navigation.

string

View source

LoopFocus*bool—

Wraps keyboard highlight at the ends of the current menu level.

*bool

View source

OnActiveChangefunc(string, *native.Event)—

Reports the item that now owns the roving focus state.

func(string, *native.Event)

View source

`Toolbar.Disabled`

View source

toolbar.Disabled(value any) *ToolbarComponent

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

`Toolbar.Items`

View source

toolbar.Items(value []ComponentItem) *ToolbarComponent

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

`Toolbar.Active`

View source

toolbar.Active(value any) *ToolbarComponent

Controlled item holding the active or roving focus state.

`Toolbar.DefaultActive`

View source

toolbar.DefaultActive(value string) *ToolbarComponent

Initial active item for an uncontrolled component.

`Toolbar.Orientation`

View source

toolbar.Orientation(value string) *ToolbarComponent

Direction used for layout and keyboard navigation.

`Toolbar.LoopFocus`

View source

toolbar.LoopFocus(value bool) *ToolbarComponent

Wraps keyboard highlight at the ends of the current menu level.

`Toolbar.OnActiveChange`

View source

toolbar.OnActiveChange(value func(string, *native.Event)) *ToolbarComponent

Reports the item that now owns the roving focus state.

`Toolbar.Root`

View source

toolbar.Root() *Element

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

`Toolbar.Item`

View source

toolbar.Item(options ...ToolbarItemProps) *Element

Configures item 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

Valuestring—

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

string

View source

`Toolbar.Button`

View source

toolbar.Button(options ...ToolbarItemProps) *Element

Configures button 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

Valuestring—

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

string

View source

`Toolbar.Link`

View source

toolbar.Link(options ...ToolbarItemProps) *Element

Configures link 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

Valuestring—

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

string

View source

`Toolbar.Input`

View source

toolbar.Input(options ...ToolbarInputProps) *Element

Configures input 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

Typestring—

Input editing mode for this control.

string

View source

Valueany—

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

any

View source

Placeholderstring—

Hint displayed while the text value is empty.

string

View source

Multilinebool—

Allows multiple lines in the core text editor.

bool

View source

OnInputfunc(*native.Event)—

Receives edits from the text control. Write the new text into the controlled value.

func(*native.Event)

View source

OnChangefunc(*native.Event)—

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

func(*native.Event)

View source

OnSubmitfunc(*native.Event)—

Called when the control submits its current value.

func(*native.Event)

View source

PartValuestring—

Stable value associated with an item or panel. Matching values connect related parts.

string

View source

Elementstring—

Retained native element used by this component part.

string

View source

`Toolbar.Group`

View source

toolbar.Group(options ...PartProps) *Element

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

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

`Toolbar.Separator`

View source

toolbar.Separator(options ...PartProps) *Element

Configures separator 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