Class VerboseHover

A hover represents additional information for a symbol or word. Hovers are rendered in a tooltip-like widget.

Hierarchy (View Summary)

Hover
- VerboseHover

Index

Constructors

constructor

Properties

canDecreaseVerbosity? canIncreaseVerbosity? contents range?

Constructors

constructor

new VerboseHover(
    contents:
        | MarkdownString
        | MarkedString
        | (MarkdownString | MarkedString)[],
    range?: Range,
    canIncreaseVerbosity?: boolean,
    canDecreaseVerbosity?: boolean,
): VerboseHover
Creates a new hover object.
Parameters
- contents: MarkdownString | MarkedString | (MarkdownString | MarkedString)[]
  The contents of the hover.
- Optionalrange: Range
  The range to which the hover applies.
- OptionalcanIncreaseVerbosity: boolean
- OptionalcanDecreaseVerbosity: boolean
Returns VerboseHover
Overrides Hover.constructor
- Defined in packages/plugin/src/theia.proposed.editorHoverVerbosityLevel.d.ts:48

Properties

`Optional`canDecreaseVerbosity

canDecreaseVerbosity?: boolean

Can decrease the verbosity of the hover

`Optional`canIncreaseVerbosity

canIncreaseVerbosity?: boolean

Can increase the verbosity of the hover

contents: (MarkdownString | MarkedString)[]

The contents of this hover.

`Optional`range

range?: Range

The range to which this hover applies. When missing, the editor will use the range at the current position or the current position itself.

Class VerboseHover

Hierarchy (View Summary)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns VerboseHover

Properties

`Optional`canDecreaseVerbosity

`Optional`canIncreaseVerbosity

contents

`Optional`range

Settings

On This Page

Class VerboseHover

Hierarchy (View Summary)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns VerboseHover

Properties

OptionalcanDecreaseVerbosity

OptionalcanIncreaseVerbosity

contents

Optionalrange

Settings

On This Page

`Optional`canDecreaseVerbosity

`Optional`canIncreaseVerbosity

`Optional`range