Class BreadcrumbsService

Hierarchy

BreadcrumbsService

Index

Constructors

constructor

Properties

Accessors

onDidChangeBreadcrumbs

Methods

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>

- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:55
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>

Methods

Protected createOverlayContainer

createOverlayContainer(): void

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

getBreadcrumbs

getBreadcrumbs(uri: URI): Promise<Breadcrumb[]>

- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:78
Returns the breadcrumbs for a given URI, possibly an empty list.

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

init

init(): void

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

openPopup

openPopup(breadcrumb: Breadcrumb, position: Coordinate): Promise<undefined | BreadcrumbPopupContainer>

- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:95
Opens a popup for the given breadcrumb at the given position.

Parameters
- breadcrumb: Breadcrumb
- position: Coordinate
Returns Promise<undefined | BreadcrumbPopupContainer>

Protected prioritizedContributions

prioritizedContributions(): Promise<BreadcrumbsContribution[]>

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

Protected subscribeToContributions

subscribeToContributions(): void

- Defined in packages/core/src/browser/breadcrumbs/breadcrumbs-service.ts:68
Subscribes to the onDidChangeBreadcrumbs events for all contributions.

Returns void