Skip to main content

Interface: TreeCapabilities<T, C>

Type parameters

NameType
Tany
Cextends string = never

Hierarchy

Properties

autoFocus

Optional autoFocus: boolean

Defined in

types.ts:174


canDrag

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

Type declaration

▸ (items): boolean

Parameters
NameType
itemsTreeItem<T>[]
Returns

boolean

Defined in

types.ts:168


canDragAndDrop

Optional canDragAndDrop: boolean

Defined in

types.ts:164


canDropAt

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

Type declaration

▸ (items, target): boolean

Parameters
NameType
itemsTreeItem<T>[]
targetDraggingPosition
Returns

boolean

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.

Defined in

types.ts:195


canDropOnFolder

Optional canDropOnFolder: boolean

Defined in

types.ts:165


canDropOnNonFolder

Optional canDropOnNonFolder: boolean

Defined in

types.ts:166


canInvokePrimaryActionOnItemContainer

Optional canInvokePrimaryActionOnItemContainer: boolean

Defined in

types.ts:170


canRename

Optional canRename: boolean

Defined in

types.ts:173


canReorderItems

Optional canReorderItems: boolean

Defined in

types.ts:167


canSearch

Optional canSearch: boolean

Defined in

types.ts:171


canSearchByStartingTyping

Optional canSearchByStartingTyping: boolean

Defined in

types.ts:172


defaultInteractionMode

Optional defaultInteractionMode: InteractionMode | InteractionManager<C>

Defined in

types.ts:163


disableArrowKeys

Optional disableArrowKeys: boolean

Defined in

types.ts:197


doesSearchMatchItem

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

Type declaration

▸ (search, item, itemTitle): boolean

Parameters
NameType
searchstring
itemTreeItem<T>
itemTitlestring
Returns

boolean

Defined in

types.ts:175


shouldRenderChildren

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

Type declaration

▸ (item, context): boolean

Parameters
NameType
itemTreeItem<T>
contextTreeItemRenderContext<C>
Returns

boolean

Defined in

types.ts:181


showLiveDescription

Optional showLiveDescription: boolean

Defined in

types.ts:180