View source

class Hover

package vscode

@:jsRequire("vscode","Hover")

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

Constructor

new(contents:EitherType<MarkdownString, EitherType<MarkedString, Array<EitherType<MarkdownString, MarkedString>>>>, ?range:Range)

Creates a new hover object.

Parameters:

contents

The contents of the hover.

range

The range to which the hover applies.

Variables

contents:Array<EitherType<MarkdownString, MarkedString>>

The contents of this hover.

range:Null<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.