github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-07 22:54:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: deprecate clipboard API access from renderer processes (#48877)

Browse Source
This commit is contained in:
John Kleinschmidt
2025-11-12 10:16:31 -05:00
committed by GitHub
parent 7961206fcb
commit 27727dbe0a
3 changed files with 44 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
lib/renderer/api/clipboard.ts
View File

@@ -1,21 +1,45 @@
import * as deprecate from '@electron/internal/common/deprecate';
import { IPC_MESSAGES } from '@electron/internal/common/ipc-messages';
import * as ipcRendererUtils from '@electron/internal/renderer/ipc-renderer-internal-utils';
const clipboard = process._linkedBinding('electron_common_clipboard');
const clipboard = {} as Electron.Clipboard;
const originalClipboard = process._linkedBinding('electron_common_clipboard');
const warnDeprecatedAccess = function (method: keyof Electron.Clipboard) {
return deprecate.warnOnceMessage(`Accessing 'clipboard.${method}' from the renderer process is
deprecated and will be removed. Please use the 'contextBridge' API to access
the clipboard API from the renderer.`);
};
const makeDeprecatedMethod = function (method: keyof Electron.Clipboard): any {
const warnDeprecated = warnDeprecatedAccess(method);
return (...args: any[]) => {
warnDeprecated();
return (originalClipboard[method] as any)(...args);
};
};
const makeRemoteMethod = function (method: keyof Electron.Clipboard): any {
return (...args: any[]) => ipcRendererUtils.invokeSync(IPC_MESSAGES.BROWSER_CLIPBOARD_SYNC, method, ...args);
const warnDeprecated = warnDeprecatedAccess(method);
return (...args: any[]) => {
warnDeprecated();
return ipcRendererUtils.invokeSync(IPC_MESSAGES.BROWSER_CLIPBOARD_SYNC, method, ...args);
};
};
if (process.platform === 'linux') {
// On Linux we could not access clipboard in renderer process.
for (const method of Object.keys(clipboard) as (keyof Electron.Clipboard)[]) {
for (const method of Object.keys(originalClipboard) as (keyof Electron.Clipboard)[]) {
clipboard[method] = makeRemoteMethod(method);
}
} else if (process.platform === 'darwin') {
// Read/write to find pasteboard over IPC since only main process is notified of changes
clipboard.readFindText = makeRemoteMethod('readFindText');
clipboard.writeFindText = makeRemoteMethod('writeFindText');
} else {
for (const method of Object.keys(originalClipboard) as (keyof Electron.Clipboard)[]) {
if (process.platform === 'darwin' && (method === 'readFindText' || method === 'writeFindText')) {
clipboard[method] = makeRemoteMethod(method);
} else {
clipboard[method] = makeDeprecatedMethod(method);
}
}
}
export default clipboard;