Skip to main content

react-complex-tree

Enumerations​

Classes​

Interfaces​

Type Aliases​

AllTreeRenderProps​

Ƭ AllTreeRenderProps<T, C>: Required<TreeRenderProps<T, C>>

Type parameters​

NameType
Tany
Cextends string = never

Defined in​

types.ts:139

DataSource​

Ƭ DataSource<T>: ExplicitDataSource<T> | ImplicitDataSource<T>

Type parameters​

NameType
Tany

Defined in​

types.ts:218

Disposable​

Ƭ Disposable: Object

Type declaration​

NameType
dispose() => void

Defined in​

types.ts:458

DraggingPosition​

Ƭ DraggingPosition: DraggingPositionItem | DraggingPositionBetweenItems | DraggingPositionRoot

Defined in​

types.ts:337

HoveringPosition​

Ƭ HoveringPosition: Object

Type declaration​

NameType
indentationnumber | undefined
linearIndexnumber
offset"bottom" | "top" | undefined

Defined in​

types.ts:529

IndividualTreeViewState​

Ƭ IndividualTreeViewState<C>: { expandedItems?: TreeItemIndex[] ; focusedItem?: TreeItemIndex ; selectedItems?: TreeItemIndex[] } & { [c in C]: TreeItemIndex | TreeItemIndex[] | undefined }

Type parameters​

NameType
Cextends string = never

Defined in​

types.ts:200

TreeChangeActionsContextProps​

Ƭ TreeChangeActionsContextProps: TreeChangeActions

Defined in​

types.ts:436

TreeEnvironmentActionsContextProps​

Ƭ TreeEnvironmentActionsContextProps: TreeEnvironmentChangeActions

Defined in​

types.ts:272

TreeItemIndex​

Ƭ TreeItemIndex: string | number

Defined in​

types.ts:8

Variables​

INTERNALS​

• Const INTERNALS: Object

Type declaration​

NameType
TreeItemChildren(props: { children: TreeItemIndex[] ; depth: number ; parentId: TreeItemIndex }) => Element
TreeItemElement(props: { depth: number ; itemIndex: TreeItemIndex }) => Element

Defined in​

index.ts:13

Functions​

ControlledTreeEnvironment​

▸ ControlledTreeEnvironment<T, C>(p): ReactElement<any, string | JSXElementConstructor<any>>

Type parameters​

NameType
Tany
Cextends string = never

Parameters​

NameType
pControlledTreeEnvironmentProps<T, C> & { ref?: Ref<TreeEnvironmentRef<T, C>> }

Returns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

controlledEnvironment/ControlledTreeEnvironment.tsx:56

Tree​

▸ Tree<T>(p): ReactElement<any, string | JSXElementConstructor<any>>

Type parameters​

NameType
Tany

Parameters​

NameType
pTreeProps<T, never> & { ref?: Ref<TreeRef<T>> }

Returns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

tree/Tree.tsx:89

UncontrolledTreeEnvironment​

▸ UncontrolledTreeEnvironment<T, C>(p): ReactElement<any, string | JSXElementConstructor<any>>

Type parameters​

NameType
Tany
Cextends string = never

Parameters​

NameType
pUncontrolledTreeEnvironmentProps<T, C> & { ref?: Ref<TreeEnvironmentRef<T, C>> }

Returns​

ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

uncontrolledEnvironment/UncontrolledTreeEnvironment.tsx:240

createDefaultRenderers​

▸ createDefaultRenderers(renderDepthOffset, rtl?): Required<TreeRenderProps<any, never>>

Parameters​

NameType
renderDepthOffsetnumber
rtl?boolean

Returns​

Required<TreeRenderProps<any, never>>

Defined in​

renderers/createDefaultRenderers.tsx:7

useControlledTreeEnvironmentProps​

▸ useControlledTreeEnvironmentProps(__namedParameters): TreeEnvironmentContextProps<any, never>

Parameters​

NameType
__namedParametersControlledTreeEnvironmentProps<any, never>

Returns​

TreeEnvironmentContextProps<any, never>

Defined in​

controlledEnvironment/useControlledTreeEnvironmentProps.ts:14

useTree​

▸ useTree(): TreeContextProps

Returns​

TreeContextProps

Defined in​

tree/Tree.tsx:18

useTreeEnvironment​

▸ useTreeEnvironment(): TreeEnvironmentContextProps<any, never>

Returns​

TreeEnvironmentContextProps<any, never>

Defined in​

controlledEnvironment/ControlledTreeEnvironment.tsx:16

useTreeItemRenderContext​

▸ useTreeItemRenderContext(item?): undefined | TreeItemRenderContext<never>

Parameters​

NameType
item?TreeItem<any>

Returns​

undefined | TreeItemRenderContext<never>

Defined in​

treeItem/useTreeItemRenderContext.ts:18