📄 playwright-python/python/docs/api/class-dialog

File: class-dialog.md | Updated: 11/18/2025

Source: https://playwright.dev/python/docs/api/class-dialog

Skip to main content

On this page

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

An example of using Dialog class:

  • Sync

  • Async

    from playwright.sync_api import sync_playwright, Playwrightdef handle_dialog(dialog): print(dialog.message) dialog.dismiss()def run(playwright: Playwright): chromium = playwright.chromium browser = chromium.launch() page = browser.new_page() page.on("dialog", handle_dialog) page.evaluate("alert('1')") browser.close()with sync_playwright() as playwright: run(playwright)

    import asynciofrom playwright.async_api import async_playwright, Playwrightasync def handle_dialog(dialog): print(dialog.message) await dialog.dismiss()async def run(playwright: Playwright): chromium = playwright.chromium browser = await chromium.launch() page = await browser.new_page() page.on("dialog", handle_dialog) page.evaluate("alert('1')") await browser.close()async def main(): async with async_playwright() as playwright: await run(playwright)asyncio.run(main())

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 before v1.9 dialog.accept

Returns when the dialog has been accepted.

Usage

dialog.accept()dialog.accept(**kwargs)

Arguments

  • prompt_text str (optional)#

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

Returns

dismiss​

Added before v1.9 dialog.dismiss

Returns when the dialog has been dismissed.

Usage

dialog.dismiss()

Returns

Properties​

default_value​

Added before v1.9 dialog.default_value

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

Usage

dialog.default_value

Returns

message​

Added before v1.9 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 before v1.9 dialog.type

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

Usage

dialog.type

Returns