Class BreadcrumbsService

Index

Constructors

Properties

breadcrumbPopupContainerFactory contributions hasSubscribed onDidChangeBreadcrumbsEmitter popupsOverlayContainer

Accessors

onDidChangeBreadcrumbs

Methods

createOverlayContainer getBreadcrumbs init openPopup prioritizedContributions subscribeToContributions

Constructors

constructor

new BreadcrumbsService(): BreadcrumbsService
Returns BreadcrumbsService

Properties

`Protected` `Readonly`breadcrumbPopupContainerFactory

breadcrumbPopupContainerFactory: BreadcrumbPopupContainerFactory

`Protected` `Readonly`contributions

contributions: ContributionProvider<BreadcrumbsContribution>

`Protected`hasSubscribed

hasSubscribed: boolean = false

`Protected` `Readonly`onDidChangeBreadcrumbsEmitter

onDidChangeBreadcrumbsEmitter: Emitter<URI> = ...

`Protected`popupsOverlayContainer

popupsOverlayContainer: HTMLDivElement

Accessors

onDidChangeBreadcrumbs

get onDidChangeBreadcrumbs(): Event<URI>
Subscribe to this event emitter to be notified when the breadcrumbs have changed. The URI is the URI of the editor the breadcrumbs have changed for.

Returns Event<URI>
- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:55

Methods

`Protected`createOverlayContainer

createOverlayContainer(): void
Returns void
- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:43

getBreadcrumbs

getBreadcrumbs(uri: URI): Promise<Breadcrumb[]>
Returns the breadcrumbs for a given URI, possibly an empty list.
Parameters
- uri: URI
Returns Promise<Breadcrumb[]>
- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:78

init

init(): void
Returns void
- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:39

openPopup

openPopup(
breadcrumb: Breadcrumb,
position: Coordinate,
): Promise<undefined | BreadcrumbPopupContainer>
Opens a popup for the given breadcrumb at the given position.
Parameters
- breadcrumb: Breadcrumb
- position: Coordinate
Returns Promise<undefined | BreadcrumbPopupContainer>
- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:95

`Protected`prioritizedContributions

prioritizedContributions(): Promise<BreadcrumbsContribution[]>
Returns Promise<BreadcrumbsContribution[]>
- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:86

`Protected`subscribeToContributions

subscribeToContributions(): void
Subscribes to the onDidChangeBreadcrumbs events for all contributions.

Returns void
- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:68