Interface HoverProvider<THover>

The hover provider interface defines the contract between extensions and the hover-feature.

interface HoverProvider<THover> {
provideHover(model, position, token, context?): ProviderResult<THover>;
}

Type Parameters

THover = Hover

Index

Methods

Methods

provideHover

provideHover(model, position, token, context?): ProviderResult<THover>
Provide a hover for the given position, context and document. Multiple hovers at the same position will be merged by the editor. A hover can have a range which defaults to the word range at the position when omitted.
Parameters
- model: ITextModel
- position: Position
- token: CancellationToken
- Optional context: HoverContext<THover>
Returns ProviderResult<THover>
- Defined in editor.api.d.ts:6907