gespenst API - v0.1.0
    Preparing search index...

    Interface ILink

    A link within the terminal.

    interface ILink {
        decorations?: ILinkDecorations;
        range: IBufferRange;
        text: string;
        activate(event: MouseEvent, text: string): void;
        dispose?(): void;
        hover?(event: MouseEvent, text: string): void;
        leave?(event: MouseEvent, text: string): void;
    }
    Index
    decorations? range text
    activate dispose? hover? leave?
    decorations?: ILinkDecorations

    What link decorations to show when hovering the link, this property is tracked and changes made after the link is provided will trigger changes. If not set, all decroations will be enabled.

    range: IBufferRange

    The buffer range of the link.

    text

    text: string

    The text of the link.

    • Calls when the link is activated.

      Parameters

      • event: MouseEvent

        The mouse event triggering the callback.

      • text: string

        The text of the link.

      Returns void

    • Called when the link is released and no longer used by xterm.js.

      Returns void

    • Called when the mouse hovers the link. To use this to create a DOM-based hover tooltip, create the hover element within Terminal.element and add the xterm-hover class to it, that will cause mouse events to not fall through and activate other links.

      Parameters

      • event: MouseEvent

        The mouse event triggering the callback.

      • text: string

        The text of the link.

      Returns void

    • Called when the mouse leaves the link.

      Parameters

      • event: MouseEvent

        The mouse event triggering the callback.

      • text: string

        The text of the link.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods