Skip to main content

Dialog

Dialog objects are dispatched by page via the page.on('dialog') event.

An example of using Dialog class:

const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  page.on('dialog', async dialog => {
    console.log(dialog.message());
    await dialog.dismiss();
  });
  await page.evaluate(() => alert('1'));
  await browser.close();
})();
note

Dialogs are dismissed automatically, unless there is a page.on('dialog') listener. When listener is present, it must either dialog.accept() or dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.

Methods​

accept​

Added in: v1.8 dialog.accept

Returns when the dialog has been accepted.

Usage

await dialog.accept();
await dialog.accept(promptText);

Arguments

  • promptText string (optional)#

    A text to enter in prompt. Does not cause any effects if the dialog's type is not prompt. Optional.

Returns

defaultValue​

Added in: v1.8 dialog.defaultValue

If dialog is prompt, returns default prompt value. Otherwise, returns empty string.

Usage

dialog.defaultValue();

Returns

dismiss​

Added in: v1.8 dialog.dismiss

Returns when the dialog has been dismissed.

Usage

await dialog.dismiss();

Returns

message​

Added in: v1.8 dialog.message

A message displayed in the dialog.

Usage

dialog.message();

Returns

page​

Added in: v1.34 dialog.page

The page that initiated this dialog, if available.

Usage

dialog.page();

Returns

type​

Added in: v1.8 dialog.type

Returns dialog's type, can be one of alert, beforeunload, confirm or prompt.

Usage

dialog.type();

Returns