Interface: UncontrolledTreeEnvironmentProps<T, C>
Type parameters
Name | Type |
---|---|
T | any |
C | extends string = never |
Hierarchy
TreeRenderProps
<T
,C
>↳
UncontrolledTreeEnvironmentProps
Properties
autoFocus
• Optional
autoFocus: boolean
Inherited from
Defined in
canDrag
• Optional
canDrag: (items
: TreeItem
<any
>[]) => boolean
Type declaration
▸ (items
): boolean
Parameters
Name | Type |
---|---|
items | TreeItem <any >[] |
Returns
boolean
Inherited from
Defined in
canDragAndDrop
• Optional
canDragAndDrop: boolean
Inherited from
TreeCapabilities.canDragAndDrop
Defined in
canDropAt
• Optional
canDropAt: (items
: TreeItem
<any
>[], target
: DraggingPosition
) => boolean
Type declaration
▸ (items
, target
): boolean
Parameters
Name | Type |
---|---|
items | TreeItem <any >[] |
target | DraggingPosition |
Returns
boolean
Inherited from
Defined in
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
TreeCapabilities.canDropBelowOpenFolders
Defined in
canDropOnFolder
• Optional
canDropOnFolder: boolean
Inherited from
TreeCapabilities.canDropOnFolder
Defined in
canDropOnNonFolder
• Optional
canDropOnNonFolder: boolean
Inherited from
TreeCapabilities.canDropOnNonFolder
Defined in
canInvokePrimaryActionOnItemContainer
• Optional
canInvokePrimaryActionOnItemContainer: boolean
Inherited from
TreeCapabilities.canInvokePrimaryActionOnItemContainer
Defined in
canRename
• Optional
canRename: boolean
Inherited from
Defined in
canReorderItems
• Optional
canReorderItems: boolean
Inherited from
TreeCapabilities.canReorderItems
Defined in
canSearch
• Optional
canSearch: boolean
Inherited from
Defined in
canSearchByStartingTyping
• Optional
canSearchByStartingTyping: boolean
Inherited from
TreeCapabilities.canSearchByStartingTyping
Defined in
children
• children: null
| Element
| (null
| Element
)[]
Defined in
dataProvider
• dataProvider: TreeDataProvider
<T
>
Inherited from
ImplicitDataSource.dataProvider
Defined in
defaultInteractionMode
• Optional
defaultInteractionMode: InteractionMode
| InteractionManager
<never
>
Inherited from
TreeCapabilities.defaultInteractionMode
Defined in
disableArrowKeys
• Optional
disableArrowKeys: boolean
Inherited from
TreeCapabilities.disableArrowKeys
Defined in
disableMultiselect
• Optional
disableMultiselect: boolean
Defined in
doesSearchMatchItem
• Optional
doesSearchMatchItem: (search
: string
, item
: TreeItem
<any
>, itemTitle
: string
) => boolean
Type declaration
▸ (search
, item
, itemTitle
): boolean
Parameters
Name | Type |
---|---|
search | string |
item | TreeItem <any > |
itemTitle | string |
Returns
boolean
Inherited from
TreeCapabilities.doesSearchMatchItem
Defined in
getItemTitle
• getItemTitle: (item
: TreeItem
<T
>) => string
Type declaration
▸ (item
): string
Parameters
Name | Type |
---|---|
item | TreeItem <T > |
Returns
string
Defined in
keyboardBindings
• Optional
keyboardBindings: KeyboardBindings
Defined in
liveDescriptors
• Optional
liveDescriptors: LiveDescriptors
Defined in
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
TreeChangeHandlers.onAbortRenamingItem
Defined in
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
TreeChangeHandlers.onCollapseItem
Defined in
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
Defined in
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
TreeChangeHandlers.onExpandItem
Defined in
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
TreeChangeHandlers.onFocusItem
Defined in
onMissingChildren
• Optional
onMissingChildren: (itemIds
: TreeItemIndex
[]) => void
Type declaration
▸ (itemIds
): void
Parameters
Name | Type |
---|---|
itemIds | TreeItemIndex [] |
Returns
void
Inherited from
TreeChangeHandlers.onMissingChildren
Defined in
onMissingItems
• Optional
onMissingItems: (itemIds
: TreeItemIndex
[]) => void
Type declaration
▸ (itemIds
): void
Parameters
Name | Type |
---|---|
itemIds | TreeItemIndex [] |
Returns
void
Inherited from
TreeChangeHandlers.onMissingItems
Defined in
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
TreeChangeHandlers.onPrimaryAction
Defined in
onRegisterTree
• Optional
onRegisterTree: (tree
: TreeConfiguration
) => void
Type declaration
▸ (tree
): void
Parameters
Name | Type |
---|---|
tree | TreeConfiguration |
Returns
void
Inherited from
TreeChangeHandlers.onRegisterTree
Defined in
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
TreeChangeHandlers.onRenameItem
Defined in
onSelectItems
• Optional
onSelectItems: (items
: TreeItemIndex
[], treeId
: string
) => void
Type declaration
▸ (items
, treeId
): void
Parameters
Name | Type |
---|---|
items | TreeItemIndex [] |
treeId | string |
Returns
void
Inherited from
TreeChangeHandlers.onSelectItems
Defined in
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
TreeChangeHandlers.onStartRenamingItem
Defined in
onUnregisterTree
• Optional
onUnregisterTree: (tree
: TreeConfiguration
) => void
Type declaration
▸ (tree
): void
Parameters
Name | Type |
---|---|
tree | TreeConfiguration |
Returns
void
Inherited from
TreeChangeHandlers.onUnregisterTree
Defined in
renderDepthOffset
• Optional
renderDepthOffset: number
Inherited from
TreeRenderProps.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
TreeRenderProps.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
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
TreeRenderProps.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
TreeRenderProps.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
TreeRenderProps.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
TreeRenderProps.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
TreeRenderProps.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
TreeRenderProps.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
TreeRenderProps.renderTreeContainer
Defined in
shouldRenderChildren
• Optional
shouldRenderChildren: (item
: TreeItem
<any
>, context
: TreeItemRenderContext
<never
>) => boolean
Type declaration
▸ (item
, context
): boolean
Parameters
Name | Type |
---|---|
item | TreeItem <any > |
context | TreeItemRenderContext <never > |
Returns
boolean
Inherited from
TreeCapabilities.shouldRenderChildren
Defined in
showLiveDescription
• Optional
showLiveDescription: boolean
Inherited from
TreeCapabilities.showLiveDescription
Defined in
viewState
• viewState: TreeViewState
<C
>