Interface BreadcrumbsContribution

Hierarchy

BreadcrumbsContribution

Index

Properties

Methods

Properties

Readonly onDidChangeBreadcrumbs

onDidChangeBreadcrumbs: Event<URI>

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

Readonly priority

priority: number

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

Readonly type

type: symbol

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

Methods

attachPopupContent

attachPopupContent(breadcrumb: Breadcrumb, parent: HTMLElement): Promise<undefined | Disposable>

- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-constants.ts:78
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
- breadcrumb: Breadcrumb
- parent: HTMLElement
Returns Promise<undefined | Disposable>

computeBreadcrumbs

computeBreadcrumbs(uri: URI): MaybePromise<Breadcrumb[]>

- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-constants.ts:72
Computes breadcrumbs for a given URI.

Parameters
- uri: URI
Returns MaybePromise<Breadcrumb[]>