Interface: UseTreeEditorReturn\<TRow\>

Defined in: src/tree-editor/use-tree-editor.ts:47

Return value of useTreeEditor — current tree state, change tracking, undo stack, clipboard flag, and command dispatchers for every supported mutation.

Type Parameters

TRow

TRow

Properties

addNode

addNode: (parentId, options?) => string

Defined in: src/tree-editor/use-tree-editor.ts:69

Add a new node under parentId at index. Pass data explicitly or rely on the createNode factory. Returns the new node’s id.

Parameters

parentId

string | null

options?

data?

TRow

id?

string

index?

number

Returns

string

---

canRedo

canRedo: boolean

Defined in: src/tree-editor/use-tree-editor.ts:57

Whether redo is available.

---

canUndo

canUndo: boolean

Defined in: src/tree-editor/use-tree-editor.ts:55

Whether undo is available.

---

changeSet

changeSet: ChangeSet<TRow>

Defined in: src/tree-editor/use-tree-editor.ts:51

Accumulated change set since the last markClean().

---

copy

copy: (id) => void

Defined in: src/tree-editor/use-tree-editor.ts:101

Parameters

id

string

Returns

void

---

cut

cut: (id) => void

Defined in: src/tree-editor/use-tree-editor.ts:100

Parameters

id

string

Returns

void

---

deleteNode

deleteNode: (id) => void

Defined in: src/tree-editor/use-tree-editor.ts:73

Parameters

id

string

Returns

void

---

deleteNodes

deleteNodes: (ids) => number

Defined in: src/tree-editor/use-tree-editor.ts:79

Delete several nodes as a single undoable batch. Ids whose ancestor is also selected are filtered out (the parent already removes them). Returns the count of commands actually executed.

Parameters

ids

string[]

Returns

number

---

execute

execute: (command) => void

Defined in: src/tree-editor/use-tree-editor.ts:113

Execute a raw command (escape hatch for custom commands).

Parameters

command

Command<TRow>

Returns

void

---

getChangeSet

getChangeSet: () => ChangeSet<TRow>

Defined in: src/tree-editor/use-tree-editor.ts:108

Snapshot the current change set.

Returns

ChangeSet<TRow>

---

hasClipboardContent

hasClipboardContent: boolean

Defined in: src/tree-editor/use-tree-editor.ts:63

Whether the internal clipboard has content.

---

indentNode

indentNode: (id) => void

Defined in: src/tree-editor/use-tree-editor.ts:97

Parameters

id

string

Returns

void

---

isDirty

isDirty: boolean

Defined in: src/tree-editor/use-tree-editor.ts:53

true when any structural change is pending.

---

markClean

markClean: () => void

Defined in: src/tree-editor/use-tree-editor.ts:110

Mark the current state as the new clean baseline.

Returns

void

---

moveDown

moveDown: (id) => void

Defined in: src/tree-editor/use-tree-editor.ts:96

Parameters

id

string

Returns

void

---

moveNode

moveNode: (id, newParentId, options?) => void

Defined in: src/tree-editor/use-tree-editor.ts:90

Parameters

id

string

newParentId

string | null

options?

index?

number

position?

"child" | "before" | "after"

Returns

void

---

moveNodes

moveNodes: (ids, newParentId, options?) => number

Defined in: src/tree-editor/use-tree-editor.ts:85

Move several nodes under a new parent as a single undoable batch. Ids whose ancestor is also selected are filtered out. Returns the count of commands actually executed.

Parameters

ids

string[]

newParentId

string | null

options?

position?

"child" | "before" | "after"

Returns

number

---

moveUp

moveUp: (id) => void

Defined in: src/tree-editor/use-tree-editor.ts:95

Parameters

id

string

Returns

void

---

outdentNode

outdentNode: (id) => void

Defined in: src/tree-editor/use-tree-editor.ts:98

Parameters

id

string

Returns

void

---

paste

paste: (targetParentId, index?) => boolean

Defined in: src/tree-editor/use-tree-editor.ts:102

Parameters

targetParentId

string | null

index?

number

Returns

boolean

---

redo

redo: () => void

Defined in: src/tree-editor/use-tree-editor.ts:105

Returns

void

---

redoStack

redoStack: Command<TRow>[]

Defined in: src/tree-editor/use-tree-editor.ts:61

Redo stack, most recent command last.

---

state

state: TreeState<TRow>

Defined in: src/tree-editor/use-tree-editor.ts:49

Current tree state.

---

undo

undo: () => void

Defined in: src/tree-editor/use-tree-editor.ts:104

Returns

void

---

undoStack

undoStack: Command<TRow>[]

Defined in: src/tree-editor/use-tree-editor.ts:59

Undo stack, most recent command last.