View source

typedef InlayHint

package languageServerProtocol

import languageServerProtocol.Types

Inlay hint information.

Available since

3.17.0

.

Fields

@:optionaloptionaltooltip:Null<EitherType<String, MarkupContent>>

The tooltip text when you hover over this item.

@:optionaloptionaltextEdits:Null<Array<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.

position:Position

The position of this hint.

@:optionaloptionalpaddingRight:Null<Bool>

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.

@:optionaloptionalpaddingLeft:Null<Bool>

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.

label:EitherType<String, Array<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.

@:optionaloptionalkind:Null<InlayHintKind>

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

@:optionaloptionaldata:Null<LSPAny>

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