Interface UmbMenuStructureWorkspaceContext

interface UmbMenuStructureWorkspaceContext {
    structure: Observable<UmbStructureItemModel[]>;
    get controllerAlias(): UmbControllerAlias;
    destroy(): void;
    getHostElement(): Element;
    getItemHref(structureItem: UmbStructureItemModel): string | undefined;
    hostConnected(): void;
    hostDisconnected(): void;
}

Hierarchy (View Summary)

UmbContext
- UmbMenuStructureWorkspaceContext

Index

Properties

Accessors

controllerAlias

Methods

destroy getHostElement getItemHref hostConnected hostDisconnected

Properties

structure

structure: Observable<UmbStructureItemModel[]>

Observable array of structure items representing the workspace's breadcrumb hierarchy.

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbContext.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

destroy

destroy(): void
Returns void
Inherited from UmbContext.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbContext.getHostElement
- Defined in src/libs/class-api/context.interface.ts:4

getItemHref

getItemHref(structureItem: UmbStructureItemModel): string | undefined
Returns the href for a breadcrumb structure item, or undefined if the item should not be a link. Used by the workspace breadcrumb element to generate clickable navigation links.
Parameters
- structureItem: UmbStructureItemModel
  The structure item to generate an href for.
Returns string | undefined
The href string, or undefined if the item should not be clickable.
- Defined in src/packages/core/menu/menu-structure-workspace-context.interface.ts:18

hostConnected

hostConnected(): void
Returns void
Inherited from UmbContext.hostConnected
- Defined in src/libs/controller-api/controller.interface.ts:4

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbContext.hostDisconnected
- Defined in src/libs/controller-api/controller.interface.ts:5