jupyterlab/packages/tooltip/src/index.ts

// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.

import { Kernel } from '@jupyterlab/services';

import { Token } from '@phosphor/coreutils';

import { Widget } from '@phosphor/widgets';

import { CodeEditor } from '@jupyterlab/codeeditor';

import { RenderMimeRegistry } from '@jupyterlab/rendermime';

import '../style/index.css';

export * from './widget';

/* tslint:disable */
/**
 * The tooltip manager token.
 */
export const ITooltipManager = new Token<ITooltipManager>(
  '@jupyterlab/tooltip:ITooltipManager'
);
/* tslint:enable */

/**
 * A manager to register tooltips with parent widgets.
 */
export interface ITooltipManager {
  /**
   * Invoke a tooltip.
   */
  invoke(options: ITooltipManager.IOptions): void;
}

/**
 * A namespace for `ICompletionManager` 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: RenderMimeRegistry;
  }
}