@umbraco-cms/backoffice
    Preparing search index...

    Interface UmbTreeItemContext<TreeItemType>

    The base tree item contract — shared by full tree item contexts and card apis — covering item data, selection, active state, path, and entity actions. Children, expansion, and pagination are not included here; they extend this contract in UmbTreeItemContext.

    interface UmbTreeItemContext<
        TreeItemType extends UmbTreeItemModel = UmbTreeItemModel,
    > {
        childItems: Observable<TreeItemType[]>;
        entityType?: string;
        hasActions: Observable<boolean>;
        hasChildren: Observable<boolean>;
        isActive: Observable<boolean>;
        isLoading: Observable<boolean>;
        isLoadingNextChildren: Observable<boolean>;
        isLoadingPrevChildren: Observable<boolean>;
        isOpen: Observable<boolean>;
        isSelectable: Observable<boolean>;
        isSelectableContext: Observable<boolean>;
        isSelected: Observable<boolean>;
        manifest: ManifestBase | undefined;
        noAccess: Observable<boolean>;
        pagination: UmbPaginationManager;
        path: Observable<string>;
        selectOnly: Observable<boolean>;
        targetPagination: UmbTargetPaginationManager;
        treeItem: Observable<TreeItemType | undefined>;
        unique?: UmbEntityUnique;
        constructPath(
            pathname: string,
            entityType: string,
            unique: string | null,
        ): string;
        deselect(): void;
        destroy(): void;
        getHostElement(): Element;
        getIsMenu(): boolean;
        getTreeItem(): TreeItemType | undefined;
        hideChildren(): void;
        loadChildren(): void;
        loadNextItems(): void;
        loadPrevItems(): void;
        open(): void;
        reloadChildren(): void;
        select(): void;
        setIsMenu(isMenu: boolean): void;
        setTreeItem(item: TreeItemType | undefined): void;
        showChildren(): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index
    childItems entityType? hasActions hasChildren isActive isLoading isLoadingNextChildren isLoadingPrevChildren isOpen isSelectable isSelectableContext isSelected manifest noAccess pagination path selectOnly targetPagination treeItem unique?
    constructPath deselect destroy getHostElement getIsMenu getTreeItem hideChildren loadChildren loadNextItems loadPrevItems open reloadChildren select setIsMenu setTreeItem showChildren
    childItems: Observable<TreeItemType[]>
    entityType?: string
    hasActions: Observable<boolean>

    Deprecated since v17. Render <umb-entity-actions-bundle>, which resolves the entity actions that are permitted for the item, instead of asking whether any are registered for the entity type. Will be removed in v19.

    hasChildren: Observable<boolean>
    isActive: Observable<boolean>
    isLoading: Observable<boolean>
    isLoadingNextChildren: Observable<boolean>
    isLoadingPrevChildren: Observable<boolean>
    isOpen: Observable<boolean>
    isSelectable: Observable<boolean>
    isSelectableContext: Observable<boolean>
    isSelected: Observable<boolean>
    manifest: ManifestBase | undefined
    noAccess: Observable<boolean>
    pagination: UmbPaginationManager
    path: Observable<string>
    selectOnly: Observable<boolean>
    targetPagination: UmbTargetPaginationManager
    treeItem: Observable<TreeItemType | undefined>
    unique?: UmbEntityUnique

    Settings
    Member Visibility

    On This Page
    Properties
    Methods