@theia/core/lib/browser/breadcrumbs/breadcrumbs-constants.d.ts

Theia is a cloud & desktop IDE framework implemented in TypeScript.

import { MaybePromise, Event } from '../../common';
import { Disposable } from '../../../shared/vscode-languageserver-protocol';
import URI from '../../common/uri';
export declare namespace Styles {
    const BREADCRUMBS = "theia-breadcrumbs";
    const BREADCRUMB_ITEM = "theia-breadcrumb-item";
    const BREADCRUMB_POPUP_OVERLAY_CONTAINER = "theia-breadcrumbs-popups-overlay";
    const BREADCRUMB_POPUP = "theia-breadcrumbs-popup";
    const BREADCRUMB_ITEM_HAS_POPUP = "theia-breadcrumb-item-haspopup";
}
/** A single breadcrumb in the breadcrumbs bar. */
export interface Breadcrumb {
    /** An ID of this breadcrumb that should be unique in the breadcrumbs bar. */
    readonly id: string;
    /** The breadcrumb type. Should be the same as the contribution type `BreadcrumbsContribution#type`. */
    readonly type: symbol;
    /** The text that will be rendered as label. */
    readonly label: string;
    /** A longer text that will be used as tooltip text. */
    readonly longLabel: string;
    /** A CSS class for the icon. */
    readonly iconClass?: string;
    /** CSS classes for the container. */
    readonly containerClass?: string;
}
export declare const BreadcrumbsContribution: unique symbol;
export interface BreadcrumbsContribution {
    /**
     * The breadcrumb type. Breadcrumbs returned by `#computeBreadcrumbs(uri)` should have this as `Breadcrumb#type`.
     */
    readonly type: symbol;
    /**
     * The priority of this breadcrumbs contribution. Contributions are rendered left to right in order of ascending priority.
     */
    readonly priority: number;
    /**
     * An event emitter that should fire when breadcrumbs change for a given URI.
     */
    readonly onDidChangeBreadcrumbs: Event<URI>;
    /**
     * Computes breadcrumbs for a given URI.
     */
    computeBreadcrumbs(uri: URI): MaybePromise<Breadcrumb[]>;
    /**
     * 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.
     */
    attachPopupContent(breadcrumb: Breadcrumb, parent: HTMLElement): Promise<Disposable | undefined>;
}
//# sourceMappingURL=breadcrumbs-constants.d.ts.map