TreeInstance <T>

Hierarchy

TreeInstanceType<T>
- TreeInstance

Properties

abortRenaming

abortRenaming: () => void

Type declaration

- (): void
- Returns void

closeSearch

closeSearch: () => void

Type declaration

- (): void
- Returns void

collapseAll

collapseAll: () => void

Type declaration

- (): void
- Returns void

completeRenaming

completeRenaming: () => void

Type declaration

- (): void
- Returns void

customHandler

customHandler: (param1: number, param2: number) => void

Type declaration

- (param1: number, param2: number): void
- Parameters
  - param1: number
  - param2: number
  Returns void

expandAll

expandAll: (cancelToken?: { current: boolean }) => Promise<void>

Type declaration

- (cancelToken?: { current: boolean }): Promise<void>
- Parameters
  - optionalcancelToken: { current: boolean }
  Returns Promise<void>

focusNextItem

focusNextItem: () => void

Type declaration

- (): void
- Returns void

focusPreviousItem

focusPreviousItem: () => void

Type declaration

- (): void
- Returns void

getConfig

getConfig: () => TreeConfig<T>

Type declaration

- (): TreeConfig<T>
- Returns TreeConfig<T>

getContainerProps

getContainerProps: (treeLabel?: string) => Record<string, any>

Pass to the container rendering the tree children. The treeLabel parameter will be passed as aria-label parameter, and is recommended to be set.

Type declaration

- (treeLabel?: string): Record<string, any>
- Parameters
  - optionaltreeLabel: string
  Returns Record<string, any>

getDragLineData

getDragLineData: () => null | DragLineData

Type declaration

- (): null | DragLineData
- Returns null | DragLineData

getDragLineStyle

getDragLineStyle: (topOffset?: number, leftOffset?: number) => Record<string, any>

Type declaration

- (topOffset?: number, leftOffset?: number): Record<string, any>
- Parameters
  - optionaltopOffset: number
  - optionalleftOffset: number
  Returns Record<string, any>

getDragTarget

getDragTarget: () => null | DragTarget<T>

Type declaration

- (): null | DragTarget<T>
- Returns null | DragTarget<T>

getElement

getElement: () => undefined | null | HTMLElement

Type declaration

- (): undefined | null | HTMLElement
- Returns undefined | null | HTMLElement

getFocusedItem

getFocusedItem: () => ItemInstance<any>

Type declaration

- (): ItemInstance<any>
- Returns ItemInstance<any>

getHotkeyPresets

getHotkeyPresets: () => HotkeysConfig<T>

Type declaration

- (): HotkeysConfig<T>
- Returns HotkeysConfig<T>

getItemInstance

getItemInstance: (itemId: string) => ItemInstance<T>

Type declaration

- (itemId: string): ItemInstance<T>
- Parameters
  - itemId: string
  Returns ItemInstance<T>

getItems

getItems: () => ItemInstance<T>[]

Type declaration

- (): ItemInstance<T>[]
- Returns ItemInstance<T>[]

getRenamingItem

getRenamingItem: () => null | ItemInstance<T>

Type declaration

- (): null | ItemInstance<T>
- Returns null | ItemInstance<T>

getRenamingValue

getRenamingValue: () => string

Type declaration

- (): string
- Returns string

getSearchInputElement

getSearchInputElement: () => null | HTMLInputElement

Type declaration

- (): null | HTMLInputElement
- Returns null | HTMLInputElement

getSearchInputElementProps

getSearchInputElementProps: () => any

Type declaration

- (): any
- Returns any

getSearchMatchingItems

getSearchMatchingItems: () => ItemInstance<T>[]

Type declaration

- (): ItemInstance<T>[]
- Returns ItemInstance<T>[]

getSearchValue

getSearchValue: () => string

Type declaration

- (): string
- Returns string

getSelectedItems

getSelectedItems: () => ItemInstance<T>[]

Type declaration

- (): ItemInstance<T>[]
- Returns ItemInstance<T>[]

getState

getState: () => TreeState<T>

Type declaration

- (): TreeState<T>
- Returns TreeState<T>

isRenamingItem

isRenamingItem: () => boolean

Type declaration

- (): boolean
- Returns boolean

isSearchOpen

isSearchOpen: () => boolean

Type declaration

- (): boolean
- Returns boolean

openSearch

openSearch: (initialValue?: string) => void

Type declaration

- (initialValue?: string): void
- Parameters
  - optionalinitialValue: string
  Returns void

rebuildTree

rebuildTree: () => void

Type declaration

- (): void
- Returns void

registerElement

registerElement: (element: null | HTMLElement) => void

Type declaration

- (element: null | HTMLElement): void
- Parameters
  - element: null | HTMLElement
  Returns void

registerSearchInputElement

registerSearchInputElement: (element: null | HTMLInputElement) => void

Type declaration

- (element: null | HTMLInputElement): void
- Parameters
  - element: null | HTMLInputElement
  Returns void

retrieveChildrenIds

retrieveChildrenIds: (itemId: string) => string[]

Type declaration

- (itemId: string): string[]
- Parameters
  - itemId: string
  Returns string[]

retrieveItemData

retrieveItemData: (itemId: string) => T

Type declaration

- (itemId: string): T
- Parameters
  - itemId: string
  Returns T

setConfig

setConfig: SetStateFn<TreeConfig<T>>

setSearch

setSearch: (search: null | string) => void

Type declaration

- (search: null | string): void
- Parameters
  - search: null | string
  Returns void

setSelectedItems

setSelectedItems: (selectedItems: string[]) => void

Type declaration

- (selectedItems: string[]): void
- Parameters
  - selectedItems: string[]
  Returns void

setState

setState: SetStateFn<TreeState<T>>

startKeyboardDrag

startKeyboardDrag: (items: ItemInstance<T>[]) => void

Type declaration

- (items: ItemInstance<T>[]): void
- Parameters
  - items: ItemInstance<T>[]
  Returns void

startKeyboardDragOnForeignObject

startKeyboardDragOnForeignObject: (dataTransfer: DataTransfer) => void

Type declaration

- (dataTransfer: DataTransfer): void
- Parameters
  - dataTransfer: DataTransfer
  Returns void

stopKeyboardDrag

stopKeyboardDrag: () => void

Type declaration

- (): void
- Returns void

updateDomFocus

updateDomFocus: () => void

Type declaration

- (): void
- Returns void

waitForItemChildrenLoaded

waitForItemChildrenLoaded: (itemId: string) => Promise<void>

Type declaration

- (itemId: string): Promise<void>
- Parameters
  - itemId: string
  Returns Promise<void>

waitForItemDataLoaded

waitForItemDataLoaded: (itemId: string) => Promise<void>

Type declaration

- (itemId: string): Promise<void>
- Parameters
  - itemId: string
  Returns Promise<void>

Hierarchy

Index

Properties

Properties

abortRenaming

Type declaration

Returns void

closeSearch

Type declaration

Returns void

collapseAll

Type declaration

Returns void

completeRenaming

Type declaration

Returns void

customHandler

Type declaration

Parameters

param1: number

param2: number

Returns void

expandAll

Type declaration

Parameters

optionalcancelToken: { current: boolean }

Returns Promise<void>

focusNextItem

Type declaration

Returns void

focusPreviousItem

Type declaration

Returns void

getConfig

Type declaration

Returns TreeConfig<T>

getContainerProps

Type declaration

Parameters

optionaltreeLabel: string

Returns Record<string, any>

getDragLineData

Type declaration

Returns null | DragLineData

getDragLineStyle

Type declaration

Parameters

optionaltopOffset: number

optionalleftOffset: number

Returns Record<string, any>

getDragTarget

Type declaration

Returns null | DragTarget<T>

getElement

Type declaration

Returns undefined | null | HTMLElement

getFocusedItem

Type declaration

Returns ItemInstance<any>

getHotkeyPresets

Type declaration

Returns HotkeysConfig<T>

getItemInstance

Type declaration

Parameters

itemId: string

Returns ItemInstance<T>

getItems

Type declaration

Returns ItemInstance<T>[]

getRenamingItem

Type declaration

Returns null | ItemInstance<T>

getRenamingValue

Type declaration

Returns string

getSearchInputElement

Type declaration

Returns null | HTMLInputElement

getSearchInputElementProps