Interface: TreeEnvironmentRef<T, C>

Type parameters

Name	Type
T	any
C	extends string = never

Hierarchy

• TreeEnvironmentChangeActions

• Omit<TreeEnvironmentConfiguration<T, C>, keyof TreeChangeHandlers>

  ↳ TreeEnvironmentRef

Properties

abortProgrammaticDrag

• abortProgrammaticDrag: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeEnvironmentChangeActions.abortProgrammaticDrag

Defined in

types.ts:230

---

activeTreeId

• Optional activeTreeId: string

Defined in

types.ts:245

---

autoFocus

• Optional autoFocus: boolean

Inherited from

Omit.autoFocus

Defined in

types.ts:172

---

canDrag

• Optional canDrag: (items: TreeItem<T>[]) => boolean

Type declaration

▸ (items): boolean

Parameters

Name	Type
items	TreeItem<T>[]

Returns

boolean

Inherited from

Omit.canDrag

Defined in

types.ts:166

---

canDragAndDrop

• Optional canDragAndDrop: boolean

Inherited from

Omit.canDragAndDrop

Defined in

types.ts:162

---

canDropAt

• Optional canDropAt: (items: TreeItem<T>[], target: DraggingPosition) => boolean

Type declaration

▸ (items, target): boolean

Parameters

Name	Type
items	TreeItem<T>[]
target	DraggingPosition

Returns

boolean

Inherited from

Omit.canDropAt

Defined in

types.ts:167

---

canDropOnFolder

• Optional canDropOnFolder: boolean

Inherited from

Omit.canDropOnFolder

Defined in

types.ts:163

---

canDropOnNonFolder

• Optional canDropOnNonFolder: boolean

Inherited from

Omit.canDropOnNonFolder

Defined in

types.ts:164

---

canInvokePrimaryActionOnItemContainer

• Optional canInvokePrimaryActionOnItemContainer: boolean

Inherited from

Omit.canInvokePrimaryActionOnItemContainer

Defined in

types.ts:168

---

canRename

• Optional canRename: boolean

Inherited from

Omit.canRename

Defined in

types.ts:171

---

canReorderItems

• Optional canReorderItems: boolean

Inherited from

Omit.canReorderItems

Defined in

types.ts:165

---

canSearch

• Optional canSearch: boolean

Inherited from

Omit.canSearch

Defined in

types.ts:169

---

canSearchByStartingTyping

• Optional canSearchByStartingTyping: boolean

Inherited from

Omit.canSearchByStartingTyping

Defined in

types.ts:170

---

collapseAll

• collapseAll: (treeId: string) => void

Type declaration

▸ (treeId): void

Parameters

Name	Type
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.collapseAll

Defined in

types.ts:235

---

collapseItem

• collapseItem: (itemId: TreeItemIndex, treeId: string) => void

Type declaration

▸ (itemId, treeId): void

Parameters

Name	Type
itemId	TreeItemIndex
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.collapseItem

Defined in

types.ts:220

---

completeProgrammaticDrag

• completeProgrammaticDrag: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeEnvironmentChangeActions.completeProgrammaticDrag

Defined in

types.ts:231

---

defaultInteractionMode

• Optional defaultInteractionMode: InteractionMode | InteractionManager<never>

Inherited from

Omit.defaultInteractionMode

Defined in

types.ts:161

---

doesSearchMatchItem

• Optional doesSearchMatchItem: (search: string, item: TreeItem<T>, itemTitle: string) => boolean

Type declaration

▸ (search, item, itemTitle): boolean

Parameters

Name	Type
search	string
item	TreeItem<T>
itemTitle	string

Returns

boolean

Inherited from

Omit.doesSearchMatchItem

Defined in

types.ts:173

---

dragAndDropContext

• dragAndDropContext: DragAndDropContextProps<any>

Defined in

types.ts:244

---

expandAll

• expandAll: (treeId: string) => void

Type declaration

▸ (treeId): void

Parameters

Name	Type
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.expandAll

Defined in

types.ts:234

---

expandItem

• expandItem: (itemId: TreeItemIndex, treeId: string) => void

Type declaration

▸ (itemId, treeId): void

Parameters

Name	Type
itemId	TreeItemIndex
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.expandItem

Defined in

types.ts:221

---

focusItem

• focusItem: (itemId: TreeItemIndex, treeId: string) => void

Type declaration

▸ (itemId, treeId): void

Parameters

Name	Type
itemId	TreeItemIndex
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.focusItem

Defined in

types.ts:226

---

focusTree

• focusTree: (treeId: string, autoFocus?: boolean) => void

Type declaration

▸ (treeId, autoFocus?): void

Parameters

Name	Type
treeId	string
autoFocus?	boolean

Returns

void

Inherited from

TreeEnvironmentChangeActions.focusTree

Defined in

types.ts:218

---

getItemTitle

• getItemTitle: (item: TreeItem<T>) => string

Type declaration

▸ (item): string

Parameters

Name	Type
item	TreeItem<T>

Returns

string

Inherited from

Omit.getItemTitle

Defined in

types.ts:258

---

invokePrimaryAction

• invokePrimaryAction: (itemId: TreeItemIndex, treeID: string) => void

Type declaration

▸ (itemId, treeID): void

Parameters

Name	Type
itemId	TreeItemIndex
treeID	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.invokePrimaryAction

Defined in

types.ts:225

---

items

• items: Record<TreeItemIndex, TreeItem<T>>

Inherited from

Omit.items

Defined in

types.ts:192

---

keyboardBindings

• Optional keyboardBindings: KeyboardBindings

Inherited from

Omit.keyboardBindings

Defined in

types.ts:256

---

liveDescriptors

• Optional liveDescriptors: LiveDescriptors

Inherited from

Omit.liveDescriptors

Defined in

types.ts:257

---

moveFocusDown

• moveFocusDown: (treeId: string) => void

Type declaration

▸ (treeId): void

Parameters

Name	Type
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.moveFocusDown

Defined in

types.ts:228

---

moveFocusUp

• moveFocusUp: (treeId: string) => void

Type declaration

▸ (treeId): void

Parameters

Name	Type
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.moveFocusUp

Defined in

types.ts:227

---

moveProgrammaticDragPositionDown

• moveProgrammaticDragPositionDown: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeEnvironmentChangeActions.moveProgrammaticDragPositionDown

Defined in

types.ts:233

---

moveProgrammaticDragPositionUp

• moveProgrammaticDragPositionUp: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeEnvironmentChangeActions.moveProgrammaticDragPositionUp

Defined in

types.ts:232

---

renameItem

• renameItem: (itemId: TreeItemIndex, name: string, treeId: string) => void

Type declaration

▸ (itemId, name, treeId): void

Parameters

Name	Type
itemId	TreeItemIndex
name	string
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.renameItem

Defined in

types.ts:219

---

renderDepthOffset

• Optional renderDepthOffset: number

Inherited from

Omit.renderDepthOffset

Defined in

types.ts:134

---

renderDragBetweenLine

• Optional renderDragBetweenLine: (props: { draggingPosition: DraggingPosition ; lineProps: HTMLProps<any> }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.draggingPosition	DraggingPosition
props.lineProps	HTMLProps<any>

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderDragBetweenLine

Defined in

types.ts:120

---

renderItem

• Optional renderItem: (props: { arrow: ReactNode ; children: ReactNode ; context: TreeItemRenderContext<C> ; depth: number ; info: TreeInformation ; item: TreeItem<T> ; title: ReactNode }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.arrow	ReactNode
props.children	ReactNode
props.context	TreeItemRenderContext<C>
props.depth	number
props.info	TreeInformation
props.item	TreeItem<T>
props.title	ReactNode

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderItem

Defined in

types.ts:74

---

renderItemArrow

• Optional renderItemArrow: (props: { context: TreeItemRenderContext<C> ; info: TreeInformation ; item: TreeItem<T> }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.context	TreeItemRenderContext<C>
props.info	TreeInformation
props.item	TreeItem<T>

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderItemArrow

Defined in

types.ts:91

---

renderItemTitle

• Optional renderItemTitle: (props: { context: TreeItemRenderContext<C> ; info: TreeInformation ; item: TreeItem<T> ; title: string }) => null | string | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | string | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.context	TreeItemRenderContext<C>
props.info	TreeInformation
props.item	TreeItem<T>
props.title	string

Returns

null | string | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderItemTitle

Defined in

types.ts:84

---

renderItemsContainer

• Optional renderItemsContainer: (props: { children: ReactNode ; containerProps: HTMLProps<any> ; depth: number ; info: TreeInformation ; parentId: TreeItemIndex }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.children	ReactNode
props.containerProps	HTMLProps<any>
props.depth	number
props.info	TreeInformation
props.parentId	TreeItemIndex

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderItemsContainer

Defined in

types.ts:106

---

renderLiveDescriptorContainer

• Optional renderLiveDescriptorContainer: (props: { children: ReactNode ; tree: TreeConfiguration }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.children	ReactNode
props.tree	TreeConfiguration

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderLiveDescriptorContainer

Defined in

types.ts:129

---

renderRenameInput

• Optional renderRenameInput: (props: { formProps: FormHTMLAttributes<HTMLFormElement> ; inputProps: InputHTMLAttributes<HTMLInputElement> ; inputRef: Ref<HTMLInputElement> ; item: TreeItem<T> ; submitButtonProps: HTMLProps<any> ; submitButtonRef: Ref<any> }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.formProps	FormHTMLAttributes<HTMLFormElement>
props.inputProps	InputHTMLAttributes<HTMLInputElement>
props.inputRef	Ref<HTMLInputElement>
props.item	TreeItem<T>
props.submitButtonProps	HTMLProps<any>
props.submitButtonRef	Ref<any>

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderRenameInput

Defined in

types.ts:97

---

renderSearchInput

• Optional renderSearchInput: (props: { inputProps: HTMLProps<HTMLInputElement> }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.inputProps	HTMLProps<HTMLInputElement>

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderSearchInput

Defined in

types.ts:125

---

renderTreeContainer

• Optional renderTreeContainer: (props: { children: ReactNode ; containerProps: HTMLProps<any> ; info: TreeInformation }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters

Name	Type
props	Object
props.children	ReactNode
props.containerProps	HTMLProps<any>
props.info	TreeInformation

Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

Omit.renderTreeContainer

Defined in

types.ts:114

---

selectItems

• selectItems: (itemsIds: TreeItemIndex[], treeId: string) => void

Type declaration

▸ (itemsIds, treeId): void

Parameters

Name	Type
itemsIds	TreeItemIndex[]
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.selectItems

Defined in

types.ts:223

---

showLiveDescription

• Optional showLiveDescription: boolean

Inherited from

Omit.showLiveDescription

Defined in

types.ts:178

---

startProgrammaticDrag

• startProgrammaticDrag: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeEnvironmentChangeActions.startProgrammaticDrag

Defined in

types.ts:229

---

toggleItemExpandedState

• toggleItemExpandedState: (itemId: TreeItemIndex, treeId: string) => void

Type declaration

▸ (itemId, treeId): void

Parameters

Name	Type
itemId	TreeItemIndex
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.toggleItemExpandedState

Defined in

types.ts:222

---

toggleItemSelectStatus

• toggleItemSelectStatus: (itemId: TreeItemIndex, treeId: string) => void

Type declaration

▸ (itemId, treeId): void

Parameters

Name	Type
itemId	TreeItemIndex
treeId	string

Returns

void

Inherited from

TreeEnvironmentChangeActions.toggleItemSelectStatus

Defined in

types.ts:224

---

treeEnvironmentContext

• treeEnvironmentContext: TreeEnvironmentContextProps<any, never>

Defined in

types.ts:243

---

treeIds

• treeIds: string[]

Defined in

types.ts:246

---

trees

• trees: Record<string, TreeConfiguration>

Defined in

types.ts:247

---

viewState

• viewState: TreeViewState<C>

Inherited from

Omit.viewState

Defined in

types.ts:255