Tree

A virtualized hierarchical collection with expansion, selection, and keyboard navigation.

Loading interactive demo…

func TreeExample() *ui.Element {
	nodes := []ui.TreeNodeDeclaration{{ID: "src", Label: "src", Children: []ui.TreeNodeDeclaration{{ID: "src/main.go", Label: "main.go"}}}}
	tree := ui.NewTree(ui.TreeRootProps{Nodes: func() []ui.TreeNodeDeclaration {
		return nodes
	}, DefaultExpanded: []string{"src"}, RowHeight: 26, PartProps: ui.PartProps{Style: ui.Style().Height(200)}})
	return tree.Root().Children(
		tree.Row(ui.TreeRowProps{NodeID: "src"}).Child("src"),
		tree.Row(ui.TreeRowProps{NodeID: "src/main.go"}).Child("main.go"),
	)
}

#Import

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

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

#Usage

func TreeExample() *ui.Element {
	nodes := []ui.TreeNodeDeclaration{{ID: "src", Label: "src", Children: []ui.TreeNodeDeclaration{{ID: "src/main.go", Label: "main.go"}}}}
	tree := ui.NewTree(ui.TreeRootProps{Nodes: func() []ui.TreeNodeDeclaration {
		return nodes
	}, DefaultExpanded: []string{"src"}, RowHeight: 26, PartProps: ui.PartProps{Style: ui.Style().Height(200)}})
	return tree.Root().Children(
		tree.Row(ui.TreeRowProps{NodeID: "src"}).Child("src"),
		tree.Row(ui.TreeRowProps{NodeID: "src/main.go"}).Child("main.go"),
	)
}

#Anatomy

tree.Root
tree.Row

#API reference

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

`NewTree`

View source

ui.NewTree(props ...TreeRootProps) *TreeComponent

NewTree declares a Tree 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

Nodesfunc() []TreeNodeDeclaration—

Bounded hierarchical node declarations for the tree.

func() []TreeNodeDeclaration

View source

Expandedfunc() []string—

Controlled expanded tree node identifiers.

func() []string

View source

DefaultExpanded[]string—

Initially expanded tree nodes for an uncontrolled tree.

[]string

View source

Valuefunc() *string—

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

func() *string

View source

RowHeightany—

Logical height of each virtualized row.

any

View source

LoadingLabelstring—

Text displayed while a tree node’s children are loading.

string

View source

Disclosurestring—

Controls the disclosure indicator associated with a tree row.

string

View source

SetChildrenfunc() *TreeChildrenSplice—

Callback used to construct and replace the part’s children.

func() *TreeChildrenSplice

View source

OnExpandedChangefunc([]string, *native.Event)—

Reports the ordered node identifiers expanded by the core.

func([]string, *native.Event)

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

OnLoadChildrenfunc(string, *native.Event)—

Callback for load children. The signature below lists the event payload.

func(string, *native.Event)

View source

OnVisibleRangeChangefunc(VisibleRange, *native.Event)—

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

func(VisibleRange, *native.Event)

View source

OnActivatefunc(string, *native.Event)—

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

func(string, *native.Event)

View source

`Tree.Disabled`

View source

tree.Disabled(value any) *TreeComponent

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

`Tree.Nodes`

View source

tree.Nodes(value any) *TreeComponent

Bounded hierarchical node declarations for the tree.

`Tree.Expanded`

View source

tree.Expanded(value any) *TreeComponent

Controlled expanded tree node identifiers.

`Tree.DefaultExpanded`

View source

tree.DefaultExpanded(value []string) *TreeComponent

Initially expanded tree nodes for an uncontrolled tree.

`Tree.Value`

View source

tree.Value(value any) *TreeComponent

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

`Tree.RowHeight`

View source

tree.RowHeight(value any) *TreeComponent

Logical height of each virtualized row.

`Tree.LoadingLabel`

View source

tree.LoadingLabel(value string) *TreeComponent

Text displayed while a tree node’s children are loading.

`Tree.Disclosure`

View source

tree.Disclosure(value string) *TreeComponent

Controls the disclosure indicator associated with a tree row.

`Tree.SetChildren`

View source

tree.SetChildren(value any) *TreeComponent

Callback used to construct and replace the part’s children.

`Tree.OnExpandedChange`

View source

tree.OnExpandedChange(value func([]string, *native.Event)) *TreeComponent

Reports the ordered node identifiers expanded by the core.

`Tree.OnValueChange`

View source

tree.OnValueChange(value func(*string, *native.Event)) *TreeComponent

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

`Tree.OnLoadChildren`

View source

tree.OnLoadChildren(value func(string, *native.Event)) *TreeComponent

Callback for load children. The signature below lists the event payload.

`Tree.OnVisibleRangeChange`

View source

tree.OnVisibleRangeChange(value func(VisibleRange, *native.Event)) *TreeComponent

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

`Tree.OnActivate`

View source

tree.OnActivate(value func(string, *native.Event)) *TreeComponent

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

`Tree.Root`

View source

tree.Root() *Element

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

`Tree.Row`

View source

tree.Row(options ...TreeRowProps) *Element

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

NodeIDstring—

Stable identity of the tree node represented by this part.

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