Interface: TreeEnvironmentConfiguration<T, C>

Type parameters

Name	Type
T	any
C	extends string = never

Hierarchy

• TreeRenderProps<T, C>

• TreeCapabilities<T>

• TreeChangeHandlers<T>

• ExplicitDataSource<T>

  ↳ TreeEnvironmentConfiguration

  ↳↳ ControlledTreeEnvironmentProps

Properties

autoFocus

• Optional autoFocus: boolean

Inherited from

TreeCapabilities.autoFocus

Defined in

types.ts:174

---

canDrag

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

Type declaration

▸ (items): boolean

Parameters

Name	Type
items	TreeItem<T>[]

Returns

boolean

Inherited from

TreeCapabilities.canDrag

Defined in

types.ts:168

---

canDragAndDrop

• Optional canDragAndDrop: boolean

Inherited from

TreeCapabilities.canDragAndDrop

Defined in

types.ts:164

---

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

TreeCapabilities.canDropAt

Defined in

types.ts:169

---

canDropBelowOpenFolders

• Optional canDropBelowOpenFolders: boolean

See Issue #148 or the sample at https://rct.lukasbach.com/storybook/?path=/story/core-basic-examples--single-tree?path=/story/core-drag-and-drop-configurability--can-drop-below-open-folders for details.

If enabled, dropping at the bottom of an open folder will drop the items in the parent folder below the hovered item instead of inside the folder at the top.

Inherited from

TreeCapabilities.canDropBelowOpenFolders

Defined in

types.ts:195

---

canDropOnFolder

• Optional canDropOnFolder: boolean

Inherited from

TreeCapabilities.canDropOnFolder

Defined in

types.ts:165

---

canDropOnNonFolder

• Optional canDropOnNonFolder: boolean

Inherited from

TreeCapabilities.canDropOnNonFolder

Defined in

types.ts:166

---

canInvokePrimaryActionOnItemContainer

• Optional canInvokePrimaryActionOnItemContainer: boolean

Inherited from

TreeCapabilities.canInvokePrimaryActionOnItemContainer

Defined in

types.ts:170

---

canRename

• Optional canRename: boolean

Inherited from

TreeCapabilities.canRename

Defined in

types.ts:173

---

canReorderItems

• Optional canReorderItems: boolean

Inherited from

TreeCapabilities.canReorderItems

Defined in

types.ts:167

---

canSearch

• Optional canSearch: boolean

Inherited from

TreeCapabilities.canSearch

Defined in

types.ts:171

---

canSearchByStartingTyping

• Optional canSearchByStartingTyping: boolean

Inherited from

TreeCapabilities.canSearchByStartingTyping

Defined in

types.ts:172

---

defaultInteractionMode

• Optional defaultInteractionMode: InteractionMode | InteractionManager<never>

Inherited from

TreeCapabilities.defaultInteractionMode

Defined in

types.ts:163

---

disableArrowKeys

• Optional disableArrowKeys: boolean

Inherited from

TreeCapabilities.disableArrowKeys

Defined in

types.ts:197

---

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

TreeCapabilities.doesSearchMatchItem

Defined in

types.ts:175

---

getItemTitle

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

Type declaration

▸ (item): string

Parameters

Name	Type
item	TreeItem<T>

Returns

string

Defined in

types.ts:292

---

items

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

Inherited from

ExplicitDataSource.items

Defined in

types.ts:211

---

keyboardBindings

• Optional keyboardBindings: KeyboardBindings

Defined in

types.ts:290

---

liveDescriptors

• Optional liveDescriptors: LiveDescriptors

Defined in

types.ts:291

---

onAbortRenamingItem

• Optional onAbortRenamingItem: (item: TreeItem<T>, treeId: string) => void

Type declaration

▸ (item, treeId): void

Parameters

Name	Type
item	TreeItem<T>
treeId	string

Returns

void

Inherited from

TreeChangeHandlers.onAbortRenamingItem

Defined in

types.ts:223

---

onCollapseItem

• Optional onCollapseItem: (item: TreeItem<T>, treeId: string) => void

Type declaration

▸ (item, treeId): void

Parameters

Name	Type
item	TreeItem<T>
treeId	string

Returns

void

Inherited from

TreeChangeHandlers.onCollapseItem

Defined in

types.ts:224

---

onDrop

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

Type declaration

▸ (items, target): void

Parameters

Name	Type
items	TreeItem<T>[]
target	DraggingPosition

Returns

void

Inherited from

TreeChangeHandlers.onDrop

Defined in

types.ts:232

---

onExpandItem

• Optional onExpandItem: (item: TreeItem<T>, treeId: string) => void

Type declaration

▸ (item, treeId): void

Parameters

Name	Type
item	TreeItem<T>
treeId	string

Returns

void

Inherited from

TreeChangeHandlers.onExpandItem

Defined in

types.ts:225

---

onFocusItem

• Optional onFocusItem: (item: TreeItem<T>, treeId: string, setDomFocus?: boolean) => void

Type declaration

▸ (item, treeId, setDomFocus?): void

Parameters

Name	Type
item	TreeItem<T>
treeId	string
setDomFocus?	boolean

Returns

void

Inherited from

TreeChangeHandlers.onFocusItem

Defined in

types.ts:227

---

onMissingChildren

• Optional onMissingChildren: (itemIds: TreeItemIndex[]) => void

Type declaration

▸ (itemIds): void

Parameters

Name	Type
itemIds	TreeItemIndex[]

Returns

void

Inherited from

TreeChangeHandlers.onMissingChildren

Defined in

types.ts:237

---

onMissingItems

• Optional onMissingItems: (itemIds: TreeItemIndex[]) => void

Type declaration

▸ (itemIds): void

Parameters

Name	Type
itemIds	TreeItemIndex[]

Returns

void

Inherited from

TreeChangeHandlers.onMissingItems

Defined in

types.ts:236

---

onPrimaryAction

• Optional onPrimaryAction: (items: TreeItem<T>, treeId: string) => void

Type declaration

▸ (items, treeId): void

Parameters

Name	Type
items	TreeItem<T>
treeId	string

Returns

void

Inherited from

TreeChangeHandlers.onPrimaryAction

Defined in

types.ts:233

---

onRegisterTree

• Optional onRegisterTree: (tree: TreeConfiguration) => void

Type declaration

▸ (tree): void

Parameters

Name	Type
tree	TreeConfiguration

Returns

void

Inherited from

TreeChangeHandlers.onRegisterTree

Defined in

types.ts:234

---

onRenameItem

• Optional onRenameItem: (item: TreeItem<T>, name: string, treeId: string) => void

Type declaration

▸ (item, name, treeId): void

Parameters

Name	Type
item	TreeItem<T>
name	string
treeId	string

Returns

void

Inherited from

TreeChangeHandlers.onRenameItem

Defined in

types.ts:222

---

onSelectItems

• Optional onSelectItems: (items: TreeItemIndex[], treeId: string) => void

Type declaration

▸ (items, treeId): void

Parameters

Name	Type
items	TreeItemIndex[]
treeId	string

Returns

void

Inherited from

TreeChangeHandlers.onSelectItems

Defined in

types.ts:226

---

onStartRenamingItem

• Optional onStartRenamingItem: (item: TreeItem<T>, treeId: string) => void

Type declaration

▸ (item, treeId): void

Parameters

Name	Type
item	TreeItem<T>
treeId	string

Returns

void

Inherited from

TreeChangeHandlers.onStartRenamingItem

Defined in

types.ts:221

---

onUnregisterTree

• Optional onUnregisterTree: (tree: TreeConfiguration) => void

Type declaration

▸ (tree): void

Parameters

Name	Type
tree	TreeConfiguration

Returns

void

Inherited from

TreeChangeHandlers.onUnregisterTree

Defined in

types.ts:235

---

renderDepthOffset

• Optional renderDepthOffset: number

Inherited from

TreeRenderProps.renderDepthOffset

Defined in

types.ts:136

---

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

TreeRenderProps.renderDragBetweenLine

Defined in

types.ts:122

---

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

TreeRenderProps.renderItem

Defined in

types.ts:76

---

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

TreeRenderProps.renderItemArrow

Defined in

types.ts:93

---

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

TreeRenderProps.renderItemTitle

Defined in

types.ts:86

---

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

TreeRenderProps.renderItemsContainer

Defined in

types.ts:108

---

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

TreeRenderProps.renderLiveDescriptorContainer

Defined in

types.ts:131

---

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

TreeRenderProps.renderRenameInput

Defined in

types.ts:99

---

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

TreeRenderProps.renderSearchInput

Defined in

types.ts:127

---

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

TreeRenderProps.renderTreeContainer

Defined in

types.ts:116

---

shouldRenderChildren

• Optional shouldRenderChildren: (item: TreeItem<T>, context: TreeItemRenderContext<never>) => boolean

Type declaration

▸ (item, context): boolean

Parameters

Name	Type
item	TreeItem<T>
context	TreeItemRenderContext<never>

Returns

boolean

Inherited from

TreeCapabilities.shouldRenderChildren

Defined in

types.ts:181

---

showLiveDescription

• Optional showLiveDescription: boolean

Inherited from

TreeCapabilities.showLiveDescription

Defined in

types.ts:180

---

viewState

• viewState: TreeViewState<C>

Defined in

types.ts:289