| 1 | import { MaybePromise, Event } from '../../common';
|
| 2 | import { Disposable } from '../../../shared/vscode-languageserver-protocol';
|
| 3 | import URI from '../../common/uri';
|
| 4 | export declare namespace Styles {
|
| 5 | const BREADCRUMBS = "theia-breadcrumbs";
|
| 6 | const BREADCRUMB_ITEM = "theia-breadcrumb-item";
|
| 7 | const BREADCRUMB_POPUP_OVERLAY_CONTAINER = "theia-breadcrumbs-popups-overlay";
|
| 8 | const BREADCRUMB_POPUP = "theia-breadcrumbs-popup";
|
| 9 | const BREADCRUMB_ITEM_HAS_POPUP = "theia-breadcrumb-item-haspopup";
|
| 10 | }
|
| 11 | /** A single breadcrumb in the breadcrumbs bar. */
|
| 12 | export interface Breadcrumb {
|
| 13 | /** An ID of this breadcrumb that should be unique in the breadcrumbs bar. */
|
| 14 | readonly id: string;
|
| 15 | /** The breadcrumb type. Should be the same as the contribution type `BreadcrumbsContribution#type`. */
|
| 16 | readonly type: symbol;
|
| 17 | /** The text that will be rendered as label. */
|
| 18 | readonly label: string;
|
| 19 | /** A longer text that will be used as tooltip text. */
|
| 20 | readonly longLabel: string;
|
| 21 | /** A CSS class for the icon. */
|
| 22 | readonly iconClass?: string;
|
| 23 | /** CSS classes for the container. */
|
| 24 | readonly containerClass?: string;
|
| 25 | }
|
| 26 | export declare const BreadcrumbsContribution: unique symbol;
|
| 27 | export interface BreadcrumbsContribution {
|
| 28 | /**
|
| 29 | * The breadcrumb type. Breadcrumbs returned by `#computeBreadcrumbs(uri)` should have this as `Breadcrumb#type`.
|
| 30 | */
|
| 31 | readonly type: symbol;
|
| 32 | /**
|
| 33 | * The priority of this breadcrumbs contribution. Contributions are rendered left to right in order of ascending priority.
|
| 34 | */
|
| 35 | readonly priority: number;
|
| 36 | /**
|
| 37 | * An event emitter that should fire when breadcrumbs change for a given URI.
|
| 38 | */
|
| 39 | readonly onDidChangeBreadcrumbs: Event<URI>;
|
| 40 | /**
|
| 41 | * Computes breadcrumbs for a given URI.
|
| 42 | */
|
| 43 | computeBreadcrumbs(uri: URI): MaybePromise<Breadcrumb[]>;
|
| 44 | /**
|
| 45 | * Attaches the breadcrumb popup content for the given breadcrumb as child to the given parent.
|
| 46 | * If it returns a Disposable, it is called when the popup closes.
|
| 47 | */
|
| 48 | attachPopupContent(breadcrumb: Breadcrumb, parent: HTMLElement): Promise<Disposable | undefined>;
|
| 49 | }
|
| 50 | //# sourceMappingURL=breadcrumbs-constants.d.ts.map |
| \ | No newline at end of file |