跳至主要内容

ElectronApplication

Electron应用程序的表示。您可以使用electron.launch()来获取应用程序实例。通过此实例,您可以控制主Electron进程以及与Electron窗口交互:

const { _electron: electron } = require('playwright');

(async () => {
// Launch Electron app.
const electronApp = await electron.launch({ args: ['main.js'] });

// Evaluation expression in the Electron context.
const appPath = await electronApp.evaluate(async ({ app }) => {
// This runs in the main Electron process, parameter here is always
// the result of the require('electron') in the main app script.
return app.getAppPath();
});
console.log(appPath);

// Get the first window that the app opens, wait if necessary.
const window = await electronApp.firstWindow();
// Print the title.
console.log(await window.title());
// Capture a screenshot.
await window.screenshot({ path: 'intro.png' });
// Direct Electron console to Node terminal.
window.on('console', console.log);
// Click button.
await window.click('text=Click me');
// Exit app.
await electronApp.close();
})();

方法

浏览器窗口

Added in: v1.11 electronApplication.browserWindow

返回与给定Playwright页面对应的BrowserWindow对象。

用法

await electronApplication.browserWindow(page);

参数

  • page Page#

    要检索窗口的页面。

返回


关闭

Added in: v1.9 electronApplication.close

关闭Electron应用程序。

用法

await electronApplication.close();

返回


上下文

Added in: v1.9 electronApplication.context

该方法返回浏览器上下文,可用于设置上下文范围内的路由等。

用法

electronApplication.context();

返回


评估

Added in: v1.9 electronApplication.evaluate

返回pageFunction的返回值。

如果传递给electronApplication.evaluate()的函数返回一个Promise,那么electronApplication.evaluate()将等待该promise解析并返回其值。

如果传递给electronApplication.evaluate()的函数返回一个非Serializable值,那么electronApplication.evaluate()将返回undefined。Playwright还支持传输一些无法通过JSON序列化的额外值:-0NaNInfinity-Infinity

用法

await electronApplication.evaluate(pageFunction);
await electronApplication.evaluate(pageFunction, arg);

参数

返回


evaluateHandle

Added in: v1.9 electronApplication.evaluateHandle

pageFunction的返回值作为JSHandle返回。

electronApplication.evaluate()electronApplication.evaluateHandle() 之间的唯一区别在于 electronApplication.evaluateHandle() 会返回 JSHandle

如果传递给electronApplication.evaluateHandle()的函数返回一个Promise,那么electronApplication.evaluateHandle()将等待该Promise解析并返回其值。

用法

await electronApplication.evaluateHandle(pageFunction);
await electronApplication.evaluateHandle(pageFunction, arg);

参数

返回


firstWindow

Added in: v1.9 electronApplication.firstWindow

等待第一个应用程序窗口打开的便捷方法。

用法

const electronApp = await electron.launch({
args: ['main.js']
});
const window = await electronApp.firstWindow();
// ...

参数

  • options Object (optional)
    • timeout number (可选) 添加于: v1.33#

      最大等待时间,单位为毫秒。默认为 30000 (30秒)。传入 0 可禁用超时。默认值可以通过 browserContext.setDefaultTimeout() 方法进行修改。

返回


进程

Added in: v1.21 electronApplication.process

返回此Electron应用程序的主进程。

用法

electronApplication.process();

返回


waitForEvent

Added in: v1.9 electronApplication.waitForEvent

等待事件触发并将其值传递给谓词函数。当谓词返回真值时返回。如果在事件触发前应用程序关闭,将抛出错误。返回事件数据值。

用法

const windowPromise = electronApp.waitForEvent('window');
await mainWindow.click('button');
const window = await windowPromise;

参数

  • event string#

    事件名称,通常与传入*.on(event)中的名称相同。

  • optionsOrPredicate function | Object (可选)#

    • predicate function

      接收事件数据,当等待应解决时解析为真值。

    • timeout number (可选)

      最大等待时间,单位为毫秒。默认为30000(30秒)。传入0表示禁用超时。默认值可以通过browserContext.setDefaultTimeout()来修改。

    可以是一个接收事件的谓词函数,也可以是一个选项对象。可选参数。

返回


Windows

Added in: v1.9 electronApplication.windows

返回所有已打开窗口的便捷方法。

用法

electronApplication.windows();

返回


事件

on('close')

Added in: v1.9 electronApplication.on('close')

当应用程序进程被终止时,会发出此事件。

用法

electronApplication.on('close', data => {});

on('console')

Added in: v1.42 electronApplication.on('console')

当Electron主进程中的JavaScript调用console API方法之一时触发,例如console.logconsole.dir

传递给console.log的参数可在ConsoleMessage事件处理程序参数中使用。

用法

electronApp.on('console', async msg => {
const values = [];
for (const arg of msg.args())
values.push(await arg.jsonValue());
console.log(...values);
});
await electronApp.evaluate(() => console.log('hello', 5, { foo: 'bar' }));

事件数据


on('window')

Added in: v1.9 electronApplication.on('window')

该事件针对Electron中创建并加载的每个窗口触发。它包含一个可用于Playwright自动化的Page

用法

electronApplication.on('window', data => {});

事件数据