Skip to main content

Interface: UncontrolledTreeEnvironmentProps<T, C>

Type parameters

NameType
Tany
Cextends string = never

Hierarchy

Properties

autoFocus

Optional autoFocus: boolean

Inherited from

TreeCapabilities.autoFocus

Defined in

types.ts:177


canDrag

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

Type declaration

▸ (items): boolean

Parameters
NameType
itemsTreeItem<any>[]
Returns

boolean

Inherited from

TreeCapabilities.canDrag

Defined in

types.ts:171


canDragAndDrop

Optional canDragAndDrop: boolean

Inherited from

TreeCapabilities.canDragAndDrop

Defined in

types.ts:167


canDropAt

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

Type declaration

▸ (items, target): boolean

Parameters
NameType
itemsTreeItem<any>[]
targetDraggingPosition
Returns

boolean

Inherited from

TreeCapabilities.canDropAt

Defined in

types.ts:172


canDropOnFolder

Optional canDropOnFolder: boolean

Inherited from

TreeCapabilities.canDropOnFolder

Defined in

types.ts:168


canDropOnNonFolder

Optional canDropOnNonFolder: boolean

Inherited from

TreeCapabilities.canDropOnNonFolder

Defined in

types.ts:169


canInvokePrimaryActionOnItemContainer

Optional canInvokePrimaryActionOnItemContainer: boolean

Inherited from

TreeCapabilities.canInvokePrimaryActionOnItemContainer

Defined in

types.ts:173


canRename

Optional canRename: boolean

Inherited from

TreeCapabilities.canRename

Defined in

types.ts:176


canReorderItems

Optional canReorderItems: boolean

Inherited from

TreeCapabilities.canReorderItems

Defined in

types.ts:170


canSearch

Optional canSearch: boolean

Inherited from

TreeCapabilities.canSearch

Defined in

types.ts:174


canSearchByStartingTyping

Optional canSearchByStartingTyping: boolean

Inherited from

TreeCapabilities.canSearchByStartingTyping

Defined in

types.ts:175


children

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

Defined in

types.ts:342


dataProvider

dataProvider: TreeDataProvider<T>

Inherited from

ImplicitDataSource.dataProvider

Defined in

types.ts:201


defaultInteractionMode

Optional defaultInteractionMode: InteractionMode | InteractionManager<never>

Inherited from

TreeCapabilities.defaultInteractionMode

Defined in

types.ts:166


doesSearchMatchItem

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

Type declaration

▸ (search, item, itemTitle): boolean

Parameters
NameType
searchstring
itemTreeItem<any>
itemTitlestring
Returns

boolean

Inherited from

TreeCapabilities.doesSearchMatchItem

Defined in

types.ts:178


getItemTitle

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

Type declaration

▸ (item): string

Parameters
NameType
itemTreeItem<T>
Returns

string

Defined in

types.ts:341


keyboardBindings

Optional keyboardBindings: KeyboardBindings

Defined in

types.ts:339


liveDescriptors

Optional liveDescriptors: LiveDescriptors

Defined in

types.ts:340


onAbortRenamingItem

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

Type declaration

▸ (item, treeId): void

Parameters
NameType
itemTreeItem<T>
treeIdstring
Returns

void

Inherited from

TreeChangeHandlers.onAbortRenamingItem

Defined in

types.ts:209


onCollapseItem

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

Type declaration

▸ (item, treeId): void

Parameters
NameType
itemTreeItem<T>
treeIdstring
Returns

void

Inherited from

TreeChangeHandlers.onCollapseItem

Defined in

types.ts:210


onDrop

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

Type declaration

▸ (items, target): void

Parameters
NameType
itemsTreeItem<T>[]
targetDraggingPosition
Returns

void

Inherited from

TreeChangeHandlers.onDrop

Defined in

types.ts:214


onExpandItem

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

Type declaration

▸ (item, treeId): void

Parameters
NameType
itemTreeItem<T>
treeIdstring
Returns

void

Inherited from

TreeChangeHandlers.onExpandItem

Defined in

types.ts:211


onFocusItem

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

Type declaration

▸ (item, treeId): void

Parameters
NameType
itemTreeItem<T>
treeIdstring
Returns

void

Inherited from

TreeChangeHandlers.onFocusItem

Defined in

types.ts:213


onMissingChildren

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

Type declaration

▸ (itemIds): void

Parameters
NameType
itemIdsTreeItemIndex[]
Returns

void

Inherited from

TreeChangeHandlers.onMissingChildren

Defined in

types.ts:219


onMissingItems

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

Type declaration

▸ (itemIds): void

Parameters
NameType
itemIdsTreeItemIndex[]
Returns

void

Inherited from

TreeChangeHandlers.onMissingItems

Defined in

types.ts:218


onPrimaryAction

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

Type declaration

▸ (items, treeId): void

Parameters
NameType
itemsTreeItem<T>
treeIdstring
Returns

void

Inherited from

TreeChangeHandlers.onPrimaryAction

Defined in

types.ts:215


onRegisterTree

Optional onRegisterTree: (tree: TreeConfiguration) => void

Type declaration

▸ (tree): void

Parameters
NameType
treeTreeConfiguration
Returns

void

Inherited from

TreeChangeHandlers.onRegisterTree

Defined in

types.ts:216


onRenameItem

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

Type declaration

▸ (item, name, treeId): void

Parameters
NameType
itemTreeItem<T>
namestring
treeIdstring
Returns

void

Inherited from

TreeChangeHandlers.onRenameItem

Defined in

types.ts:208


onSelectItems

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

Type declaration

▸ (items, treeId): void

Parameters
NameType
itemsTreeItemIndex[]
treeIdstring
Returns

void

Inherited from

TreeChangeHandlers.onSelectItems

Defined in

types.ts:212


onStartRenamingItem

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

Type declaration

▸ (item, treeId): void

Parameters
NameType
itemTreeItem<T>
treeIdstring
Returns

void

Inherited from

TreeChangeHandlers.onStartRenamingItem

Defined in

types.ts:207


onUnregisterTree

Optional onUnregisterTree: (tree: TreeConfiguration) => void

Type declaration

▸ (tree): void

Parameters
NameType
treeTreeConfiguration
Returns

void

Inherited from

TreeChangeHandlers.onUnregisterTree

Defined in

types.ts:217


renderDepthOffset

Optional renderDepthOffset: number

Inherited from

TreeRenderProps.renderDepthOffset

Defined in

types.ts:139


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
NameType
propsObject
props.draggingPositionDraggingPosition
props.linePropsHTMLProps<any>
Returns

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

Inherited from

TreeRenderProps.renderDragBetweenLine

Defined in

types.ts:125


renderDraggingItem

Optional renderDraggingItem: (props: { items: TreeItem<T>[] }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

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

Parameters
NameType
propsObject
props.itemsTreeItem<T>[]
Returns

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

Inherited from

TreeRenderProps.renderDraggingItem

Defined in

types.ts:105


renderDraggingItemTitle

Optional renderDraggingItemTitle: (props: { items: TreeItem<T>[] }) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

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

Parameters
NameType
propsObject
props.itemsTreeItem<T>[]
Returns

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

Inherited from

TreeRenderProps.renderDraggingItemTitle

Defined in

types.ts:109


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
NameType
propsObject
props.arrowReactNode
props.childrenReactNode
props.contextTreeItemRenderContext<C>
props.depthnumber
props.infoTreeInformation
props.itemTreeItem<T>
props.titleReactNode
Returns

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

Inherited from

TreeRenderProps.renderItem

Defined in

types.ts:73


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
NameType
propsObject
props.contextTreeItemRenderContext<C>
props.infoTreeInformation
props.itemTreeItem<T>
Returns

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

Inherited from

TreeRenderProps.renderItemArrow

Defined in

types.ts:90


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
NameType
propsObject
props.contextTreeItemRenderContext<C>
props.infoTreeInformation
props.itemTreeItem<T>
props.titlestring
Returns

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

Inherited from

TreeRenderProps.renderItemTitle

Defined in

types.ts:83


renderItemsContainer

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

Type declaration

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

Parameters
NameType
propsObject
props.childrenReactNode
props.containerPropsHTMLProps<any>
props.infoTreeInformation
Returns

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

Inherited from

TreeRenderProps.renderItemsContainer

Defined in

types.ts:113


renderLiveDescriptorContainer

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

Type declaration

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

Parameters
NameType
propsObject
props.childrenReactNode
props.treeTreeConfiguration
Returns

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

Inherited from

TreeRenderProps.renderLiveDescriptorContainer

Defined in

types.ts:134


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
NameType
propsObject
props.formPropsFormHTMLAttributes<HTMLFormElement>
props.inputPropsInputHTMLAttributes<HTMLInputElement>
props.inputRefRef<HTMLInputElement>
props.itemTreeItem<T>
props.submitButtonPropsHTMLProps<any>
props.submitButtonRefRef<any>
Returns

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

Inherited from

TreeRenderProps.renderRenameInput

Defined in

types.ts:96


renderSearchInput

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

Type declaration

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

Parameters
NameType
propsObject
props.inputPropsHTMLProps<HTMLInputElement>
Returns

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

Inherited from

TreeRenderProps.renderSearchInput

Defined in

types.ts:130


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
NameType
propsObject
props.childrenReactNode
props.containerPropsHTMLProps<any>
props.infoTreeInformation
Returns

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

Inherited from

TreeRenderProps.renderTreeContainer

Defined in

types.ts:119


showLiveDescription

Optional showLiveDescription: boolean

Inherited from

TreeCapabilities.showLiveDescription

Defined in

types.ts:183


viewState

viewState: TreeViewState<C>

Defined in

types.ts:338