Theia API Documentation v1.65.0
    Preparing search index...

    Interface BreadcrumbsContribution

    interface BreadcrumbsContribution {
        onDidChangeBreadcrumbs: Event<URI>;
        priority: number;
        type: symbol;
        attachPopupContent(
            breadcrumb: Breadcrumb,
            parent: HTMLElement,
        ): Promise<undefined | Disposable>;
        computeBreadcrumbs(uri: URI): MaybePromise<Breadcrumb[]>;
    }

    Implemented by

    Index

    Properties

    onDidChangeBreadcrumbs priority type

    Methods

    attachPopupContent computeBreadcrumbs

    Properties

    onDidChangeBreadcrumbs: Event<URI>

    An event emitter that should fire when breadcrumbs change for a given URI.

    priority: number

    The priority of this breadcrumbs contribution. Contributions are rendered left to right in order of ascending priority.

    type: symbol

    The breadcrumb type. Breadcrumbs returned by #computeBreadcrumbs(uri) should have this as Breadcrumb#type.

    Methods

    • Attaches the breadcrumb popup content for the given breadcrumb as child to the given parent. If it returns a Disposable, it is called when the popup closes.

      Parameters

      Returns Promise<undefined | Disposable>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods