class LSProtocol::InlayHint
- LSProtocol::InlayHint
- Reference
- Object
Overview
Inlay hint information.
@since 3.17.0
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(label : Array(InlayHintLabelPart) | String | Nil, position : Position | Nil, data : LSPAny | Nil = nil, kind : InlayHintKind | Nil = nil, padding_left : Bool | Nil = nil, padding_right : Bool | Nil = nil, text_edits : Array(TextEdit) | Nil = nil, tooltip : MarkupContent | String | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#data : LSPAny | Nil
A data entry field that is preserved on an inlay hint between a
textDocument/inlayHintand ainlayHint/resolverequest. -
#kind : InlayHintKind | Nil
The kind of this hint.
-
#label : Array(InlayHintLabelPart) | String
The label of this hint.
-
#padding_left : Bool | Nil
Render padding before the hint.
-
#padding_right : Bool | Nil
Render padding after the hint.
-
#position : Position
The position of this hint.
-
#text_edits : Array(TextEdit) | Nil
Optional text edits that are performed when accepting this inlay hint.
-
#tooltip : MarkupContent | String | Nil
The tooltip text when you hover over this item.
Constructor Detail
Instance Method Detail
A data entry field that is preserved on an inlay hint between
a textDocument/inlayHint and a inlayHint/resolve request.
The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.
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.
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.
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.
The position of this hint.
If multiple hints have the same position, they will be shown in the order they appear in the response.
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.