Type Alias InlayHint

InlayHint: {
    data?: LSPAny;
    kind?: InlayHintKind;
    label: string | InlayHintLabelPart[];
    paddingLeft?: boolean;
    paddingRight?: boolean;
    position: Position;
    textEdits?: TextEdit[];
    tooltip?: string | MarkupContent;
}

Inlay hint information.

Type declaration

  • Optionaldata?: LSPAny

    A data entry field that is preserved on an inlay hint between a textDocument/inlayHint and a inlayHint/resolve request.

  • Optionalkind?: InlayHintKind

    The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.

  • label: string | InlayHintLabelPart[]

    The label of this hint. A human readable string or an array of InlayHintLabelPart label parts.

    Note that neither the string nor the label part can be empty.

  • OptionalpaddingLeft?: boolean

    Render padding before the hint.

    Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

  • OptionalpaddingRight?: boolean

    Render padding after the hint.

    Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

  • position: Position

    The position of this hint.

    If multiple hints have the same position, they will be shown in the order they appear in the response.

  • OptionaltextEdits?: TextEdit[]

    Optional text edits that are performed when accepting this inlay hint.

    Note that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete.

  • Optionaltooltip?: string | MarkupContent

    The tooltip text when you hover over this item.

Since

3.17.0

Settings

Member Visibility