Skip to main content

ItemInstance <T>

Hierarchy

  • ItemInstanceType<T>
    • ItemInstance

Index

Properties

Properties

canRename

canRename: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

collapse

collapse: () => void

Type declaration

    • (): void

    • Returns void

collapseAll

collapseAll: () => void

Type declaration

    • (): void

    • Returns void

deselect

deselect: () => void

Type declaration

    • (): void

    • Returns void

expand

expand: () => void

Type declaration

    • (): void

    • Returns void

expandAll

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

Type declaration

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

    • Parameters

      • optionalcancelToken: { current: boolean }

      Returns Promise<void>

getChildren

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

Type declaration

getElement

getElement: () => undefined | null | HTMLElement

Type declaration

    • (): undefined | null | HTMLElement

    • Returns undefined | null | HTMLElement

getId

getId: () => string

Type declaration

    • (): string

    • Returns string

getIndexInParent

getIndexInParent: () => number

Type declaration

    • (): number

    • Returns number

getItemAbove

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

Type declaration

getItemBelow

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

Type declaration

getItemData

getItemData: () => T

Type declaration

    • (): T

    • Returns T

getItemMeta

getItemMeta: () => ItemMeta

Type declaration

getItemName

getItemName: () => string

Type declaration

    • (): string

    • Returns string

getMemoizedProp

getMemoizedProp: <X>(name: string, create: () => X, deps?: any[]) => X

Type declaration

    • <X>(name: string, create: () => X, deps?: any[]): X

    • Type parameters

      • X

      Parameters

      • name: string
      • create: () => X
      • optionaldeps: any[]

      Returns X

getParent

getParent: () => ItemInstance<T>

Type declaration

getProps

getProps: () => Record<string, any>

Type declaration

    • (): Record<string, any>

    • Returns Record<string, any>

getRenameInputProps

getRenameInputProps: () => any

Type declaration

    • (): any

    • Returns any

getTree

getTree: () => TreeInstance<T>

Type declaration

invalidateChildrenIds

invalidateChildrenIds: () => void

Type declaration

    • (): void

    • Returns void

invalidateItemData

invalidateItemData: () => void

Type declaration

    • (): void

    • Returns void

isDraggingOver

isDraggingOver: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isDropTarget

isDropTarget: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isDropTargetAbove

isDropTargetAbove: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isDropTargetBelow

isDropTargetBelow: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isExpanded

isExpanded: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isFocused

isFocused: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isFolder

isFolder: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isLoading

isLoading: () => boolean & () => void

isMatchingSearch

isMatchingSearch: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isRenaming

isRenaming: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

isSelected

isSelected: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

primaryAction

primaryAction: () => void

Type declaration

    • (): void

    • Returns void

registerElement

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

Type declaration

    • (element: null | HTMLElement): void

    • Parameters

      • element: null | HTMLElement

      Returns void

scrollTo

scrollTo: (scrollIntoViewArg?: boolean | ScrollIntoViewOptions) => Promise<void>

Type declaration

    • (scrollIntoViewArg?: boolean | ScrollIntoViewOptions): Promise<void>

    • Parameters

      • optionalscrollIntoViewArg: boolean | ScrollIntoViewOptions

      Returns Promise<void>

select

select: () => void

Type declaration

    • (): void

    • Returns void

selectUpTo

selectUpTo: (ctrl: boolean) => void

Type declaration

    • (ctrl: boolean): void

    • Parameters

      • ctrl: boolean

      Returns void

setFocused

setFocused: () => void

Type declaration

    • (): void

    • Returns void

toggleSelect

toggleSelect: () => void

Type declaration

    • (): void

    • Returns void