Interface: ControlledTreeEnvironmentProps<T, C>

Type parameters

Name	Type
T	any
C	extends string = never

Hierarchy

• TreeEnvironmentConfiguration<T, C>

  ↳ ControlledTreeEnvironmentProps

Properties

autoFocus

• Optional autoFocus: boolean

Inherited from

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.canDrag

Defined in

types.ts:168

---

canDragAndDrop

• Optional canDragAndDrop: boolean

Inherited from

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.canDropBelowOpenFolders

Defined in

types.ts:195

---

canDropOnFolder

• Optional canDropOnFolder: boolean

Inherited from

TreeEnvironmentConfiguration.canDropOnFolder

Defined in

types.ts:165

---

canDropOnNonFolder

• Optional canDropOnNonFolder: boolean

Inherited from

TreeEnvironmentConfiguration.canDropOnNonFolder

Defined in

types.ts:166

---

canInvokePrimaryActionOnItemContainer

• Optional canInvokePrimaryActionOnItemContainer: boolean

Inherited from

TreeEnvironmentConfiguration.canInvokePrimaryActionOnItemContainer

Defined in

types.ts:170

---

canRename

• Optional canRename: boolean

Inherited from

TreeEnvironmentConfiguration.canRename

Defined in

types.ts:173

---

canReorderItems

• Optional canReorderItems: boolean

Inherited from

TreeEnvironmentConfiguration.canReorderItems

Defined in

types.ts:167

---

canSearch

• Optional canSearch: boolean

Inherited from

TreeEnvironmentConfiguration.canSearch

Defined in

types.ts:171

---

canSearchByStartingTyping

• Optional canSearchByStartingTyping: boolean

Inherited from

TreeEnvironmentConfiguration.canSearchByStartingTyping

Defined in

types.ts:172

---

children

• Optional children: null | Element | (null | Element)[]

Defined in

types.ts:371

---

defaultInteractionMode

• Optional defaultInteractionMode: InteractionMode | InteractionManager<never>

Inherited from

TreeEnvironmentConfiguration.defaultInteractionMode

Defined in

types.ts:163

---

disableArrowKeys

• Optional disableArrowKeys: boolean

Inherited from

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.doesSearchMatchItem

Defined in

types.ts:175

---

getItemTitle

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

Type declaration

▸ (item): string

Parameters

Name	Type
item	TreeItem<T>

Returns

string

Inherited from

TreeEnvironmentConfiguration.getItemTitle

Defined in

types.ts:292

---

items

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

Inherited from

TreeEnvironmentConfiguration.items

Defined in

types.ts:211

---

keyboardBindings

• Optional keyboardBindings: KeyboardBindings

Inherited from

TreeEnvironmentConfiguration.keyboardBindings

Defined in

types.ts:290

---

liveDescriptors

• Optional liveDescriptors: LiveDescriptors

Inherited from

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.onUnregisterTree

Defined in

types.ts:235

---

renderDepthOffset

• Optional renderDepthOffset: number

Inherited from

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.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

TreeEnvironmentConfiguration.shouldRenderChildren

Defined in

types.ts:181

---

showLiveDescription

• Optional showLiveDescription: boolean

Inherited from

TreeEnvironmentConfiguration.showLiveDescription

Defined in

types.ts:180

---

viewState

• viewState: TreeViewState<C>

Inherited from

TreeEnvironmentConfiguration.viewState

Defined in

types.ts:289