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

    Drags the tabs of dock panels with native HTML drag and drop instead of Lumino's pointer based drag and drop. Native drags work across windows, e.g. secondary windows, and show the drag image outside of the window as well.

    Drop targets are not aware of this: the native drag events are translated to the Lumino drag events (lm-dragenter, lm-dragover, lm-dragleave and lm-drop) that Lumino drop targets handle.

    Index
    onDidDropTab: Event<TabDropEvent> = ...

    Emitted when a tab has been dropped on a drop target in one of the windows of the application.

    onDidDropTabEmitter: Emitter<TabDropEvent> = ...
    onDidDropTabOutsideWindows: Event<TabDropOutsideWindowsEvent> = ...

    Emitted when a tab is released outside of all windows of the application, e.g. over the desktop.

    onDidDropTabOutsideWindowsEmitter: Emitter<TabDropOutsideWindowsEvent> = ...
    onDidEndDrag: Event<DragEvent> = ...

    Emitted when a tab drag has ended, with its dragend event, or with the drop event of a successful drop. Native drags end without a mouseup event.

    onDidEndDragEmitter: Emitter<DragEvent> = ...
    onDidStartDrag: Event<DragEvent> = ...

    Emitted when a tab drag has started, with its dragstart event.

    onDidStartDragEmitter: Emitter<DragEvent> = ...
    session: NativeTabDragSession | undefined
    targetAncestors: WeakMap<Element, Element[]> = ...

    The ancestors of the drop targets, see rememberAncestors.

    windows: Map<Window, WindowDragState> = ...
    LEAVE_DELAY: 150

    The time without native drag events in a window after which the pointer is considered to have left the window. Native dragleave events are also fired when the pointer moves between the elements of a window, while native dragover events are fired continuously as long as the pointer is over a window.

    MIME_TYPE: "application/vnd.theia.dock-panel-tab" = 'application/vnd.theia.dock-panel-tab'
    • Parameters

      • state: WindowDragState
      • type: LuminoDragEventType
      • target: Element
      • event: DragEvent
      • related: Element | undefined

      Returns Event

    • Follows Private.dispatchDragEnter in @lumino/dragdrop.

      Parameters

      • state: WindowDragState
      • currElem: Element | undefined
      • currTarget: Element | undefined
      • event: DragEvent

      Returns Element | undefined

    • Ends the current drag session and notifies the drop targets under the pointer that the drag has left them.

      Parameters

      • event: DragEvent

        the event that ends the drag, i.e. its dragend event or the drop event of a successful drop

      Returns void

    • Drop targets are often elements that are replaced while dragging, e.g. the lines of an editor that is re-rendered because a side panel expands. Lumino drag events dispatched to a removed element don't reach the drop target that handles them, e.g. the dock panel that has to hide its drop overlay. Such events are dispatched to the nearest ancestor that is still attached instead.

      Parameters

      • target: Element

      Returns void

    • Updates the Lumino drop target under the pointer, following Drag._updateCurrentTarget in @lumino/dragdrop.

      Parameters

      • state: WindowDragState
      • event: DragEvent

      Returns void