Theia API Documentation v1.65.0
    Preparing search index...

    Implements

    • ILink
    Index

    Constructors

    Properties

    context: LinkContext
    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.

    mouseEnteredHover: boolean = false
    mouseLeftHover: boolean = false
    preferences: PreferenceService
    range: IBufferRange

    The buffer range of the link.

    terminalWidget: TerminalWidgetImpl
    text: string

    The text of the link.

    toDispose: DisposableCollection = ...

    Methods

    • 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 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