跳到正文

Tree

虚拟化层级集合,支持展开、选择和键盘导航。

正在加载交互演示…

#导入

从 github.com/egoist/quickgui/go/ui 导入 ui。

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

#用法

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

#结构

  • tree.Root
  • tree.Row

#API 参考

展开条目查看说明和完整签名。短横线表示声明中未记录默认值。

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)
查看源码
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)
查看源码
Nodesfunc() []TreeNodeDeclaration—

Bounded hierarchical node declarations for the tree.

func() []TreeNodeDeclaration
查看源码
Expandedfunc() []string—

Controlled expanded tree node identifiers.

func() []string
查看源码
DefaultExpanded[]string—

Initially expanded tree nodes for an uncontrolled tree.

[]string
查看源码
Valuefunc() *string—

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

func() *string
查看源码
RowHeightany—

Logical height of each virtualized row.

any
查看源码
LoadingLabelstring—

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

string
查看源码
Disclosurestring—

Controls the disclosure indicator associated with a tree row.

string
查看源码
SetChildrenfunc() *TreeChildrenSplice—

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

func() *TreeChildrenSplice
查看源码
OnExpandedChangefunc([]string, *native.Event)—

Reports the ordered node identifiers expanded by the core.

func([]string, *native.Event)
查看源码
OnValueChangefunc(*string, *native.Event)—

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

func(*string, *native.Event)
查看源码
OnLoadChildrenfunc(string, *native.Event)—

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

func(string, *native.Event)
查看源码
OnVisibleRangeChangefunc(VisibleRange, *native.Event)—

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

func(VisibleRange, *native.Event)
查看源码
OnActivatefunc(string, *native.Event)—

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

func(string, *native.Event)
查看源码

Tree.Disabled

查看源码
tree.Disabled(value any) *TreeComponent

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

Tree.Nodes

查看源码
tree.Nodes(value any) *TreeComponent

Bounded hierarchical node declarations for the tree.

Tree.Expanded

查看源码
tree.Expanded(value any) *TreeComponent

Controlled expanded tree node identifiers.

Tree.DefaultExpanded

查看源码
tree.DefaultExpanded(value []string) *TreeComponent

Initially expanded tree nodes for an uncontrolled tree.

Tree.Value

查看源码
tree.Value(value any) *TreeComponent

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

Tree.RowHeight

查看源码
tree.RowHeight(value any) *TreeComponent

Logical height of each virtualized row.

Tree.LoadingLabel

查看源码
tree.LoadingLabel(value string) *TreeComponent

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

Tree.Disclosure

查看源码
tree.Disclosure(value string) *TreeComponent

Controls the disclosure indicator associated with a tree row.

Tree.SetChildren

查看源码
tree.SetChildren(value any) *TreeComponent

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

Tree.OnExpandedChange

查看源码
tree.OnExpandedChange(value func([]string, *native.Event)) *TreeComponent

Reports the ordered node identifiers expanded by the core.

Tree.OnValueChange

查看源码
tree.OnValueChange(value func(*string, *native.Event)) *TreeComponent

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

Tree.OnLoadChildren

查看源码
tree.OnLoadChildren(value func(string, *native.Event)) *TreeComponent

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

Tree.OnVisibleRangeChange

查看源码
tree.OnVisibleRangeChange(value func(VisibleRange, *native.Event)) *TreeComponent

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

Tree.OnActivate

查看源码
tree.OnActivate(value func(string, *native.Event)) *TreeComponent

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

Tree.Root

查看源码
tree.Root() *Element

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

Tree.Row

查看源码
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)
查看源码
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)
查看源码
NodeIDstring—

Stable identity of the tree node represented by this part.

string
查看源码
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
查看源码