UNPKG

@theia/core

Version:

Theia is a cloud & desktop IDE framework implemented in TypeScript.

41 lines 2.06 kB
import { Disposable, DisposableCollection } from '../common'; import { MarkdownString } from '../common/markdown-rendering/markdown-string'; import { MarkdownRenderer, MarkdownRendererFactory } from './markdown-rendering/markdown-renderer'; import { PreferenceService } from './preferences'; import '../../src/browser/style/hover-service.css'; export declare type HoverPosition = 'left' | 'right' | 'top' | 'bottom'; export declare namespace HoverPosition { function invertIfNecessary(position: HoverPosition, target: DOMRect, host: DOMRect, totalWidth: number, totalHeight: number): HoverPosition; } export interface HoverRequest { content: string | MarkdownString | HTMLElement; target: HTMLElement; /** * The position where the hover should appear. * Note that the hover service will try to invert the position (i.e. right -> left) * if the specified content does not fit in the window next to the target element */ position: HoverPosition; } export declare class HoverService { protected static hostClassName: string; protected static styleSheetId: string; protected readonly preferences: PreferenceService; protected readonly markdownRendererFactory: MarkdownRendererFactory; protected _markdownRenderer: MarkdownRenderer | undefined; protected get markdownRenderer(): MarkdownRenderer; protected _hoverHost: HTMLElement | undefined; protected get hoverHost(): HTMLElement; protected pendingTimeout: Disposable | undefined; protected hoverTarget: HTMLElement | undefined; protected lastHidHover: number; protected readonly disposeOnHide: DisposableCollection; requestHover(request: HoverRequest): void; protected getHoverDelay(): number; protected renderHover(request: HoverRequest): Promise<void>; protected setHostPosition(target: HTMLElement, host: HTMLElement, position: HoverPosition): HoverPosition; protected listenForMouseOut(): void; cancelHover(): void; protected unRenderHover(): void; } //# sourceMappingURL=hover-service.d.ts.map