TreeProps

Defined in: react/components/data/tree.tsx:6

Props for Tree.

Extends

Omit<ComponentProps, "children">

Properties

className?

optional className?: string

Defined in: react/components/types.ts:24

Space-separated class names (currently advisory; no CSS cascade).

Inherited from

ComponentProps.className

data

data: TreeNode[]

Defined in: react/components/data/tree.tsx:8

Forest of top-level nodes. A flat list needs no synthetic root.

disabled?

optional disabled?: boolean

Defined in: react/components/types.ts:52

Marks the widget (and its descendants) as inert: not focusable, ignores key/mouse input, and interactive controls render in a muted style. A disabled container propagates to every control inside it.

Inherited from

ComponentProps.disabled

expanded?

optional expanded?: string[]

Defined in: react/components/data/tree.tsx:14

Expanded node ids. Controlled when onExpandedChange is provided.

focusable?

optional focusable?: boolean

Defined in: react/components/types.ts:40

Allow this widget to take keyboard focus.

Inherited from

ComponentProps.focusable

focusOnClick?

optional focusOnClick?: boolean

Defined in: react/components/types.ts:46

When a click lands on this container (its padding, border, or a non-focusable child), move focus to its first focusable descendant — so clicking a Form/Panel/Box hands focus to its first field. Off by default.

Inherited from

ComponentProps.focusOnClick

guideColor?

optional guideColor?: string

Defined in: react/components/data/tree.tsx:20

Color of the indentation guides. Subtle/muted by default.

hideRoot?

optional hideRoot?: boolean

Defined in: react/components/data/tree.tsx:10

Present each root’s children as the top level (hide the root nodes).

hoverInterest?

optional hoverInterest?: boolean

Defined in: react/components/types.ts:66

Opt-in hint that this widget cares about passive hover movement.

Inherited from

ComponentProps.hoverInterest

id?

optional id?: string

Defined in: react/components/types.ts:22

Stable identifier, handy for tests and lookups.

Inherited from

ComponentProps.id

label?

optional label?: string

Defined in: react/components/types.ts:36

Structural/accessible label (also the tab title inside TabContainer).

Inherited from

ComponentProps.label

onActivate?

optional onActivate?: (node) => void

Defined in: react/components/data/tree.tsx:24

Item activated — Enter, Space, or double-click.

Parameters

node

TreeNode

Returns

void

onClick?

optional onClick?: (ev) => void

Defined in: react/components/types.ts:54

Pointer click.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onClick

onDragEnd?

optional onDragEnd?: (x, y, moved) => void

Defined in: react/components/types.ts:72

Drag released; moved is false for a tap with no movement.

Parameters

x

number

y

number

moved

boolean

Returns

void

Inherited from

ComponentProps.onDragEnd

onDragMove?

optional onDragMove?: (x, y) => void

Defined in: react/components/types.ts:70

Pointer moved while dragging from this widget.

Parameters

x

number

y

number

Returns

void

Inherited from

ComponentProps.onDragMove

onDragStart?

optional onDragStart?: (x, y) => void

Defined in: react/components/types.ts:68

Pointer-drag lifecycle; moved is false for a tap with no movement.

Parameters

x

number

y

number

Returns

void

Inherited from

ComponentProps.onDragStart

onExpandedChange?

optional onExpandedChange?: (expanded) => void

Defined in: react/components/data/tree.tsx:28

The set of expanded ids changed.

Parameters

expanded

string[]

Returns

void

onKey?

optional onKey?: (ev) => void

Defined in: react/components/types.ts:58

Key event while focused; set ev.handled to consume it.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onKey

onMouseDown?

optional onMouseDown?: (ev) => void

Defined in: react/components/types.ts:56

Pointer pressed (any button); the event carries button and x/y.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onMouseDown

onMouseEnter?

optional onMouseEnter?: (ev) => void

Defined in: react/components/types.ts:62

Pointer entered this widget’s region.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onMouseEnter

onMouseLeave?

optional onMouseLeave?: (ev) => void

Defined in: react/components/types.ts:64

Pointer left this widget’s region.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onMouseLeave

onScroll?

optional onScroll?: (ev) => void

Defined in: react/components/types.ts:60

Wheel / scroll event.

Parameters

ev

any

Returns

void

Inherited from

ComponentProps.onScroll

onSelect?

optional onSelect?: (node) => void

Defined in: react/components/data/tree.tsx:22

Selection changed (arrow navigation or single click).

Parameters

node

TreeNode

Returns

void

onToggle?

optional onToggle?: (node, expanded) => void

Defined in: react/components/data/tree.tsx:26

A node was expanded/collapsed.

Parameters

node

TreeNode

expanded

boolean

Returns

void

ref?

optional ref?: Ref<Widget>

Defined in: react/components/types.ts:30

Captures the underlying widget instance (React 19 ref-as-prop). Defaults to the base Widget; narrow it with a cast when you need a subclass field, e.g. ref={inputRef as React.Ref<InputWidget>}.