Skip to content

class-dialog.mdx

Latest commit

 

History

History
249 lines (193 loc) · 10.9 KB

class-dialog.mdx

File metadata and controls

249 lines (193 loc) · 10.9 KB
id class-dialog
title Dialog

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import HTMLCard from '@site/src/components/HTMLCard';

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 {#dialog-accept}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9dialog.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 {#dialog-default-value}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9dialog.defaultValue

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

Usage

dialog.defaultValue();

Returns

dismiss {#dialog-dismiss}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9dialog.dismiss

Returns when the dialog has been dismissed.

Usage

await dialog.dismiss();

Returns

message {#dialog-message}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9dialog.message

A message displayed in the dialog.

Usage

dialog.message();

Returns

page {#dialog-page}

<font size="2" style={{position: "relative", top: "-20px"}}>Added in: v1.34dialog.page

The page that initiated this dialog, if available.

Usage

dialog.page();

Returns

type {#dialog-type}

<font size="2" style={{position: "relative", top: "-20px"}}>Added before v1.9dialog.type

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

Usage

dialog.type();

Returns