<link rel="stylesheet" href="/_merged_assets/_static/noscript.css">
Atom Community Logo Atom Community API Getting Started Toggle darkmode

Datatip GitHub

A replacement of the DataTip functionality from atom-ide-ui. When you hover over a symbol in your code (or move your cursor to it), it can show you details about that symbol in a tool tip. More details

screenshot of datatip feature

API

DatatipProvider

Properties

grammarScopes

(optional)
readonly string[]

Either pass this or validForScope

priority

number

providerName

string

A unique name for the provider to be used for analytics. It is recommended that it be the name of the provider's package.

Methods

datatip

Parameters

editor
TextEditor
bufferPosition
Point
mouseEvent
null|MouseEvent

Returns

Promise<undefined|null|Datatip>

validForScope

Either pass grammarScopes or this function.

Parameters

scopeName
string

Returns

boolean

DatatipService

Methods

addModifierProvider

Parameters

provider
ModifierDatatipProvider

Returns

DisposableLike

addProvider

Parameters

provider
DatatipProvider

Returns

DisposableLike

createPinnedDataTip

Parameters

datatip
Datatip
editor
TextEditor
options
PinnedDatatipOptions

Returns

DisposableLike

MarkdownMarkedString

Borrowed from the LSP API.

Properties

type

"markdown"

value

string

MarkedStringDatatip

Properties

markedStrings

MarkedString[]

pinnable

(optional)
boolean

range

Range

ModifierDatatipProvider

Properties

grammarScopes

(optional)
string[]

priority

number

providerName

string

Methods

modifierDatatip

Parameters

editor
TextEditor
bufferPosition
Point
heldKeys
Set<ModifierKey>

Returns

Promise<undefined|null|Datatip>

PinnedDatatipOptions

Properties

position

(optional)
PinnedDatatipPosition

Defaults to 'end-of-line'.

showRangeHighlight

(optional)
boolean

Defaults to true.

ReactComponentDatatip

Properties

component


  

React component

pinnable

(optional)
boolean

range

Range

SnippetMarkedString

Properties

grammar

Grammar

type

"snippet"

value

string

AnyDatatipProvider

Datatip

MarkedString

ModifierKey

PinnedDatatipPosition