Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes #182449 : Pressing Shift re-enables webview during Drag and Drop Events #209211

Merged
merged 18 commits into from
Jun 19, 2024
Merged

Fixes #182449 : Pressing Shift re-enables webview during Drag and Drop Events #209211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
380d97d
added shift key listener to re-enable drag events for webview https:/…
swordensen Mar 31, 2024
be66f6f
adding drag and drag over listeners to webview iframe(s)
swordensen Apr 5, 2024
f196319
Merge branch 'main' into main
swordensen Apr 11, 2024
42b7633
Merge branch 'main' into main
swordensen Apr 12, 2024
fe8151d
Merge branch 'main' into main
swordensen Apr 14, 2024
98e3a68
Merge branch 'main' into main
swordensen Apr 15, 2024
e76c059
Merge branch 'main' into main
swordensen Apr 16, 2024
c6361ee
Merge branch 'main' into main
swordensen May 9, 2024
97b4988
Merge branch 'main' into main
swordensen May 17, 2024
8af6d82
Merge branch 'main' into main
swordensen May 21, 2024
53ad1f1
Merge branch 'main' into main
swordensen May 29, 2024
8b967f9
Merge branch 'main' into main
swordensen May 31, 2024
c8afa84
Merge branch 'main' into conflict
swordensen Jun 13, 2024
ff222e5
updating sha
swordensen Jun 13, 2024
306e5be
Merge branch 'main' into conflict
swordensen Jun 13, 2024
889f3c5
Merge branch 'main' into conflict
swordensen Jun 15, 2024
7b89902
Merge branch 'main' into conflict
swordensen Jun 18, 2024
f123cd2
Merge branch 'main' into conflict
swordensen Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions src/vs/workbench/contrib/webview/browser/pre/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
<meta charset="UTF-8">

<meta http-equiv="Content-Security-Policy"
content="default-src 'none'; script-src 'sha256-noHVLQsurkONXmA3fcuAmcZ8UPYm/db88mhm9gAXcvk=' 'self'; frame-src 'self'; style-src 'unsafe-inline';">

content="default-src 'none'; script-src 'sha256-EJBlYt9sOvo6RhZZJG+duTqIZCB8pctk1a62h/ZIElc=' 'self'; frame-src 'self'; style-src 'unsafe-inline';">


<!-- Disable pinch zooming -->
<meta name="viewport"
Expand Down Expand Up @@ -791,6 +793,17 @@
}
}


function handleInnerDragEvent(/** @type {DragEvent} */ e) {
if (!e.dataTransfer) {
return;
}

hostMessaging.postMessage('drag', {
shiftKey: e.shiftKey
});
}

/**
* @param {() => void} callback
*/
Expand Down Expand Up @@ -881,7 +894,9 @@
window.addEventListener('keydown', handleInnerKeydown);
window.addEventListener('keyup', handleInnerKeyup);
window.addEventListener('dragenter', handleInnerDragStartEvent);
window.addEventListener('dragover', handleInnerDragStartEvent);
window.addEventListener('dragover', handleInnerDragEvent);
window.addEventListener('drag', handleInnerDragEvent);


onDomReady(() => {
if (!document.body) {
Expand Down Expand Up @@ -1163,7 +1178,8 @@
});

contentWindow.addEventListener('dragenter', handleInnerDragStartEvent);
contentWindow.addEventListener('dragover', handleInnerDragStartEvent);
contentWindow.addEventListener('dragover', handleInnerDragEvent);
contentWindow.addEventListener('drag', handleInnerDragEvent);

unloadMonitor.onIframeLoaded(newFrame);
}
Expand Down
17 changes: 16 additions & 1 deletion src/vs/workbench/contrib/webview/browser/webviewElement.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import { loadLocalResource, WebviewResourceResponse } from 'vs/workbench/contrib
import { WebviewThemeDataProvider } from 'vs/workbench/contrib/webview/browser/themeing';
import { areWebviewContentOptionsEqual, IWebview, WebviewContentOptions, WebviewExtensionDescription, WebviewInitInfo, WebviewMessageReceivedEvent, WebviewOptions } from 'vs/workbench/contrib/webview/browser/webview';
import { WebviewFindDelegate, WebviewFindWidget } from 'vs/workbench/contrib/webview/browser/webviewFindWidget';
import { FromWebviewMessage, KeyEvent, ToWebviewMessage } from 'vs/workbench/contrib/webview/browser/webviewMessages';
import { FromWebviewMessage, KeyEvent, ToWebviewMessage, WebViewDragEvent } from 'vs/workbench/contrib/webview/browser/webviewMessages';
import { decodeAuthority, webviewGenericCspSource, webviewRootResourceAuthority } from 'vs/workbench/contrib/webview/common/webview';
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
import { CodeWindow } from 'vs/base/browser/window';
Expand Down Expand Up @@ -310,6 +310,10 @@ export class WebviewElement extends Disposable implements IWebview, WebviewFindD
this._startBlockingIframeDragEvents();
}));

this._register(this.on('drag', (event) => {
this.handleDragEvent('drag', event);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we likely need to prevent default after we pass this to our custom drag event listener

}));

if (initInfo.options.enableFindWidget) {
this._webviewFindWidget = this._register(instantiationService.createInstance(WebviewFindWidget, this));
}
Expand Down Expand Up @@ -697,6 +701,17 @@ export class WebviewElement extends Disposable implements IWebview, WebviewFindD
this.window?.dispatchEvent(emulatedKeyboardEvent);
}

private handleDragEvent(type: 'drag', event: WebViewDragEvent) {
// Create a fake DragEvent from the data provided
const emulatedDragEvent = new DragEvent(type, event);
// Force override the target
Object.defineProperty(emulatedDragEvent, 'target', {
get: () => this.element,
});
// And re-dispatch
this.window?.dispatchEvent(emulatedDragEvent);
}

windowDidDragStart(): void {
// Webview break drag and dropping around the main window (no events are generated when you are over them)
// Work around this by disabling pointer events during the drag.
Expand Down
5 changes: 5 additions & 0 deletions src/vs/workbench/contrib/webview/browser/webviewMessages.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ type KeyEvent = {
repeat: boolean;
}

type WebViewDragEvent = {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to type this DragEvent instead of WebViewDragEvent but, the tests failed. I can only assume this is due to a collision with the standard DOM DragEvent type. I would have expected a typescript error though, this was hard to figure out.

shiftKey: boolean;
}

export type FromWebviewMessage = {
'onmessage': { message: any; transfer?: ArrayBuffer[] };
'did-click-link': { uri: string };
Expand All @@ -36,6 +40,7 @@ export type FromWebviewMessage = {
'did-keyup': KeyEvent;
'did-context-menu': { clientX: number; clientY: number; context: { [key: string]: unknown } };
'drag-start': void;
'drag': WebViewDragEvent
};

interface UpdateContentEvent {
Expand Down
26 changes: 24 additions & 2 deletions src/vs/workbench/contrib/webview/browser/webviewWindowDragMonitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,41 @@ export class WebviewWindowDragMonitor extends Disposable {
constructor(targetWindow: CodeWindow, getWebview: () => IWebview | undefined) {
super();

this._register(DOM.addDisposableListener(targetWindow, DOM.EventType.DRAG_START, () => {
const > () => {
getWebview()?.windowDidDragStart();
}));
};

const => {
getWebview()?.windowDidDragEnd();
};

this._register(DOM.addDisposableListener(targetWindow, DOM.EventType.DRAG_START, () => {
onDragStart();
}));

this._register(DOM.addDisposableListener(targetWindow, DOM.EventType.DRAG_END, onDragEnd));

this._register(DOM.addDisposableListener(targetWindow, DOM.EventType.MOUSE_MOVE, currentEvent => {
if (currentEvent.buttons === 0) {
onDragEnd();
}
}));

this._register(DOM.addDisposableListener(targetWindow, DOM.EventType.DRAG, (event) => {
if (event.shiftKey) {
onDragEnd();
} else {
onDragStart();
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could change this to re-disable the webview when the user releases shift.

			if (event.shiftKey) {
				onDragEnd();
			} else {
                                onDragStart();
                        }

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I think that makes sense. Otherwise you have to restart dragging if you want to open the dragged resource in an editor instead of dropping it into the webview

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mjbvz I've made some updates to address the feature that was requested. I noticed you tagged this with the April 2024 milestone and I would love to address any change requests/concerns prior to that deadline.

And thank you for your hard work!

}));

this._register(DOM.addDisposableListener(targetWindow, DOM.EventType.DRAG_OVER, (event) => {
if (event.shiftKey) {
onDragEnd();
} else {
onDragStart();
}
}));

}
}
Loading