languages

Interface HoverProvider<THover>

Expand description

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

interface HoverProvider<THover = Hover> {
    provideHover(
        model: ITextModel,
        position: Position,
        token: CancellationToken,
        context?: HoverContext<THover>,
    ): ProviderResult<THover>;
}

Methods§

§

provideHover(
    model: ITextModel,
    position: Position,
    token: CancellationToken,
    context?: HoverContext<THover>,
): 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.