Interface: TreeEnvironmentRef<T, C>
Type parameters
Name | Type |
---|---|
T | any |
C | extends string = never |
Hierarchy
Omit
<TreeEnvironmentConfiguration
<T
,C
>, keyofTreeChangeHandlers
>↳
TreeEnvironmentRef
Properties
abortProgrammaticDrag
• abortProgrammaticDrag: () => void
Type declaration
▸ (): void
Returns
void
Inherited from
TreeEnvironmentChangeActions.abortProgrammaticDrag
Defined in
activeTreeId
• Optional
activeTreeId: string
Defined in
autoFocus
• Optional
autoFocus: boolean
Inherited from
Omit.autoFocus
Defined in
canDrag
• Optional
canDrag: (items
: TreeItem
<T
>[]) => boolean
Type declaration
▸ (items
): boolean
Parameters
Name | Type |
---|---|
items | TreeItem <T >[] |
Returns
boolean
Inherited from
Omit.canDrag
Defined in
canDragAndDrop
• Optional
canDragAndDrop: boolean
Inherited from
Omit.canDragAndDrop
Defined in
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
Omit.canDropAt
Defined in
canDropOnFolder
• Optional
canDropOnFolder: boolean
Inherited from
Omit.canDropOnFolder
Defined in
canDropOnNonFolder
• Optional
canDropOnNonFolder: boolean
Inherited from
Omit.canDropOnNonFolder
Defined in
canInvokePrimaryActionOnItemContainer
• Optional
canInvokePrimaryActionOnItemContainer: boolean
Inherited from
Omit.canInvokePrimaryActionOnItemContainer
Defined in
canRename
• Optional
canRename: boolean
Inherited from
Omit.canRename
Defined in
canReorderItems
• Optional
canReorderItems: boolean
Inherited from
Omit.canReorderItems
Defined in
canSearch
• Optional
canSearch: boolean
Inherited from
Omit.canSearch
Defined in
canSearchByStartingTyping
• Optional
canSearchByStartingTyping: boolean
Inherited from
Omit.canSearchByStartingTyping
Defined in
collapseAll
• collapseAll: (treeId
: string
) => void
Type declaration
▸ (treeId
): void
Parameters
Name | Type |
---|---|
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.collapseAll
Defined in
collapseItem
• collapseItem: (itemId
: TreeItemIndex
, treeId
: string
) => void
Type declaration
▸ (itemId
, treeId
): void
Parameters
Name | Type |
---|---|
itemId | TreeItemIndex |
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.collapseItem
Defined in
completeProgrammaticDrag
• completeProgrammaticDrag: () => void
Type declaration
▸ (): void
Returns
void
Inherited from
TreeEnvironmentChangeActions.completeProgrammaticDrag
Defined in
defaultInteractionMode
• Optional
defaultInteractionMode: InteractionMode
| InteractionManager
<never
>
Inherited from
Omit.defaultInteractionMode
Defined in
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
Omit.doesSearchMatchItem
Defined in
dragAndDropContext
• dragAndDropContext: DragAndDropContextProps
<any
>
Defined in
expandAll
• expandAll: (treeId
: string
) => void
Type declaration
▸ (treeId
): void
Parameters
Name | Type |
---|---|
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.expandAll
Defined in
expandItem
• expandItem: (itemId
: TreeItemIndex
, treeId
: string
) => void
Type declaration
▸ (itemId
, treeId
): void
Parameters
Name | Type |
---|---|
itemId | TreeItemIndex |
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.expandItem
Defined in
focusItem
• focusItem: (itemId
: TreeItemIndex
, treeId
: string
) => void
Type declaration
▸ (itemId
, treeId
): void
Parameters
Name | Type |
---|---|
itemId | TreeItemIndex |
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.focusItem
Defined in
focusTree
• focusTree: (treeId
: string
, autoFocus?
: boolean
) => void
Type declaration
▸ (treeId
, autoFocus?
): void
Parameters
Name | Type |
---|---|
treeId | string |
autoFocus? | boolean |
Returns
void
Inherited from
TreeEnvironmentChangeActions.focusTree
Defined in
getItemTitle
• getItemTitle: (item
: TreeItem
<T
>) => string
Type declaration
▸ (item
): string
Parameters
Name | Type |
---|---|
item | TreeItem <T > |
Returns
string
Inherited from
Omit.getItemTitle
Defined in
invokePrimaryAction
• invokePrimaryAction: (itemId
: TreeItemIndex
, treeID
: string
) => void
Type declaration
▸ (itemId
, treeID
): void
Parameters
Name | Type |
---|---|
itemId | TreeItemIndex |
treeID | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.invokePrimaryAction
Defined in
items
• items: Record
<TreeItemIndex
, TreeItem
<T
>>
Inherited from
Omit.items
Defined in
keyboardBindings
• Optional
keyboardBindings: KeyboardBindings
Inherited from
Omit.keyboardBindings
Defined in
liveDescriptors
• Optional
liveDescriptors: LiveDescriptors
Inherited from
Omit.liveDescriptors
Defined in
moveFocusDown
• moveFocusDown: (treeId
: string
) => void
Type declaration
▸ (treeId
): void
Parameters
Name | Type |
---|---|
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.moveFocusDown
Defined in
moveFocusUp
• moveFocusUp: (treeId
: string
) => void
Type declaration
▸ (treeId
): void
Parameters
Name | Type |
---|---|
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.moveFocusUp
Defined in
moveProgrammaticDragPositionDown
• moveProgrammaticDragPositionDown: () => void
Type declaration
▸ (): void
Returns
void
Inherited from
TreeEnvironmentChangeActions.moveProgrammaticDragPositionDown
Defined in
moveProgrammaticDragPositionUp
• moveProgrammaticDragPositionUp: () => void
Type declaration
▸ (): void
Returns
void
Inherited from
TreeEnvironmentChangeActions.moveProgrammaticDragPositionUp
Defined in
renameItem
• renameItem: (itemId
: TreeItemIndex
, name
: string
, treeId
: string
) => void
Type declaration
▸ (itemId
, name
, treeId
): void
Parameters
Name | Type |
---|---|
itemId | TreeItemIndex |
name | string |
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.renameItem
Defined in
renderDepthOffset
• Optional
renderDepthOffset: number
Inherited from
Omit.renderDepthOffset
Defined in
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
Omit.renderDragBetweenLine
Defined in
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
Omit.renderItem
Defined in
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
Omit.renderItemArrow
Defined in
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
Omit.renderItemTitle
Defined in
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
Omit.renderItemsContainer
Defined in
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
Omit.renderLiveDescriptorContainer
Defined in
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
Omit.renderRenameInput
Defined in
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
Omit.renderSearchInput
Defined in
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
Omit.renderTreeContainer
Defined in
selectItems
• selectItems: (itemsIds
: TreeItemIndex
[], treeId
: string
) => void
Type declaration
▸ (itemsIds
, treeId
): void
Parameters
Name | Type |
---|---|
itemsIds | TreeItemIndex [] |
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.selectItems
Defined in
showLiveDescription
• Optional
showLiveDescription: boolean
Inherited from
Omit.showLiveDescription
Defined in
startProgrammaticDrag
• startProgrammaticDrag: () => void
Type declaration
▸ (): void
Returns
void
Inherited from
TreeEnvironmentChangeActions.startProgrammaticDrag
Defined in
toggleItemExpandedState
• toggleItemExpandedState: (itemId
: TreeItemIndex
, treeId
: string
) => void
Type declaration
▸ (itemId
, treeId
): void
Parameters
Name | Type |
---|---|
itemId | TreeItemIndex |
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.toggleItemExpandedState
Defined in
toggleItemSelectStatus
• toggleItemSelectStatus: (itemId
: TreeItemIndex
, treeId
: string
) => void
Type declaration
▸ (itemId
, treeId
): void
Parameters
Name | Type |
---|---|
itemId | TreeItemIndex |
treeId | string |
Returns
void
Inherited from
TreeEnvironmentChangeActions.toggleItemSelectStatus
Defined in
treeEnvironmentContext
• treeEnvironmentContext: TreeEnvironmentContextProps
<any
, never
>
Defined in
treeIds
• treeIds: string
[]
Defined in
trees
• trees: Record
<string
, TreeConfiguration
>
Defined in
viewState
• viewState: TreeViewState
<C
>
Inherited from
Omit.viewState