/
tokens.ts
56 lines (49 loc) · 1.42 KB
/
tokens.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { CodeEditor } from '@jupyterlab/codeeditor';
import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
import { Kernel } from '@jupyterlab/services';
import { Token } from '@lumino/coreutils';
import { Widget } from '@lumino/widgets';
/**
* The tooltip manager token.
*/
export const ITooltipManager = new Token<ITooltipManager>(
'@jupyterlab/tooltip:ITooltipManager',
'A service for the tooltip manager for the application. Use this to allow your extension to invoke a tooltip.'
);
/**
* A manager to register tooltips with parent widgets.
*/
export interface ITooltipManager {
/**
* Invoke a tooltip.
*/
invoke(options: ITooltipManager.IOptions): void;
}
/**
* A namespace for `ITooltipManager` interface specifications.
*/
export namespace ITooltipManager {
/**
* An interface for tooltip-compatible objects.
*/
export interface IOptions {
/**
* The referent anchor the tooltip follows.
*/
readonly anchor: Widget;
/**
* The referent editor for the tooltip.
*/
readonly editor: CodeEditor.IEditor;
/**
* The kernel the tooltip communicates with to populate itself.
*/
readonly kernel: Kernel.IKernelConnection;
/**
* The renderer the tooltip uses to render API responses.
*/
readonly rendermime: IRenderMimeRegistry;
}
}