gen_lsp v0.8.1

View Source GenLSP.Structures.InlayHint (gen_lsp v0.8.1)

Inlay hint information.

@since 3.17.0

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.InlayHint{}

Fields

  • position: The position of this hint.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.InlayHint{
  data: GenLSP.TypeAlias.LSPAny.t() | nil,
  kind: GenLSP.Enumerations.InlayHintKind.t() | nil,
  label: String.t() | [GenLSP.Structures.InlayHintLabelPart.t()],
  padding_left: boolean() | nil,
  padding_right: boolean() | nil,
  position: GenLSP.Structures.Position.t(),
  text_edits: [GenLSP.Structures.TextEdit.t()] | nil,
  tooltip: (String.t() | GenLSP.Structures.MarkupContent.t()) | nil
}

Link to this section Functions

Link to this function

%GenLSP.Structures.InlayHint{}

View Source (struct)

fields

 Fields

  • position: The position of this hint.

  • label: 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.

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

  • text_edits: 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.

  • tooltip: The tooltip text when you hover over this item.

  • padding_left: 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.

  • padding_right: 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.

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