Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
docs(electron): document mocking the native main-process dialog API (#40952)
Yury Semikhatskyc1b1aa6bcc35
diff --git a/docs/src/electron-api/class-electron.md b/docs/src/electron-api/class-electron.mdindex 1df55a214a..60e64080e0 100644--- a/docs/src/electron-api/class-electron.md+++ b/docs/src/electron-api/class-electron.md@@ -51,6 +51,34 @@ If you are not able to launch Electron and it will end up in timeouts during lau* Ensure that `nodeCliInspect` ([FuseV1Options.EnableNodeCliInspectArguments](https://www.electronjs.org/docs/latest/tutorial/fuses#nodecliinspect)) fuse is **not** set to `false`.+**Mocking native dialogs:**++Playwright does not intercept the native Electron [dialog](https://www.electronjs.org/docs/latest/api/dialog) API+(`dialog.showOpenDialog`, `dialog.showSaveDialog`, `dialog.showMessageBox`, etc.) because those calls happen in the+Electron main process and go straight to OS APIs. Use [`method: ElectronApplication.evaluate`] to replace the+relevant methods in the main process so tests run deterministically without any OS-level UI:++```js+// Stub the open dialog to always return a fixed path.+await electronApp.evaluate(({ dialog }, filePaths) => {+ dialog.showOpenDialog = () => Promise.resolve({ canceled: false, filePaths });+}, ['/path/to/file.txt']);++// Stub the save dialog.+await electronApp.evaluate(({ dialog }, filePath) => {+ dialog.showSaveDialog = () => Promise.resolve({ canceled: false, filePath });+}, '/path/to/saved.txt');++// Stub showMessageBox to click the first button.+await electronApp.evaluate(({ dialog }) => {+ dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });+});+```++The replacement persists until the application is closed. Synchronous variants+(`showOpenDialogSync`, `showSaveDialogSync`, `showMessageBoxSync`) can be stubbed the same way — just return the+value directly instead of a `Promise`.+## async method: Electron.launch* since: v1.9- returns: <[ElectronApplication]>diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.tsindex 7bae445814..5136b94b64 100644--- a/packages/playwright-client/types/types.d.ts+++ b/packages/playwright-client/types/types.d.ts@@ -22241,6 +22241,35 @@ export interface WebStorage {* - Ensure that `nodeCliInspect`* ([FuseV1Options.EnableNodeCliInspectArguments](https://www.electronjs.org/docs/latest/tutorial/fuses#nodecliinspect))* fuse is **not** set to `false`.+ *+ * **Mocking native dialogs:**+ *+ * Playwright does not intercept the native Electron [dialog](https://www.electronjs.org/docs/latest/api/dialog) API+ * (`dialog.showOpenDialog`, `dialog.showSaveDialog`, `dialog.showMessageBox`, etc.) because those calls happen in the+ * Electron main process and go straight to OS APIs. Use+ * [electronApplication.evaluate(pageFunction[, arg])](https://playwright.dev/docs/api/class-electronapplication#electron-application-evaluate)+ * to replace the relevant methods in the main process so tests run deterministically without any OS-level UI:+ *+ * ```js+ * // Stub the open dialog to always return a fixed path.+ * await electronApp.evaluate(({ dialog }, filePaths) => {+ * dialog.showOpenDialog = () => Promise.resolve({ canceled: false, filePaths });+ * }, ['/path/to/file.txt']);+ *+ * // Stub the save dialog.+ * await electronApp.evaluate(({ dialog }, filePath) => {+ * dialog.showSaveDialog = () => Promise.resolve({ canceled: false, filePath });+ * }, '/path/to/saved.txt');+ *+ * // Stub showMessageBox to click the first button.+ * await electronApp.evaluate(({ dialog }) => {+ * dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });+ * });+ * ```+ *+ * The replacement persists until the application is closed. Synchronous variants (`showOpenDialogSync`,+ * `showSaveDialogSync`, `showMessageBoxSync`) can be stubbed the same way — just return the value directly instead of+ * a `Promise`.*/export interface Electron {/**diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.tsindex 7bae445814..5136b94b64 100644--- a/packages/playwright-core/types/types.d.ts+++ b/packages/playwright-core/types/types.d.ts@@ -22241,6 +22241,35 @@ export interface WebStorage {* - Ensure that `nodeCliInspect`* ([FuseV1Options.EnableNodeCliInspectArguments](https://www.electronjs.org/docs/latest/tutorial/fuses#nodecliinspect))* fuse is **not** set to `false`.+ *+ * **Mocking native dialogs:**+ *+ * Playwright does not intercept the native Electron [dialog](https://www.electronjs.org/docs/latest/api/dialog) API+ * (`dialog.showOpenDialog`, `dialog.showSaveDialog`, `dialog.showMessageBox`, etc.) because those calls happen in the+ * Electron main process and go straight to OS APIs. Use+ * [electronApplication.evaluate(pageFunction[, arg])](https://playwright.dev/docs/api/class-electronapplication#electron-application-evaluate)+ * to replace the relevant methods in the main process so tests run deterministically without any OS-level UI:+ *+ * ```js+ * // Stub the open dialog to always return a fixed path.+ * await electronApp.evaluate(({ dialog }, filePaths) => {+ * dialog.showOpenDialog = () => Promise.resolve({ canceled: false, filePaths });+ * }, ['/path/to/file.txt']);+ *+ * // Stub the save dialog.+ * await electronApp.evaluate(({ dialog }, filePath) => {+ * dialog.showSaveDialog = () => Promise.resolve({ canceled: false, filePath });+ * }, '/path/to/saved.txt');+ *+ * // Stub showMessageBox to click the first button.+ * await electronApp.evaluate(({ dialog }) => {+ * dialog.showMessageBox = () => Promise.resolve({ response: 0, checkboxChecked: false });+ * });+ * ```+ *+ * The replacement persists until the application is closed. Synchronous variants (`showOpenDialogSync`,+ * `showSaveDialogSync`, `showMessageBoxSync`) can be stubbed the same way — just return the value directly instead of+ * a `Promise`.*/export interface Electron {/**