class LSProtocol::DocumentLink
- LSProtocol::DocumentLink
- Reference
- Object
Overview
A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(pull : JSON::PullParser)
- .new(range : Range | Nil, data : LSPAny | Nil = nil, target : URI | Nil = nil, tooltip : String | Nil = nil)
Instance Method Summary
-
#data : LSPAny | Nil
A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.
-
#range : Range
The range this link applies to.
-
#target : URI | Nil
The uri this link points to.
-
#tooltip : String | Nil
The tooltip text when you hover over this link.
Constructor Detail
Instance Method Detail
A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.
The tooltip text when you hover over this link.
If a tooltip is provided, is will be displayed in a string that includes instructions on how to
trigger the link, such as {0} (ctrl + click)
. The specific instructions vary depending on OS,
user settings, and localization.
@since 3.15.0