• extends: [EventEmitter]

Page provides methods to interact with a single tab in a [Browser], or an extension background page in Chromium. One [Browser] instance might have multiple [Page] instances.

This example creates a page, navigates it to a URL, and then saves a screenshot:

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

(async () => {
const browser = await webkit.launch();
const context = await browser.newContext();
const page = await context.newPage();
await page.goto('https://example.com');
await page.screenshot({path: 'screenshot.png'});
await browser.close();
})();

The Page class emits various events (described below) which can be handled using any of Node's native EventEmitter methods, such as on, once or removeListener.

This example logs a message for a single page load event:

page.once('load', () => console.log('Page loaded!'));

To unsubscribe from events use the removeListener method:

function logRequest(interceptedRequest) {
console.log('A request was made:', interceptedRequest.url());
}
page.on('request', logRequest);
// Sometime later...
page.removeListener('request', logRequest);
interface Page {
    accessibility: Accessibility;
    coverage: Coverage;
    keyboard: Keyboard;
    mouse: Mouse;
    request: APIRequestContext;
    touchscreen: Touchscreen;
    $<K>(selector: K, options?: {
        strict: boolean;
    }): Promise<null | ElementHandleForTag<K>>;
    $(selector: string, options?: {
        strict: boolean;
    }): Promise<null | ElementHandle<HTMLElement | SVGElement>>;
    $$<K>(selector: K): Promise<ElementHandleForTag<K>[]>;
    $$(selector: string): Promise<ElementHandle<HTMLElement | SVGElement>[]>;
    $$eval<K, R, Arg>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K][], Arg, R>, arg: Arg): Promise<R>;
    $$eval<R, Arg, E>(selector: string, pageFunction: PageFunctionOn<E[], Arg, R>, arg: Arg): Promise<R>;
    $$eval<K, R>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K][], void, R>, arg?: any): Promise<R>;
    $$eval<R, E>(selector: string, pageFunction: PageFunctionOn<E[], void, R>, arg?: any): Promise<R>;
    $eval<K, R, Arg>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K], Arg, R>, arg: Arg): Promise<R>;
    $eval<R, Arg, E>(selector: string, pageFunction: PageFunctionOn<E, Arg, R>, arg: Arg): Promise<R>;
    $eval<K, R>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K], void, R>, arg?: any): Promise<R>;
    $eval<R, E>(selector: string, pageFunction: PageFunctionOn<E, void, R>, arg?: any): Promise<R>;
    addInitScript<Arg>(script: PageFunction<Arg, any> | {
        content?: string;
        path?: string;
    }, arg?: Arg): Promise<void>;
    addListener(event: "close", listener: ((page: Page) => void)): this;
    addListener(event: "console", listener: ((consoleMessage: ConsoleMessage) => void)): this;
    addListener(event: "crash", listener: ((page: Page) => void)): this;
    addListener(event: "dialog", listener: ((dialog: Dialog) => void)): this;
    addListener(event: "domcontentloaded", listener: ((page: Page) => void)): this;
    addListener(event: "download", listener: ((download: Download) => void)): this;
    addListener(event: "filechooser", listener: ((fileChooser: FileChooser) => void)): this;
    addListener(event: "frameattached", listener: ((frame: Frame) => void)): this;
    addListener(event: "framedetached", listener: ((frame: Frame) => void)): this;
    addListener(event: "framenavigated", listener: ((frame: Frame) => void)): this;
    addListener(event: "load", listener: ((page: Page) => void)): this;
    addListener(event: "pageerror", listener: ((error: Error) => void)): this;
    addListener(event: "popup", listener: ((page: Page) => void)): this;
    addListener(event: "request", listener: ((request: Request) => void)): this;
    addListener(event: "requestfailed", listener: ((request: Request) => void)): this;
    addListener(event: "requestfinished", listener: ((request: Request) => void)): this;
    addListener(event: "response", listener: ((response: Response) => void)): this;
    addListener(event: "websocket", listener: ((webSocket: WebSocket) => void)): this;
    addListener(event: "worker", listener: ((worker: Worker) => void)): this;
    addScriptTag(options?: {
        content?: string;
        path?: string;
        type?: string;
        url?: string;
    }): Promise<ElementHandle<Node>>;
    addStyleTag(options?: {
        content?: string;
        path?: string;
        url?: string;
    }): Promise<ElementHandle<Node>>;
    bringToFront(): Promise<void>;
    check(selector: string, options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        position?: {
            x: number;
            y: number;
        };
        strict?: boolean;
        timeout?: number;
        trial?: boolean;
    }): Promise<void>;
    click(selector: string, options?: {
        button?: "left" | "right" | "middle";
        clickCount?: number;
        delay?: number;
        force?: boolean;
        modifiers?: (
            | "Alt"
            | "Control"
            | "Meta"
            | "Shift")[];
        noWaitAfter?: boolean;
        position?: {
            x: number;
            y: number;
        };
        strict?: boolean;
        timeout?: number;
        trial?: boolean;
    }): Promise<void>;
    close(options?: {
        runBeforeUnload?: boolean;
    }): Promise<void>;
    content(): Promise<string>;
    context(): BrowserContext;
    dblclick(selector: string, options?: {
        button?: "left" | "right" | "middle";
        delay?: number;
        force?: boolean;
        modifiers?: (
            | "Alt"
            | "Control"
            | "Meta"
            | "Shift")[];
        noWaitAfter?: boolean;
        position?: {
            x: number;
            y: number;
        };
        strict?: boolean;
        timeout?: number;
        trial?: boolean;
    }): Promise<void>;
    dispatchEvent(selector: string, type: string, eventInit?: EvaluationArgument, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<void>;
    dragAndDrop(source: string, target: string, options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        sourcePosition?: {
            x: number;
            y: number;
        };
        strict?: boolean;
        targetPosition?: {
            x: number;
            y: number;
        };
        timeout?: number;
        trial?: boolean;
    }): Promise<void>;
    emulateMedia(options?: {
        colorScheme?:
            | null
            | "light"
            | "dark"
            | "no-preference";
        forcedColors?: null | "none" | "active";
        media?: null | "screen" | "print";
        reducedMotion?: null | "reduce" | "no-preference";
    }): Promise<void>;
    evaluate<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<R>;
    evaluate<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<R>;
    evaluateHandle<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<SmartHandle<R>>;
    evaluateHandle<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<SmartHandle<R>>;
    exposeBinding(name: string, playwrightBinding: ((source: BindingSource, arg: JSHandle<any>) => any), options: {
        handle: true;
    }): Promise<void>;
    exposeBinding(name: string, playwrightBinding: ((source: BindingSource, ...args: any[]) => any), options?: {
        handle?: boolean;
    }): Promise<void>;
    exposeFunction(name: string, callback: Function): Promise<void>;
    fill(selector: string, value: string, options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        strict?: boolean;
        timeout?: number;
    }): Promise<void>;
    focus(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<void>;
    frame(frameSelector: string | {
        name?: string;
        url?: string | RegExp | ((url: URL) => boolean);
    }): null | Frame;
    frameLocator(selector: string): FrameLocator;
    frames(): Frame[];
    getAttribute(selector: string, name: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<null | string>;
    getByAltText(text: string | RegExp, options?: {
        exact?: boolean;
    }): Locator;
    getByLabel(text: string | RegExp, options?: {
        exact?: boolean;
    }): Locator;
    getByPlaceholder(text: string | RegExp, options?: {
        exact?: boolean;
    }): Locator;
    getByRole(role:
        | "code"
        | "status"
        | "time"
        | "paragraph"
        | "table"
        | "checkbox"
        | "search"
        | "link"
        | "generic"
        | "document"
        | "region"
        | "log"
        | "none"
        | "article"
        | "blockquote"
        | "button"
        | "caption"
        | "dialog"
        | "figure"
        | "form"
        | "img"
        | "main"
        | "menu"
        | "meter"
        | "option"
        | "strong"
        | "alert"
        | "alertdialog"
        | "application"
        | "banner"
        | "cell"
        | "columnheader"
        | "combobox"
        | "complementary"
        | "contentinfo"
        | "definition"
        | "deletion"
        | "directory"
        | "emphasis"
        | "feed"
        | "grid"
        | "gridcell"
        | "group"
        | "heading"
        | "insertion"
        | "list"
        | "listbox"
        | "listitem"
        | "marquee"
        | "math"
        | "menubar"
        | "menuitem"
        | "menuitemcheckbox"
        | "menuitemradio"
        | "navigation"
        | "note"
        | "presentation"
        | "progressbar"
        | "radio"
        | "radiogroup"
        | "row"
        | "rowgroup"
        | "rowheader"
        | "scrollbar"
        | "searchbox"
        | "separator"
        | "slider"
        | "spinbutton"
        | "subscript"
        | "superscript"
        | "switch"
        | "tab"
        | "tablist"
        | "tabpanel"
        | "term"
        | "textbox"
        | "timer"
        | "toolbar"
        | "tooltip"
        | "tree"
        | "treegrid"
        | "treeitem", options?: {
        checked?: boolean;
        disabled?: boolean;
        exact?: boolean;
        expanded?: boolean;
        includeHidden?: boolean;
        level?: number;
        name?: string | RegExp;
        pressed?: boolean;
        selected?: boolean;
    }): Locator;
    getByTestId(testId: string | RegExp): Locator;
    getByText(text: string | RegExp, options?: {
        exact?: boolean;
    }): Locator;
    getByTitle(text: string | RegExp, options?: {
        exact?: boolean;
    }): Locator;
    goBack(options?: {
        timeout?: number;
        waitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit";
    }): Promise<null | Response>;
    goForward(options?: {
        timeout?: number;
        waitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit";
    }): Promise<null | Response>;
    goto(url: string, options?: {
        referer?: string;
        timeout?: number;
        waitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit";
    }): Promise<null | Response>;
    hover(selector: string, options?: {
        force?: boolean;
        modifiers?: (
            | "Alt"
            | "Control"
            | "Meta"
            | "Shift")[];
        noWaitAfter?: boolean;
        position?: {
            x: number;
            y: number;
        };
        strict?: boolean;
        timeout?: number;
        trial?: boolean;
    }): Promise<void>;
    innerHTML(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<string>;
    innerText(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<string>;
    inputValue(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<string>;
    isChecked(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<boolean>;
    isClosed(): boolean;
    isDisabled(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<boolean>;
    isEditable(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<boolean>;
    isEnabled(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<boolean>;
    isHidden(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<boolean>;
    isVisible(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<boolean>;
    locator(selector: string, options?: {
        has?: Locator;
        hasText?: string | RegExp;
    }): Locator;
    mainFrame(): Frame;
    off(event: "close", listener: ((page: Page) => void)): this;
    off(event: "console", listener: ((consoleMessage: ConsoleMessage) => void)): this;
    off(event: "crash", listener: ((page: Page) => void)): this;
    off(event: "dialog", listener: ((dialog: Dialog) => void)): this;
    off(event: "domcontentloaded", listener: ((page: Page) => void)): this;
    off(event: "download", listener: ((download: Download) => void)): this;
    off(event: "filechooser", listener: ((fileChooser: FileChooser) => void)): this;
    off(event: "frameattached", listener: ((frame: Frame) => void)): this;
    off(event: "framedetached", listener: ((frame: Frame) => void)): this;
    off(event: "framenavigated", listener: ((frame: Frame) => void)): this;
    off(event: "load", listener: ((page: Page) => void)): this;
    off(event: "pageerror", listener: ((error: Error) => void)): this;
    off(event: "popup", listener: ((page: Page) => void)): this;
    off(event: "request", listener: ((request: Request) => void)): this;
    off(event: "requestfailed", listener: ((request: Request) => void)): this;
    off(event: "requestfinished", listener: ((request: Request) => void)): this;
    off(event: "response", listener: ((response: Response) => void)): this;
    off(event: "websocket", listener: ((webSocket: WebSocket) => void)): this;
    off(event: "worker", listener: ((worker: Worker) => void)): this;
    on(event: "close", listener: ((page: Page) => void)): this;
    on(event: "console", listener: ((consoleMessage: ConsoleMessage) => void)): this;
    on(event: "crash", listener: ((page: Page) => void)): this;
    on(event: "dialog", listener: ((dialog: Dialog) => void)): this;
    on(event: "domcontentloaded", listener: ((page: Page) => void)): this;
    on(event: "download", listener: ((download: Download) => void)): this;
    on(event: "filechooser", listener: ((fileChooser: FileChooser) => void)): this;
    on(event: "frameattached", listener: ((frame: Frame) => void)): this;
    on(event: "framedetached", listener: ((frame: Frame) => void)): this;
    on(event: "framenavigated", listener: ((frame: Frame) => void)): this;
    on(event: "load", listener: ((page: Page) => void)): this;
    on(event: "pageerror", listener: ((error: Error) => void)): this;
    on(event: "popup", listener: ((page: Page) => void)): this;
    on(event: "request", listener: ((request: Request) => void)): this;
    on(event: "requestfailed", listener: ((request: Request) => void)): this;
    on(event: "requestfinished", listener: ((request: Request) => void)): this;
    on(event: "response", listener: ((response: Response) => void)): this;
    on(event: "websocket", listener: ((webSocket: WebSocket) => void)): this;
    on(event: "worker", listener: ((worker: Worker) => void)): this;
    once(event: "close", listener: ((page: Page) => void)): this;
    once(event: "console", listener: ((consoleMessage: ConsoleMessage) => void)): this;
    once(event: "crash", listener: ((page: Page) => void)): this;
    once(event: "dialog", listener: ((dialog: Dialog) => void)): this;
    once(event: "domcontentloaded", listener: ((page: Page) => void)): this;
    once(event: "download", listener: ((download: Download) => void)): this;
    once(event: "filechooser", listener: ((fileChooser: FileChooser) => void)): this;
    once(event: "frameattached", listener: ((frame: Frame) => void)): this;
    once(event: "framedetached", listener: ((frame: Frame) => void)): this;
    once(event: "framenavigated", listener: ((frame: Frame) => void)): this;
    once(event: "load", listener: ((page: Page) => void)): this;
    once(event: "pageerror", listener: ((error: Error) => void)): this;
    once(event: "popup", listener: ((page: Page) => void)): this;
    once(event: "request", listener: ((request: Request) => void)): this;
    once(event: "requestfailed", listener: ((request: Request) => void)): this;
    once(event: "requestfinished", listener: ((request: Request) => void)): this;
    once(event: "response", listener: ((response: Response) => void)): this;
    once(event: "websocket", listener: ((webSocket: WebSocket) => void)): this;
    once(event: "worker", listener: ((worker: Worker) => void)): this;
    opener(): Promise<null | Page>;
    pause(): Promise<void>;
    pdf(options?: {
        displayHeaderFooter?: boolean;
        footerTemplate?: string;
        format?: string;
        headerTemplate?: string;
        height?: string | number;
        landscape?: boolean;
        margin?: {
            bottom?: string | number;
            left?: string | number;
            right?: string | number;
            top?: string | number;
        };
        pageRanges?: string;
        path?: string;
        preferCSSPageSize?: boolean;
        printBackground?: boolean;
        scale?: number;
        width?: string | number;
    }): Promise<Buffer>;
    prependListener(event: "close", listener: ((page: Page) => void)): this;
    prependListener(event: "console", listener: ((consoleMessage: ConsoleMessage) => void)): this;
    prependListener(event: "crash", listener: ((page: Page) => void)): this;
    prependListener(event: "dialog", listener: ((dialog: Dialog) => void)): this;
    prependListener(event: "domcontentloaded", listener: ((page: Page) => void)): this;
    prependListener(event: "download", listener: ((download: Download) => void)): this;
    prependListener(event: "filechooser", listener: ((fileChooser: FileChooser) => void)): this;
    prependListener(event: "frameattached", listener: ((frame: Frame) => void)): this;
    prependListener(event: "framedetached", listener: ((frame: Frame) => void)): this;
    prependListener(event: "framenavigated", listener: ((frame: Frame) => void)): this;
    prependListener(event: "load", listener: ((page: Page) => void)): this;
    prependListener(event: "pageerror", listener: ((error: Error) => void)): this;
    prependListener(event: "popup", listener: ((page: Page) => void)): this;
    prependListener(event: "request", listener: ((request: Request) => void)): this;
    prependListener(event: "requestfailed", listener: ((request: Request) => void)): this;
    prependListener(event: "requestfinished", listener: ((request: Request) => void)): this;
    prependListener(event: "response", listener: ((response: Response) => void)): this;
    prependListener(event: "websocket", listener: ((webSocket: WebSocket) => void)): this;
    prependListener(event: "worker", listener: ((worker: Worker) => void)): this;
    press(selector: string, key: string, options?: {
        delay?: number;
        noWaitAfter?: boolean;
        strict?: boolean;
        timeout?: number;
    }): Promise<void>;
    reload(options?: {
        timeout?: number;
        waitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit";
    }): Promise<null | Response>;
    removeListener(event: "close", listener: ((page: Page) => void)): this;
    removeListener(event: "console", listener: ((consoleMessage: ConsoleMessage) => void)): this;
    removeListener(event: "crash", listener: ((page: Page) => void)): this;
    removeListener(event: "dialog", listener: ((dialog: Dialog) => void)): this;
    removeListener(event: "domcontentloaded", listener: ((page: Page) => void)): this;
    removeListener(event: "download", listener: ((download: Download) => void)): this;
    removeListener(event: "filechooser", listener: ((fileChooser: FileChooser) => void)): this;
    removeListener(event: "frameattached", listener: ((frame: Frame) => void)): this;
    removeListener(event: "framedetached", listener: ((frame: Frame) => void)): this;
    removeListener(event: "framenavigated", listener: ((frame: Frame) => void)): this;
    removeListener(event: "load", listener: ((page: Page) => void)): this;
    removeListener(event: "pageerror", listener: ((error: Error) => void)): this;
    removeListener(event: "popup", listener: ((page: Page) => void)): this;
    removeListener(event: "request", listener: ((request: Request) => void)): this;
    removeListener(event: "requestfailed", listener: ((request: Request) => void)): this;
    removeListener(event: "requestfinished", listener: ((request: Request) => void)): this;
    removeListener(event: "response", listener: ((response: Response) => void)): this;
    removeListener(event: "websocket", listener: ((webSocket: WebSocket) => void)): this;
    removeListener(event: "worker", listener: ((worker: Worker) => void)): this;
    route(url: string | RegExp | ((url: URL) => boolean), handler: ((route: Route, request: Request) => any), options?: {
        times?: number;
    }): Promise<void>;
    routeFromHAR(har: string, options?: {
        notFound?: "abort" | "fallback";
        update?: boolean;
        updateContent?: "embed" | "attach";
        updateMode?: "full" | "minimal";
        url?: string | RegExp;
    }): Promise<void>;
    screenshot(options?: PageScreenshotOptions): Promise<Buffer>;
    selectOption(selector: string, values:
        | null
        | string
        | string[]
        | ElementHandle<Node>
        | {
            index?: number;
            label?: string;
            value?: string;
        }
        | ElementHandle<Node>[]
        | {
            index?: number;
            label?: string;
            value?: string;
        }[], options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        strict?: boolean;
        timeout?: number;
    }): Promise<string[]>;
    setChecked(selector: string, checked: boolean, options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        position?: {
            x: number;
            y: number;
        };
        strict?: boolean;
        timeout?: number;
        trial?: boolean;
    }): Promise<void>;
    setContent(html: string, options?: {
        timeout?: number;
        waitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit";
    }): Promise<void>;
    setDefaultNavigationTimeout(timeout: number): void;
    setDefaultTimeout(timeout: number): void;
    setExtraHTTPHeaders(headers: {
        [key: string]: string;
    }): Promise<void>;
    setInputFiles(selector: string, files:
        | string
        | string[]
        | {
            buffer: Buffer;
            mimeType: string;
            name: string;
        }
        | {
            buffer: Buffer;
            mimeType: string;
            name: string;
        }[], options?: {
        noWaitAfter?: boolean;
        strict?: boolean;
        timeout?: number;
    }): Promise<void>;
    setViewportSize(viewportSize: {
        height: number;
        width: number;
    }): Promise<void>;
    tap(selector: string, options?: {
        force?: boolean;
        modifiers?: (
            | "Alt"
            | "Control"
            | "Meta"
            | "Shift")[];
        noWaitAfter?: boolean;
        position?: {
            x: number;
            y: number;
        };
        strict?: boolean;
        timeout?: number;
        trial?: boolean;
    }): Promise<void>;
    textContent(selector: string, options?: {
        strict?: boolean;
        timeout?: number;
    }): Promise<null | string>;
    title(): Promise<string>;
    type(selector: string, text: string, options?: {
        delay?: number;
        noWaitAfter?: boolean;
        strict?: boolean;
        timeout?: number;
    }): Promise<void>;
    uncheck(selector: string, options?: {
        force?: boolean;
        noWaitAfter?: boolean;
        position?: {
            x: number;
            y: number;
        };
        strict?: boolean;
        timeout?: number;
        trial?: boolean;
    }): Promise<void>;
    unroute(url: string | RegExp | ((url: URL) => boolean), handler?: ((route: Route, request: Request) => any)): Promise<void>;
    url(): string;
    video(): null | Video;
    viewportSize(): null | {
        height: number;
        width: number;
    };
    waitForEvent(event: "close", optionsOrPredicate?: {
        predicate?: ((page: Page) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((page: Page) => boolean | Promise<boolean>)): Promise<Page>;
    waitForEvent(event: "console", optionsOrPredicate?: {
        predicate?: ((consoleMessage: ConsoleMessage) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((consoleMessage: ConsoleMessage) => boolean | Promise<boolean>)): Promise<ConsoleMessage>;
    waitForEvent(event: "crash", optionsOrPredicate?: {
        predicate?: ((page: Page) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((page: Page) => boolean | Promise<boolean>)): Promise<Page>;
    waitForEvent(event: "dialog", optionsOrPredicate?: {
        predicate?: ((dialog: Dialog) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((dialog: Dialog) => boolean | Promise<boolean>)): Promise<Dialog>;
    waitForEvent(event: "domcontentloaded", optionsOrPredicate?: {
        predicate?: ((page: Page) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((page: Page) => boolean | Promise<boolean>)): Promise<Page>;
    waitForEvent(event: "download", optionsOrPredicate?: {
        predicate?: ((download: Download) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((download: Download) => boolean | Promise<boolean>)): Promise<Download>;
    waitForEvent(event: "filechooser", optionsOrPredicate?: {
        predicate?: ((fileChooser: FileChooser) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((fileChooser: FileChooser) => boolean | Promise<boolean>)): Promise<FileChooser>;
    waitForEvent(event: "frameattached", optionsOrPredicate?: {
        predicate?: ((frame: Frame) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((frame: Frame) => boolean | Promise<boolean>)): Promise<Frame>;
    waitForEvent(event: "framedetached", optionsOrPredicate?: {
        predicate?: ((frame: Frame) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((frame: Frame) => boolean | Promise<boolean>)): Promise<Frame>;
    waitForEvent(event: "framenavigated", optionsOrPredicate?: {
        predicate?: ((frame: Frame) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((frame: Frame) => boolean | Promise<boolean>)): Promise<Frame>;
    waitForEvent(event: "load", optionsOrPredicate?: {
        predicate?: ((page: Page) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((page: Page) => boolean | Promise<boolean>)): Promise<Page>;
    waitForEvent(event: "pageerror", optionsOrPredicate?: {
        predicate?: ((error: Error) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((error: Error) => boolean | Promise<boolean>)): Promise<Error>;
    waitForEvent(event: "popup", optionsOrPredicate?: {
        predicate?: ((page: Page) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((page: Page) => boolean | Promise<boolean>)): Promise<Page>;
    waitForEvent(event: "request", optionsOrPredicate?: {
        predicate?: ((request: Request) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((request: Request) => boolean | Promise<boolean>)): Promise<Request>;
    waitForEvent(event: "requestfailed", optionsOrPredicate?: {
        predicate?: ((request: Request) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((request: Request) => boolean | Promise<boolean>)): Promise<Request>;
    waitForEvent(event: "requestfinished", optionsOrPredicate?: {
        predicate?: ((request: Request) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((request: Request) => boolean | Promise<boolean>)): Promise<Request>;
    waitForEvent(event: "response", optionsOrPredicate?: {
        predicate?: ((response: Response) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((response: Response) => boolean | Promise<boolean>)): Promise<Response>;
    waitForEvent(event: "websocket", optionsOrPredicate?: {
        predicate?: ((webSocket: WebSocket) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((webSocket: WebSocket) => boolean | Promise<boolean>)): Promise<WebSocket>;
    waitForEvent(event: "worker", optionsOrPredicate?: {
        predicate?: ((worker: Worker) => boolean | Promise<boolean>);
        timeout?: number;
    } | ((worker: Worker) => boolean | Promise<boolean>)): Promise<Worker>;
    waitForFunction<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg, options?: PageWaitForFunctionOptions): Promise<SmartHandle<R>>;
    waitForFunction<R>(pageFunction: PageFunction<void, R>, arg?: any, options?: PageWaitForFunctionOptions): Promise<SmartHandle<R>>;
    waitForLoadState(state?: "load" | "domcontentloaded" | "networkidle", options?: {
        timeout?: number;
    }): Promise<void>;
    waitForNavigation(options?: {
        timeout?: number;
        url?: string | RegExp | ((url: URL) => boolean);
        waitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit";
    }): Promise<null | Response>;
    waitForRequest(urlOrPredicate: string | RegExp | ((request: Request) => boolean | Promise<boolean>), options?: {
        timeout?: number;
    }): Promise<Request>;
    waitForResponse(urlOrPredicate: string | RegExp | ((response: Response) => boolean | Promise<boolean>), options?: {
        timeout?: number;
    }): Promise<Response>;
    waitForSelector<K>(selector: K, options?: PageWaitForSelectorOptionsNotHidden): Promise<ElementHandleForTag<K>>;
    waitForSelector(selector: string, options?: PageWaitForSelectorOptionsNotHidden): Promise<ElementHandle<HTMLElement | SVGElement>>;
    waitForSelector<K>(selector: K, options: PageWaitForSelectorOptions): Promise<null | ElementHandleForTag<K>>;
    waitForSelector(selector: string, options: PageWaitForSelectorOptions): Promise<null | ElementHandle<HTMLElement | SVGElement>>;
    waitForTimeout(timeout: number): Promise<void>;
    waitForURL(url: string | RegExp | ((url: URL) => boolean), options?: {
        timeout?: number;
        waitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit";
    }): Promise<void>;
    workers(): Worker[];
}

Properties

accessibility: Accessibility

This property is discouraged. Please use other libraries such as Axe if you need to test page accessibility. See our Node.js guide for integration with Axe.

coverage: Coverage

NOTE Only available for Chromium atm.

Browser-specific Coverage implementation. See [Coverage] for more details.

keyboard: Keyboard
mouse: Mouse
request: APIRequestContext

API testing helper associated with this page. This method returns the same instance as browserContext.request on the page's context. See browserContext.request for more details.

touchscreen: Touchscreen

Methods

  • NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.

    The method finds an element matching the specified selector within the page. If no elements match the selector, the return value resolves to null. To wait for an element on the page, use locator.waitFor([options]).

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

      A selector to query for.

    • Optionaloptions: {
          strict: boolean;
      }
      • strict: boolean

    Returns Promise<null | ElementHandleForTag<K>>

  • NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.

    The method finds an element matching the specified selector within the page. If no elements match the selector, the return value resolves to null. To wait for an element on the page, use locator.waitFor([options]).

    Parameters

    • selector: string

      A selector to query for.

    • Optionaloptions: {
          strict: boolean;
      }
      • strict: boolean

    Returns Promise<null | ElementHandle<HTMLElement | SVGElement>>

  • NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.

    The method finds all elements matching the specified selector within the page. If no elements match the selector, the return value resolves to [].

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

      A selector to query for.

    Returns Promise<ElementHandleForTag<K>[]>

  • NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.

    The method finds all elements matching the specified selector within the page. If no elements match the selector, the return value resolves to [].

    Parameters

    • selector: string

      A selector to query for.

    Returns Promise<ElementHandle<HTMLElement | SVGElement>[]>

  • NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other [Locator] helper methods and web-first assertions do a better job.

    The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to pageFunction. Returns the result of pageFunction invocation.

    If pageFunction returns a [Promise], then page.$$eval(selector, pageFunction[, arg]) would wait for the promise to resolve and return its value.

    Usage

    const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
    

    Type Parameters

    • K extends keyof HTMLElementTagNameMap
    • R
    • Arg

    Parameters

    • selector: K

      A selector to query for.

    • pageFunction: PageFunctionOn<HTMLElementTagNameMap[K][], Arg, R>

      Function to be evaluated in the page context.

    • arg: Arg

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other [Locator] helper methods and web-first assertions do a better job.

    The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to pageFunction. Returns the result of pageFunction invocation.

    If pageFunction returns a [Promise], then page.$$eval(selector, pageFunction[, arg]) would wait for the promise to resolve and return its value.

    Usage

    const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
    

    Type Parameters

    • R
    • Arg
    • E extends HTMLElement | SVGElement = HTMLElement | SVGElement

    Parameters

    • selector: string

      A selector to query for.

    • pageFunction: PageFunctionOn<E[], Arg, R>

      Function to be evaluated in the page context.

    • arg: Arg

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other [Locator] helper methods and web-first assertions do a better job.

    The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to pageFunction. Returns the result of pageFunction invocation.

    If pageFunction returns a [Promise], then page.$$eval(selector, pageFunction[, arg]) would wait for the promise to resolve and return its value.

    Usage

    const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
    

    Type Parameters

    • K extends keyof HTMLElementTagNameMap
    • R

    Parameters

    • selector: K

      A selector to query for.

    • pageFunction: PageFunctionOn<HTMLElementTagNameMap[K][], void, R>

      Function to be evaluated in the page context.

    • Optionalarg: any

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other [Locator] helper methods and web-first assertions do a better job.

    The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to pageFunction. Returns the result of pageFunction invocation.

    If pageFunction returns a [Promise], then page.$$eval(selector, pageFunction[, arg]) would wait for the promise to resolve and return its value.

    Usage

    const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
    

    Type Parameters

    • R
    • E extends HTMLElement | SVGElement = HTMLElement | SVGElement

    Parameters

    • selector: string

      A selector to query for.

    • pageFunction: PageFunctionOn<E[], void, R>

      Function to be evaluated in the page context.

    • Optionalarg: any

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), other [Locator] helper methods or web-first assertions instead.

    The method finds an element matching the specified selector within the page and passes it as a first argument to pageFunction. If no elements match the selector, the method throws an error. Returns the value of pageFunction.

    If pageFunction returns a [Promise], then page.$eval(selector, pageFunction[, arg, options]) would wait for the promise to resolve and return its value.

    Usage

    const searchValue = await page.$eval('#search', el => el.value);
    const preloadHref = await page.$eval('link[rel=preload]', el => el.href);
    const html = await page.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');
    // In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
    const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);

    Type Parameters

    • K extends keyof HTMLElementTagNameMap
    • R
    • Arg

    Parameters

    • selector: K

      A selector to query for.

    • pageFunction: PageFunctionOn<HTMLElementTagNameMap[K], Arg, R>

      Function to be evaluated in the page context.

    • arg: Arg

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), other [Locator] helper methods or web-first assertions instead.

    The method finds an element matching the specified selector within the page and passes it as a first argument to pageFunction. If no elements match the selector, the method throws an error. Returns the value of pageFunction.

    If pageFunction returns a [Promise], then page.$eval(selector, pageFunction[, arg, options]) would wait for the promise to resolve and return its value.

    Usage

    const searchValue = await page.$eval('#search', el => el.value);
    const preloadHref = await page.$eval('link[rel=preload]', el => el.href);
    const html = await page.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');
    // In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
    const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);

    Type Parameters

    • R
    • Arg
    • E extends HTMLElement | SVGElement = HTMLElement | SVGElement

    Parameters

    • selector: string

      A selector to query for.

    • pageFunction: PageFunctionOn<E, Arg, R>

      Function to be evaluated in the page context.

    • arg: Arg

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), other [Locator] helper methods or web-first assertions instead.

    The method finds an element matching the specified selector within the page and passes it as a first argument to pageFunction. If no elements match the selector, the method throws an error. Returns the value of pageFunction.

    If pageFunction returns a [Promise], then page.$eval(selector, pageFunction[, arg, options]) would wait for the promise to resolve and return its value.

    Usage

    const searchValue = await page.$eval('#search', el => el.value);
    const preloadHref = await page.$eval('link[rel=preload]', el => el.href);
    const html = await page.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');
    // In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
    const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);

    Type Parameters

    • K extends keyof HTMLElementTagNameMap
    • R

    Parameters

    • selector: K

      A selector to query for.

    • pageFunction: PageFunctionOn<HTMLElementTagNameMap[K], void, R>

      Function to be evaluated in the page context.

    • Optionalarg: any

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), other [Locator] helper methods or web-first assertions instead.

    The method finds an element matching the specified selector within the page and passes it as a first argument to pageFunction. If no elements match the selector, the method throws an error. Returns the value of pageFunction.

    If pageFunction returns a [Promise], then page.$eval(selector, pageFunction[, arg, options]) would wait for the promise to resolve and return its value.

    Usage

    const searchValue = await page.$eval('#search', el => el.value);
    const preloadHref = await page.$eval('link[rel=preload]', el => el.href);
    const html = await page.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');
    // In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
    const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);

    Type Parameters

    • R
    • E extends HTMLElement | SVGElement = HTMLElement | SVGElement

    Parameters

    • selector: string

      A selector to query for.

    • pageFunction: PageFunctionOn<E, void, R>

      Function to be evaluated in the page context.

    • Optionalarg: any

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • Adds a script which would be evaluated in one of the following scenarios:

    • Whenever the page is navigated.
    • Whenever the child frame is attached or navigated. In this case, the script is evaluated in the context of the newly attached frame.

    The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.

    Usage

    An example of overriding Math.random before the page loads:

    // preload.js
    Math.random = () => 42;
    // In your playwright script, assuming the preload.js file is in same directory
    await page.addInitScript({ path: './preload.js' });

    NOTE The order of evaluation of multiple scripts installed via browserContext.addInitScript(script[, arg]) and page.addInitScript(script[, arg]) is not defined.

    Type Parameters

    • Arg

    Parameters

    • script: PageFunction<Arg, any> | {
          content?: string;
          path?: string;
      }

      Script to be evaluated in the page.

    • Optionalarg: Arg

      Optional argument to pass to script (only supported when passing a function).

    Returns Promise<void>

  • Emitted when the page closes.

    Parameters

    • event: "close"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir. Also emitted if the page throws an error or a warning.

    The arguments passed into console.log appear as arguments on the event handler.

    An example of handling console event:

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

    Parameters

    • event: "console"
    • listener: ((consoleMessage: ConsoleMessage) => void)
        • (consoleMessage): void
        • Parameters

          • consoleMessage: ConsoleMessage

          Returns void

    Returns this

  • Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory. When the page crashes, ongoing and subsequent operations will throw.

    The most common way to deal with crashes is to catch an exception:

    try {
    // Crash might happen during a click.
    await page.click('button');
    // Or while waiting for an event.
    await page.waitForEvent('popup');
    } catch (e) {
    // When the page crashes, exception message contains 'crash'.
    }

    Parameters

    • event: "crash"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must either dialog.accept([promptText]) or dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.

    page.on('dialog', dialog => {
    dialog.accept();
    });

    NOTE When no page.on('dialog') listeners are present, all dialogs are automatically dismissed.

    Parameters

    • event: "dialog"
    • listener: ((dialog: Dialog) => void)
        • (dialog): void
        • Parameters

          • dialog: Dialog

          Returns void

    Returns this

  • Emitted when the JavaScript DOMContentLoaded event is dispatched.

    Parameters

    • event: "domcontentloaded"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.

    Parameters

    • event: "download"
    • listener: ((download: Download) => void)
        • (download): void
        • Parameters

          • download: Download

          Returns void

    Returns this

  • Emitted when a file chooser is supposed to appear, such as after clicking the <input type=file>. Playwright can respond to it via setting the input files using fileChooser.setFiles(files[, options]) that can be uploaded after that.

    page.on('filechooser', async (fileChooser) => {
    await fileChooser.setFiles('/tmp/myfile.pdf');
    });

    Parameters

    • event: "filechooser"
    • listener: ((fileChooser: FileChooser) => void)
        • (fileChooser): void
        • Parameters

          • fileChooser: FileChooser

          Returns void

    Returns this

  • Emitted when a frame is attached.

    Parameters

    • event: "frameattached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when a frame is detached.

    Parameters

    • event: "framedetached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when a frame is navigated to a new url.

    Parameters

    • event: "framenavigated"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when the JavaScript load event is dispatched.

    Parameters

    • event: "load"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when an uncaught exception happens within the page.

    // Log all uncaught errors to the terminal
    page.on('pageerror', exception => {
    console.log(`Uncaught exception: "${exception}"`);
    });

    // Navigate to a page with an exception.
    await page.goto('data:text/html,<script>throw new Error("Test")</script>');

    Parameters

    • event: "pageerror"
    • listener: ((error: Error) => void)
        • (error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Emitted when the page opens a new tab or window. This event is emitted in addition to the browserContext.on('page'), but only for popups relevant to this page.

    The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with window.open('http://example.com'), this event will fire when the network request to "http://example.com" is done and its response has started loading in the popup.

    // Start waiting for popup before clicking. Note no await.
    const popupPromise = page.waitForEvent('popup');
    await page.getByText('open the popup').click();
    const popup = await popupPromise;
    console.log(await popup.evaluate('location.href'));

    NOTE Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).

    Parameters

    • event: "popup"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see page.route(url, handler[, options]) or browserContext.route(url, handler[, options]).

    Parameters

    • event: "request"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when a request fails, for example by timing out.

    page.on('requestfailed', request => {
    console.log(request.url() + ' ' + request.failure().errorText);
    });

    NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with page.on('requestfinished') event and not with page.on('requestfailed'). A request will only be considered failed when the client cannot get an HTTP response from the server, e.g. due to network error net::ERR_FAILED.

    Parameters

    • event: "requestfailed"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request, response and requestfinished.

    Parameters

    • event: "requestfinished"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events is request, response and requestfinished.

    Parameters

    • event: "response"
    • listener: ((response: Response) => void)
        • (response): void
        • Parameters

          Returns void

    Returns this

  • Emitted when [WebSocket] request is sent.

    Parameters

    • event: "websocket"
    • listener: ((webSocket: WebSocket) => void)
        • (webSocket): void
        • Parameters

          • webSocket: WebSocket

          Returns void

    Returns this

  • Emitted when a dedicated WebWorker is spawned by the page.

    Parameters

    • event: "worker"
    • listener: ((worker: Worker) => void)
        • (worker): void
        • Parameters

          • worker: Worker

          Returns void

    Returns this

  • Adds a <script> tag into the page with the desired url or content. Returns the added tag when the script's onload fires or when the script content was injected into frame.

    Parameters

    • Optionaloptions: {
          content?: string;
          path?: string;
          type?: string;
          url?: string;
      }
      • Optionalcontent?: string

        Raw JavaScript content to be injected into frame.

      • Optionalpath?: string

        Path to the JavaScript file to be injected into frame. If path is a relative path, then it is resolved relative to the current working directory.

      • Optionaltype?: string

        Script type. Use 'module' in order to load a Javascript ES6 module. See script for more details.

      • Optionalurl?: string

        URL of a script to be added.

    Returns Promise<ElementHandle<Node>>

  • Adds a <link rel="stylesheet"> tag into the page with the desired url or a <style type="text/css"> tag with the content. Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.

    Parameters

    • Optionaloptions: {
          content?: string;
          path?: string;
          url?: string;
      }
      • Optionalcontent?: string

        Raw CSS content to be injected into frame.

      • Optionalpath?: string

        Path to the CSS file to be injected into frame. If path is a relative path, then it is resolved relative to the current working directory.

      • Optionalurl?: string

        URL of the <link> tag.

    Returns Promise<ElementHandle<Node>>

  • Brings page to front (activates tab).

    Returns Promise<void>

  • NOTE Use locator-based locator.check([options]) instead. Read more about locators.

    This method checks an element matching selector by performing the following steps:

    1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
    2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
    3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
    4. Scroll the element into view if needed.
    5. Use page.mouse to click in the center of the element.
    6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
    7. Ensure that the element is now checked. If not, this method throws.

    When all steps combined have not finished during the specified timeout, this method throws a [TimeoutError]. Passing zero timeout disables this.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          force?: boolean;
          noWaitAfter?: boolean;
          position?: {
              x: number;
              y: number;
          };
          strict?: boolean;
          timeout?: number;
          trial?: boolean;
      }
      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalposition?: {
            x: number;
            y: number;
        }

        A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

        • x: number
        • y: number
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionaltrial?: boolean

        When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

    Returns Promise<void>

  • NOTE Use locator-based locator.click([options]) instead. Read more about locators.

    This method clicks an element matching selector by performing the following steps:

    1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
    2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
    3. Scroll the element into view if needed.
    4. Use page.mouse to click in the center of the element, or the specified position.
    5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

    When all steps combined have not finished during the specified timeout, this method throws a [TimeoutError]. Passing zero timeout disables this.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          button?: "left" | "right" | "middle";
          clickCount?: number;
          delay?: number;
          force?: boolean;
          modifiers?: (
              | "Alt"
              | "Control"
              | "Meta"
              | "Shift")[];
          noWaitAfter?: boolean;
          position?: {
              x: number;
              y: number;
          };
          strict?: boolean;
          timeout?: number;
          trial?: boolean;
      }
      • Optionalbutton?: "left" | "right" | "middle"

        Defaults to left.

      • OptionalclickCount?: number

        defaults to 1. See [UIEvent.detail].

      • Optionaldelay?: number

        Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • Optionalmodifiers?: (
            | "Alt"
            | "Control"
            | "Meta"
            | "Shift")[]

        Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalposition?: {
            x: number;
            y: number;
        }

        A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

        • x: number
        • y: number
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionaltrial?: boolean

        When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

    Returns Promise<void>

  • If runBeforeUnload is false, does not run any unload handlers and waits for the page to be closed. If runBeforeUnload is true the method will run unload handlers, but will not wait for the page to close.

    By default, page.close() does not run beforeunload handlers.

    NOTE if runBeforeUnload is passed as true, a beforeunload dialog might be summoned and should be handled manually via page.on('dialog') event.

    Parameters

    • Optionaloptions: {
          runBeforeUnload?: boolean;
      }
      • OptionalrunBeforeUnload?: boolean

        Defaults to false. Whether to run the before unload page handlers.

    Returns Promise<void>

  • Gets the full HTML contents of the page, including the doctype.

    Returns Promise<string>

  • Get the browser context that the page belongs to.

    Returns BrowserContext

  • NOTE Use locator-based locator.dblclick([options]) instead. Read more about locators.

    This method double clicks an element matching selector by performing the following steps:

    1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
    2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
    3. Scroll the element into view if needed.
    4. Use page.mouse to double click in the center of the element, or the specified position.
    5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Note that if the first click of the dblclick() triggers a navigation event, this method will throw.

    When all steps combined have not finished during the specified timeout, this method throws a [TimeoutError]. Passing zero timeout disables this.

    NOTE page.dblclick() dispatches two click events and a single dblclick event.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          button?: "left" | "right" | "middle";
          delay?: number;
          force?: boolean;
          modifiers?: (
              | "Alt"
              | "Control"
              | "Meta"
              | "Shift")[];
          noWaitAfter?: boolean;
          position?: {
              x: number;
              y: number;
          };
          strict?: boolean;
          timeout?: number;
          trial?: boolean;
      }
      • Optionalbutton?: "left" | "right" | "middle"

        Defaults to left.

      • Optionaldelay?: number

        Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • Optionalmodifiers?: (
            | "Alt"
            | "Control"
            | "Meta"
            | "Shift")[]

        Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalposition?: {
            x: number;
            y: number;
        }

        A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

        • x: number
        • y: number
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionaltrial?: boolean

        When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

    Returns Promise<void>

  • NOTE Use locator-based locator.dispatchEvent(type[, eventInit, options]) instead. Read more about locators.

    The snippet below dispatches the click event on the element. Regardless of the visibility state of the element, click is dispatched. This is equivalent to calling element.click().

    Usage

    await page.dispatchEvent('button#submit', 'click');
    

    Under the hood, it creates an instance of an event based on the given type, initializes it with eventInit properties and dispatches it on the element. Events are composed, cancelable and bubble by default.

    Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:

    You can also specify JSHandle as the property value if you want live objects to be passed into the event:

    // Note you can only create DataTransfer in Chromium and Firefox
    const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
    await page.dispatchEvent('#source', 'dragstart', { dataTransfer });

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • type: string

      DOM event type: "click", "dragstart", etc.

    • OptionaleventInit: EvaluationArgument

      Optional event-specific initialization properties.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<void>

  • This method drags the source element to the target element. It will first move to the source element, perform a mousedown, then move to the target element and perform a mouseup.

    Usage

    await page.dragAndDrop('#source', '#target');
    // or specify exact positions relative to the top-left corners of the elements:
    await page.dragAndDrop('#source', '#target', {
    sourcePosition: { x: 34, y: 7 },
    targetPosition: { x: 10, y: 20 },
    });

    Parameters

    • source: string

      A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will be used.

    • target: string

      A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          force?: boolean;
          noWaitAfter?: boolean;
          sourcePosition?: {
              x: number;
              y: number;
          };
          strict?: boolean;
          targetPosition?: {
              x: number;
              y: number;
          };
          timeout?: number;
          trial?: boolean;
      }
      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • OptionalsourcePosition?: {
            x: number;
            y: number;
        }

        Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.

        • x: number
        • y: number
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • OptionaltargetPosition?: {
            x: number;
            y: number;
        }

        Drops on the target element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.

        • x: number
        • y: number
      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionaltrial?: boolean

        When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

    Returns Promise<void>

  • This method changes the CSS media type through the media argument, and/or the 'prefers-colors-scheme' media feature, using the colorScheme argument.

    Usage

    await page.evaluate(() => matchMedia('screen').matches);
    // → true
    await page.evaluate(() => matchMedia('print').matches);
    // → false

    await page.emulateMedia({ media: 'print' });
    await page.evaluate(() => matchMedia('screen').matches);
    // → false
    await page.evaluate(() => matchMedia('print').matches);
    // → true

    await page.emulateMedia({});
    await page.evaluate(() => matchMedia('screen').matches);
    // → true
    await page.evaluate(() => matchMedia('print').matches);
    // → false
    await page.emulateMedia({ colorScheme: 'dark' });
    await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
    // → true
    await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
    // → false
    await page.evaluate(() => matchMedia('(prefers-color-scheme: no-preference)').matches);
    // → false

    Parameters

    • Optionaloptions: {
          colorScheme?:
              | null
              | "light"
              | "dark"
              | "no-preference";
          forcedColors?: null | "none" | "active";
          media?: null | "screen" | "print";
          reducedMotion?: null | "reduce" | "no-preference";
      }
      • OptionalcolorScheme?:
            | null
            | "light"
            | "dark"
            | "no-preference"

        Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. Passing null disables color scheme emulation.

      • OptionalforcedColors?: null | "none" | "active"

        Emulates 'forced-colors' media feature, supported values are 'active' and 'none'. Passing null disables forced colors emulation.

      • Optionalmedia?: null | "screen" | "print"

        Changes the CSS media type of the page. The only allowed values are 'screen', 'print' and null. Passing null disables CSS media emulation.

      • OptionalreducedMotion?: null | "reduce" | "no-preference"

        Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. Passing null disables reduced motion emulation.

    Returns Promise<void>

  • Returns the value of the pageFunction invocation.

    If the function passed to the page.evaluate(pageFunction[, arg]) returns a [Promise], then page.evaluate(pageFunction[, arg]) would wait for the promise to resolve and return its value.

    If the function passed to the page.evaluate(pageFunction[, arg]) returns a non-[Serializable] value, then page.evaluate(pageFunction[, arg]) resolves to undefined. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.

    Usage

    Passing argument to pageFunction:

    const result = await page.evaluate(([x, y]) => {
    return Promise.resolve(x * y);
    }, [7, 8]);
    console.log(result); // prints "56"

    A string can also be passed in instead of a function:

    console.log(await page.evaluate('1 + 2')); // prints "3"
    const x = 10;
    console.log(await page.evaluate(`1 + ${x}`)); // prints "11"

    [ElementHandle] instances can be passed as an argument to the page.evaluate(pageFunction[, arg]):

    const bodyHandle = await page.evaluate('document.body');
    const html = await page.evaluate(([body, suffix]) => body.innerHTML + suffix, [bodyHandle, 'hello']);
    await bodyHandle.dispose();

    Type Parameters

    • R
    • Arg

    Parameters

    • pageFunction: PageFunction<Arg, R>

      Function to be evaluated in the page context.

    • arg: Arg

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • Returns the value of the pageFunction invocation.

    If the function passed to the page.evaluate(pageFunction[, arg]) returns a [Promise], then page.evaluate(pageFunction[, arg]) would wait for the promise to resolve and return its value.

    If the function passed to the page.evaluate(pageFunction[, arg]) returns a non-[Serializable] value, then page.evaluate(pageFunction[, arg]) resolves to undefined. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.

    Usage

    Passing argument to pageFunction:

    const result = await page.evaluate(([x, y]) => {
    return Promise.resolve(x * y);
    }, [7, 8]);
    console.log(result); // prints "56"

    A string can also be passed in instead of a function:

    console.log(await page.evaluate('1 + 2')); // prints "3"
    const x = 10;
    console.log(await page.evaluate(`1 + ${x}`)); // prints "11"

    [ElementHandle] instances can be passed as an argument to the page.evaluate(pageFunction[, arg]):

    const bodyHandle = await page.evaluate('document.body');
    const html = await page.evaluate(([body, suffix]) => body.innerHTML + suffix, [bodyHandle, 'hello']);
    await bodyHandle.dispose();

    Type Parameters

    • R

    Parameters

    • pageFunction: PageFunction<void, R>

      Function to be evaluated in the page context.

    • Optionalarg: any

      Optional argument to pass to pageFunction.

    Returns Promise<R>

  • Returns the value of the pageFunction invocation as a [JSHandle].

    The only difference between page.evaluate(pageFunction[, arg]) and page.evaluateHandle(pageFunction[, arg]) is that page.evaluateHandle(pageFunction[, arg]) returns [JSHandle].

    If the function passed to the page.evaluateHandle(pageFunction[, arg]) returns a [Promise], then page.evaluateHandle(pageFunction[, arg]) would wait for the promise to resolve and return its value.

    Usage

    const aWindowHandle = await page.evaluateHandle(() => Promise.resolve(window));
    aWindowHandle; // Handle for the window object.

    A string can also be passed in instead of a function:

    const aHandle = await page.evaluateHandle('document'); // Handle for the 'document'
    

    [JSHandle] instances can be passed as an argument to the page.evaluateHandle(pageFunction[, arg]):

    const aHandle = await page.evaluateHandle(() => document.body);
    const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
    console.log(await resultHandle.jsonValue());
    await resultHandle.dispose();

    Type Parameters

    • R
    • Arg

    Parameters

    • pageFunction: PageFunction<Arg, R>

      Function to be evaluated in the page context.

    • arg: Arg

      Optional argument to pass to pageFunction.

    Returns Promise<SmartHandle<R>>

  • Returns the value of the pageFunction invocation as a [JSHandle].

    The only difference between page.evaluate(pageFunction[, arg]) and page.evaluateHandle(pageFunction[, arg]) is that page.evaluateHandle(pageFunction[, arg]) returns [JSHandle].

    If the function passed to the page.evaluateHandle(pageFunction[, arg]) returns a [Promise], then page.evaluateHandle(pageFunction[, arg]) would wait for the promise to resolve and return its value.

    Usage

    const aWindowHandle = await page.evaluateHandle(() => Promise.resolve(window));
    aWindowHandle; // Handle for the window object.

    A string can also be passed in instead of a function:

    const aHandle = await page.evaluateHandle('document'); // Handle for the 'document'
    

    [JSHandle] instances can be passed as an argument to the page.evaluateHandle(pageFunction[, arg]):

    const aHandle = await page.evaluateHandle(() => document.body);
    const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
    console.log(await resultHandle.jsonValue());
    await resultHandle.dispose();

    Type Parameters

    • R

    Parameters

    • pageFunction: PageFunction<void, R>

      Function to be evaluated in the page context.

    • Optionalarg: any

      Optional argument to pass to pageFunction.

    Returns Promise<SmartHandle<R>>

  • The method adds a function called name on the window object of every frame in this page. When called, the function executes callback and returns a [Promise] which resolves to the return value of callback. If the callback returns a [Promise], it will be awaited.

    The first argument of the callback function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }.

    See browserContext.exposeBinding(name, callback[, options]) for the context-wide version.

    NOTE Functions installed via page.exposeBinding(name, callback[, options]) survive navigations.

    Usage

    An example of exposing page URL to all frames in a page:

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

    (async () => {
    const browser = await webkit.launch({ headless: false });
    const context = await browser.newContext();
    const page = await context.newPage();
    await page.exposeBinding('pageURL', ({ page }) => page.url());
    await page.setContent(`
    <script>
    async function onClick() {
    document.querySelector('div').textContent = await window.pageURL();
    }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
    `);
    await page.click('button');
    })();

    An example of passing an element handle:

    await page.exposeBinding('clicked', async (source, element) => {
    console.log(await element.textContent());
    }, { handle: true });
    await page.setContent(`
    <script>
    document.addEventListener('click', event => window.clicked(event.target));
    </script>
    <div>Click me</div>
    <div>Or click me</div>
    `);

    Parameters

    • name: string

      Name of the function on the window object.

    • playwrightBinding: ((source: BindingSource, arg: JSHandle<any>) => any)
        • (source, arg): any
        • Parameters

          • source: BindingSource
          • arg: JSHandle<any>

          Returns any

    • options: {
          handle: true;
      }
      • handle: true

    Returns Promise<void>

  • The method adds a function called name on the window object of every frame in this page. When called, the function executes callback and returns a [Promise] which resolves to the return value of callback. If the callback returns a [Promise], it will be awaited.

    The first argument of the callback function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }.

    See browserContext.exposeBinding(name, callback[, options]) for the context-wide version.

    NOTE Functions installed via page.exposeBinding(name, callback[, options]) survive navigations.

    Usage

    An example of exposing page URL to all frames in a page:

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

    (async () => {
    const browser = await webkit.launch({ headless: false });
    const context = await browser.newContext();
    const page = await context.newPage();
    await page.exposeBinding('pageURL', ({ page }) => page.url());
    await page.setContent(`
    <script>
    async function onClick() {
    document.querySelector('div').textContent = await window.pageURL();
    }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
    `);
    await page.click('button');
    })();

    An example of passing an element handle:

    await page.exposeBinding('clicked', async (source, element) => {
    console.log(await element.textContent());
    }, { handle: true });
    await page.setContent(`
    <script>
    document.addEventListener('click', event => window.clicked(event.target));
    </script>
    <div>Click me</div>
    <div>Or click me</div>
    `);

    Parameters

    • name: string

      Name of the function on the window object.

    • playwrightBinding: ((source: BindingSource, ...args: any[]) => any)
        • (source, ...args): any
        • Parameters

          • source: BindingSource
          • Rest...args: any[]

          Returns any

    • Optionaloptions: {
          handle?: boolean;
      }
      • Optionalhandle?: boolean

    Returns Promise<void>

  • The method adds a function called name on the window object of every frame in the page. When called, the function executes callback and returns a [Promise] which resolves to the return value of callback.

    If the callback returns a [Promise], it will be awaited.

    See browserContext.exposeFunction(name, callback) for context-wide exposed function.

    NOTE Functions installed via page.exposeFunction(name, callback) survive navigations.

    Usage

    An example of adding a sha256 function to the page:

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

    (async () => {
    const browser = await webkit.launch({ headless: false });
    const page = await browser.newPage();
    await page.exposeFunction('sha256', text => crypto.createHash('sha256').update(text).digest('hex'));
    await page.setContent(`
    <script>
    async function onClick() {
    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
    }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
    `);
    await page.click('button');
    })();

    Parameters

    • name: string

      Name of the function on the window object

    • callback: Function

      Callback function which will be called in Playwright's context.

    Returns Promise<void>

  • NOTE Use locator-based locator.fill(value[, options]) instead. Read more about locators.

    This method waits for an element matching selector, waits for actionability checks, focuses the element, fills it and triggers an input event after filling. Note that you can pass an empty string to clear the input field.

    If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be filled instead.

    To send fine-grained keyboard events, use page.type(selector, text[, options]).

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • value: string

      Value to fill for the <input>, <textarea> or [contenteditable] element.

    • Optionaloptions: {
          force?: boolean;
          noWaitAfter?: boolean;
          strict?: boolean;
          timeout?: number;
      }
      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<void>

  • NOTE Use locator-based locator.focus([options]) instead. Read more about locators.

    This method fetches an element with selector and focuses it. If there's no element matching selector, the method waits until a matching element appears in the DOM.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<void>

  • Returns frame matching the specified criteria. Either name or url must be specified.

    Usage

    const frame = page.frame('frame-name');
    
    const frame = page.frame({ url: /.*domain.*/ });
    

    Parameters

    • frameSelector: string | {
          name?: string;
          url?: string | RegExp | ((url: URL) => boolean);
      }

      Frame name or other frame lookup options.

    Returns null | Frame

  • When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in that iframe.

    Usage

    Following snippet locates element with text "Submit" in the iframe with id my-frame, like <iframe id="my-frame">:

    const locator = page.frameLocator('#my-iframe').getByText('Submit');
    await locator.click();

    Parameters

    • selector: string

      A selector to use when resolving DOM element.

    Returns FrameLocator

  • An array of all frames attached to the page.

    Returns Frame[]

  • NOTE Use locator-based locator.getAttribute(name[, options]) instead. Read more about locators.

    Returns element attribute value.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • name: string

      Attribute name to get the value for.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<null | string>

  • Allows locating elements by their alt text.

    Usage

    For example, this method will find the image by alt text "Playwright logo":

    <img alt='Playwright logo'>
    
    await page.getByAltText('Playwright logo').click();
    

    Parameters

    • text: string | RegExp

      Text to locate the element for.

    • Optionaloptions: {
          exact?: boolean;
      }
      • Optionalexact?: boolean

        Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

    Returns Locator

  • Allows locating input elements by the text of the associated <label> or aria-labelledby element, or by the aria-label attribute.

    Usage

    For example, this method will find inputs by label "Username" and "Password" in the following DOM:

    <input aria-label="Username">
    <label for="password-input">Password:</label>
    <input id="password-input">
    await page.getByLabel('Username').fill('john');
    await page.getByLabel('Password').fill('secret');

    Parameters

    • text: string | RegExp

      Text to locate the element for.

    • Optionaloptions: {
          exact?: boolean;
      }
      • Optionalexact?: boolean

        Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

    Returns Locator

  • Allows locating input elements by the placeholder text.

    Usage

    For example, consider the following DOM structure.

    <input type="email" placeholder="name@example.com" />
    

    You can fill the input after locating it by the placeholder text:

    await page
    .getByPlaceholder("name@example.com")
    .fill("playwright@microsoft.com");

    Parameters

    • text: string | RegExp

      Text to locate the element for.

    • Optionaloptions: {
          exact?: boolean;
      }
      • Optionalexact?: boolean

        Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

    Returns Locator

  • Allows locating elements by their ARIA role, ARIA attributes and accessible name.

    Usage

    Consider the following DOM structure.

    <h3>Sign up</h3>
    <label>
    <input type="checkbox" /> Subscribe
    </label>
    <br/>
    <button>Submit</button>

    You can locate each element by it's implicit role:

    await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();

    await page.getByRole('checkbox', { name: 'Subscribe' }).check();

    await page.getByRole('button', { name: /submit/i }).click();

    Details

    Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.

    Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

    Parameters

    • role:
          | "code"
          | "status"
          | "time"
          | "paragraph"
          | "table"
          | "checkbox"
          | "search"
          | "link"
          | "generic"
          | "document"
          | "region"
          | "log"
          | "none"
          | "article"
          | "blockquote"
          | "button"
          | "caption"
          | "dialog"
          | "figure"
          | "form"
          | "img"
          | "main"
          | "menu"
          | "meter"
          | "option"
          | "strong"
          | "alert"
          | "alertdialog"
          | "application"
          | "banner"
          | "cell"
          | "columnheader"
          | "combobox"
          | "complementary"
          | "contentinfo"
          | "definition"
          | "deletion"
          | "directory"
          | "emphasis"
          | "feed"
          | "grid"
          | "gridcell"
          | "group"
          | "heading"
          | "insertion"
          | "list"
          | "listbox"
          | "listitem"
          | "marquee"
          | "math"
          | "menubar"
          | "menuitem"
          | "menuitemcheckbox"
          | "menuitemradio"
          | "navigation"
          | "note"
          | "presentation"
          | "progressbar"
          | "radio"
          | "radiogroup"
          | "row"
          | "rowgroup"
          | "rowheader"
          | "scrollbar"
          | "searchbox"
          | "separator"
          | "slider"
          | "spinbutton"
          | "subscript"
          | "superscript"
          | "switch"
          | "tab"
          | "tablist"
          | "tabpanel"
          | "term"
          | "textbox"
          | "timer"
          | "toolbar"
          | "tooltip"
          | "tree"
          | "treegrid"
          | "treeitem"

      Required aria role.

    • Optionaloptions: {
          checked?: boolean;
          disabled?: boolean;
          exact?: boolean;
          expanded?: boolean;
          includeHidden?: boolean;
          level?: number;
          name?: string | RegExp;
          pressed?: boolean;
          selected?: boolean;
      }
      • Optionalchecked?: boolean

        An attribute that is usually set by aria-checked or native <input type=checkbox> controls.

        Learn more about aria-checked.

      • Optionaldisabled?: boolean

        An attribute that is usually set by aria-disabled or disabled.

        NOTE Unlike most other attributes, disabled is inherited through the DOM hierarchy. Learn more about aria-disabled.

      • Optionalexact?: boolean

        Whether name is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when name is a regular expression. Note that exact match still trims whitespace.

      • Optionalexpanded?: boolean

        An attribute that is usually set by aria-expanded.

        Learn more about aria-expanded.

      • OptionalincludeHidden?: boolean

        Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.

        Learn more about aria-hidden.

      • Optionallevel?: number

        A number attribute that is usually present for roles heading, listitem, row, treeitem, with default values for <h1>-<h6> elements.

        Learn more about aria-level.

      • Optionalname?: string | RegExp

        Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.

        Learn more about accessible name.

      • Optionalpressed?: boolean

        An attribute that is usually set by aria-pressed.

        Learn more about aria-pressed.

      • Optionalselected?: boolean

        An attribute that is usually set by aria-selected.

        Learn more about aria-selected.

    Returns Locator

  • Locate element by the test id.

    Usage

    Consider the following DOM structure.

    <button data-testid="directions">Itinéraire</button>
    

    You can locate the element by it's test id:

    await page.getByTestId('directions').click();
    

    Details

    By default, the data-testid attribute is used as a test id. Use selectors.setTestIdAttribute(attributeName) to configure a different test id attribute if necessary.

    // Set custom test id attribute from @playwright/test config:
    use: {
    testIdAttribute: 'data-pw'
    }

    Parameters

    • testId: string | RegExp

      Id to locate the element by.

    Returns Locator

  • Allows locating elements that contain given text.

    See also locator.filter([options]) that allows to match by another criteria, like an accessible role, and then filter by the text content.

    Usage

    Consider the following DOM structure:

    <div>Hello <span>world</span></div>
    <div>Hello</div>

    You can locate by text substring, exact string, or a regular expression:

    // Matches <span>
    page.getByText('world')

    // Matches first <div>
    page.getByText('Hello world')

    // Matches second <div>
    page.getByText('Hello', { exact: true })

    // Matches both <div>s
    page.getByText(/Hello/)

    // Matches second <div>
    page.getByText(/^hello$/i)

    Details

    Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.

    Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text "Log in" matches <input type=button value="Log in">.

    Parameters

    • text: string | RegExp

      Text to locate the element for.

    • Optionaloptions: {
          exact?: boolean;
      }
      • Optionalexact?: boolean

        Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

    Returns Locator

  • Allows locating elements by their title attribute.

    Usage

    Consider the following DOM structure.

    <span title='Issues count'>25 issues</span>
    

    You can check the issues count after locating it by the title text:

    await expect(page.getByTitle('Issues count')).toHaveText('25 issues');
    

    Parameters

    • text: string | RegExp

      Text to locate the element for.

    • Optionaloptions: {
          exact?: boolean;
      }
      • Optionalexact?: boolean

        Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

    Returns Locator

  • Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If can not go back, returns null.

    Navigate to the previous page in history.

    Parameters

    • Optionaloptions: {
          timeout?: number;
          waitUntil?:
              | "load"
              | "domcontentloaded"
              | "networkidle"
              | "commit";
      }
      • Optionaltimeout?: number

        Maximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via navigationTimeout option in the config, or by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • OptionalwaitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit"

        When to consider operation succeeded, defaults to load. Events can be either:

        • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
        • 'load' - consider operation to be finished when the load event is fired.
        • 'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.
        • 'commit' - consider operation to be finished when network response is received and the document started loading.

    Returns Promise<null | Response>

  • Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If can not go forward, returns null.

    Navigate to the next page in history.

    Parameters

    • Optionaloptions: {
          timeout?: number;
          waitUntil?:
              | "load"
              | "domcontentloaded"
              | "networkidle"
              | "commit";
      }
      • Optionaltimeout?: number

        Maximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via navigationTimeout option in the config, or by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • OptionalwaitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit"

        When to consider operation succeeded, defaults to load. Events can be either:

        • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
        • 'load' - consider operation to be finished when the load event is fired.
        • 'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.
        • 'commit' - consider operation to be finished when network response is received and the document started loading.

    Returns Promise<null | Response>

  • Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first non-redirect response.

    The method will throw an error if:

    • there's an SSL error (e.g. in case of self-signed certificates).
    • target URL is invalid.
    • the timeout is exceeded during navigation.
    • the remote server does not respond or is unreachable.
    • the main resource failed to load.

    The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling response.status().

    NOTE The method either throws an error or returns a main resource response. The only exceptions are navigation to about:blank or navigation to the same URL with a different hash, which would succeed and return null.

    NOTE Headless mode doesn't support navigation to a PDF document. See the upstream issue.

    Parameters

    • url: string

      URL to navigate page to. The url should include scheme, e.g. https://. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor.

    • Optionaloptions: {
          referer?: string;
          timeout?: number;
          waitUntil?:
              | "load"
              | "domcontentloaded"
              | "networkidle"
              | "commit";
      }
      • Optionalreferer?: string

        Referer header value. If provided it will take preference over the referer header value set by page.setExtraHTTPHeaders(headers).

      • Optionaltimeout?: number

        Maximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via navigationTimeout option in the config, or by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • OptionalwaitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit"

        When to consider operation succeeded, defaults to load. Events can be either:

        • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
        • 'load' - consider operation to be finished when the load event is fired.
        • 'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.
        • 'commit' - consider operation to be finished when network response is received and the document started loading.

    Returns Promise<null | Response>

  • NOTE Use locator-based locator.hover([options]) instead. Read more about locators.

    This method hovers over an element matching selector by performing the following steps:

    1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
    2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
    3. Scroll the element into view if needed.
    4. Use page.mouse to hover over the center of the element, or the specified position.
    5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

    When all steps combined have not finished during the specified timeout, this method throws a [TimeoutError]. Passing zero timeout disables this.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          force?: boolean;
          modifiers?: (
              | "Alt"
              | "Control"
              | "Meta"
              | "Shift")[];
          noWaitAfter?: boolean;
          position?: {
              x: number;
              y: number;
          };
          strict?: boolean;
          timeout?: number;
          trial?: boolean;
      }
      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • Optionalmodifiers?: (
            | "Alt"
            | "Control"
            | "Meta"
            | "Shift")[]

        Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalposition?: {
            x: number;
            y: number;
        }

        A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

        • x: number
        • y: number
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionaltrial?: boolean

        When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

    Returns Promise<void>

  • NOTE Use locator-based locator.innerHTML([options]) instead. Read more about locators.

    Returns element.innerHTML.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<string>

  • NOTE Use locator-based locator.innerText([options]) instead. Read more about locators.

    Returns element.innerText.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<string>

  • NOTE Use locator-based locator.inputValue([options]) instead. Read more about locators.

    Returns input.value for the selected <input> or <textarea> or <select> element.

    Throws for non-input elements. However, if the element is inside the <label> element that has an associated control, returns the value of the control.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<string>

  • NOTE Use locator-based locator.isChecked([options]) instead. Read more about locators.

    Returns whether the element is checked. Throws if the element is not a checkbox or radio input.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<boolean>

  • Indicates that the page has been closed.

    Returns boolean

  • NOTE Use locator-based locator.isDisabled([options]) instead. Read more about locators.

    Returns whether the element is disabled, the opposite of enabled.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<boolean>

  • NOTE Use locator-based locator.isEditable([options]) instead. Read more about locators.

    Returns whether the element is editable.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<boolean>

  • NOTE Use locator-based locator.isEnabled([options]) instead. Read more about locators.

    Returns whether the element is enabled.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<boolean>

  • NOTE Use locator-based locator.isHidden([options]) instead. Read more about locators.

    Returns whether the element is hidden, the opposite of visible. selector that does not match any elements is considered hidden.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        This option is ignored. page.isHidden(selector[, options]) does not wait for the element to become hidden and returns immediately.

    Returns Promise<boolean>

  • NOTE Use locator-based locator.isVisible([options]) instead. Read more about locators.

    Returns whether the element is visible. selector that does not match any elements is considered not visible.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        This option is ignored. page.isVisible(selector[, options]) does not wait for the element to become visible and returns immediately.

    Returns Promise<boolean>

  • The method returns an element locator that can be used to perform actions on this page / frame. Locator is resolved to the element immediately before performing an action, so a series of actions on the same locator can in fact be performed on different DOM elements. That would happen if the DOM structure between those actions has changed.

    Learn more about locators.

    Parameters

    • selector: string

      A selector to use when resolving DOM element.

    • Optionaloptions: {
          has?: Locator;
          hasText?: string | RegExp;
      }
      • Optionalhas?: Locator

        Matches elements containing an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.

        Note that outer and inner locators must belong to the same frame. Inner locator must not contain [FrameLocator]s.

      • OptionalhasText?: string | RegExp

        Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a [string], matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.

    Returns Locator

  • The page's main frame. Page is guaranteed to have a main frame which persists during navigations.

    Returns Frame

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "close"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "console"
    • listener: ((consoleMessage: ConsoleMessage) => void)
        • (consoleMessage): void
        • Parameters

          • consoleMessage: ConsoleMessage

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "crash"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "dialog"
    • listener: ((dialog: Dialog) => void)
        • (dialog): void
        • Parameters

          • dialog: Dialog

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "domcontentloaded"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "download"
    • listener: ((download: Download) => void)
        • (download): void
        • Parameters

          • download: Download

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "filechooser"
    • listener: ((fileChooser: FileChooser) => void)
        • (fileChooser): void
        • Parameters

          • fileChooser: FileChooser

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "frameattached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "framedetached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "framenavigated"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "load"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "pageerror"
    • listener: ((error: Error) => void)
        • (error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "popup"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "request"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "requestfailed"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "requestfinished"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "response"
    • listener: ((response: Response) => void)
        • (response): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "websocket"
    • listener: ((webSocket: WebSocket) => void)
        • (webSocket): void
        • Parameters

          • webSocket: WebSocket

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "worker"
    • listener: ((worker: Worker) => void)
        • (worker): void
        • Parameters

          • worker: Worker

          Returns void

    Returns this

  • Emitted when the page closes.

    Parameters

    • event: "close"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir. Also emitted if the page throws an error or a warning.

    The arguments passed into console.log appear as arguments on the event handler.

    An example of handling console event:

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

    Parameters

    • event: "console"
    • listener: ((consoleMessage: ConsoleMessage) => void)
        • (consoleMessage): void
        • Parameters

          • consoleMessage: ConsoleMessage

          Returns void

    Returns this

  • Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory. When the page crashes, ongoing and subsequent operations will throw.

    The most common way to deal with crashes is to catch an exception:

    try {
    // Crash might happen during a click.
    await page.click('button');
    // Or while waiting for an event.
    await page.waitForEvent('popup');
    } catch (e) {
    // When the page crashes, exception message contains 'crash'.
    }

    Parameters

    • event: "crash"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must either dialog.accept([promptText]) or dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.

    page.on('dialog', dialog => {
    dialog.accept();
    });

    NOTE When no page.on('dialog') listeners are present, all dialogs are automatically dismissed.

    Parameters

    • event: "dialog"
    • listener: ((dialog: Dialog) => void)
        • (dialog): void
        • Parameters

          • dialog: Dialog

          Returns void

    Returns this

  • Emitted when the JavaScript DOMContentLoaded event is dispatched.

    Parameters

    • event: "domcontentloaded"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.

    Parameters

    • event: "download"
    • listener: ((download: Download) => void)
        • (download): void
        • Parameters

          • download: Download

          Returns void

    Returns this

  • Emitted when a file chooser is supposed to appear, such as after clicking the <input type=file>. Playwright can respond to it via setting the input files using fileChooser.setFiles(files[, options]) that can be uploaded after that.

    page.on('filechooser', async (fileChooser) => {
    await fileChooser.setFiles('/tmp/myfile.pdf');
    });

    Parameters

    • event: "filechooser"
    • listener: ((fileChooser: FileChooser) => void)
        • (fileChooser): void
        • Parameters

          • fileChooser: FileChooser

          Returns void

    Returns this

  • Emitted when a frame is attached.

    Parameters

    • event: "frameattached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when a frame is detached.

    Parameters

    • event: "framedetached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when a frame is navigated to a new url.

    Parameters

    • event: "framenavigated"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when the JavaScript load event is dispatched.

    Parameters

    • event: "load"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when an uncaught exception happens within the page.

    // Log all uncaught errors to the terminal
    page.on('pageerror', exception => {
    console.log(`Uncaught exception: "${exception}"`);
    });

    // Navigate to a page with an exception.
    await page.goto('data:text/html,<script>throw new Error("Test")</script>');

    Parameters

    • event: "pageerror"
    • listener: ((error: Error) => void)
        • (error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Emitted when the page opens a new tab or window. This event is emitted in addition to the browserContext.on('page'), but only for popups relevant to this page.

    The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with window.open('http://example.com'), this event will fire when the network request to "http://example.com" is done and its response has started loading in the popup.

    // Start waiting for popup before clicking. Note no await.
    const popupPromise = page.waitForEvent('popup');
    await page.getByText('open the popup').click();
    const popup = await popupPromise;
    console.log(await popup.evaluate('location.href'));

    NOTE Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).

    Parameters

    • event: "popup"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see page.route(url, handler[, options]) or browserContext.route(url, handler[, options]).

    Parameters

    • event: "request"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when a request fails, for example by timing out.

    page.on('requestfailed', request => {
    console.log(request.url() + ' ' + request.failure().errorText);
    });

    NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with page.on('requestfinished') event and not with page.on('requestfailed'). A request will only be considered failed when the client cannot get an HTTP response from the server, e.g. due to network error net::ERR_FAILED.

    Parameters

    • event: "requestfailed"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request, response and requestfinished.

    Parameters

    • event: "requestfinished"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events is request, response and requestfinished.

    Parameters

    • event: "response"
    • listener: ((response: Response) => void)
        • (response): void
        • Parameters

          Returns void

    Returns this

  • Emitted when [WebSocket] request is sent.

    Parameters

    • event: "websocket"
    • listener: ((webSocket: WebSocket) => void)
        • (webSocket): void
        • Parameters

          • webSocket: WebSocket

          Returns void

    Returns this

  • Emitted when a dedicated WebWorker is spawned by the page.

    Parameters

    • event: "worker"
    • listener: ((worker: Worker) => void)
        • (worker): void
        • Parameters

          • worker: Worker

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "close"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "console"
    • listener: ((consoleMessage: ConsoleMessage) => void)
        • (consoleMessage): void
        • Parameters

          • consoleMessage: ConsoleMessage

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "crash"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "dialog"
    • listener: ((dialog: Dialog) => void)
        • (dialog): void
        • Parameters

          • dialog: Dialog

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "domcontentloaded"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "download"
    • listener: ((download: Download) => void)
        • (download): void
        • Parameters

          • download: Download

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "filechooser"
    • listener: ((fileChooser: FileChooser) => void)
        • (fileChooser): void
        • Parameters

          • fileChooser: FileChooser

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "frameattached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "framedetached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "framenavigated"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "load"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "pageerror"
    • listener: ((error: Error) => void)
        • (error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "popup"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "request"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "requestfailed"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "requestfinished"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "response"
    • listener: ((response: Response) => void)
        • (response): void
        • Parameters

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "websocket"
    • listener: ((webSocket: WebSocket) => void)
        • (webSocket): void
        • Parameters

          • webSocket: WebSocket

          Returns void

    Returns this

  • Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

    Parameters

    • event: "worker"
    • listener: ((worker: Worker) => void)
        • (worker): void
        • Parameters

          • worker: Worker

          Returns void

    Returns this

  • Returns the opener for popup pages and null for others. If the opener has been closed already the returns null.

    Returns Promise<null | Page>

  • Pauses script execution. Playwright will stop executing the script and wait for the user to either press 'Resume' button in the page overlay or to call playwright.resume() in the DevTools console.

    User can inspect selectors or perform manual steps while paused. Resume will continue running the original script from the place it was paused.

    NOTE This method requires Playwright to be started in a headed mode, with a falsy headless value in the browserType.launch([options]).

    Returns Promise<void>

  • Returns the PDF buffer.

    NOTE Generating a pdf is currently only supported in Chromium headless.

    page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia([options]) before calling page.pdf():

    NOTE By default, page.pdf() generates a pdf with modified colors for printing. Use the -webkit-print-color-adjust property to force rendering of exact colors.

    Usage

    // Generates a PDF with 'screen' media type.
    await page.emulateMedia({media: 'screen'});
    await page.pdf({path: 'page.pdf'});

    The width, height, and margin options accept values labeled with units. Unlabeled values are treated as pixels.

    A few examples:

    • page.pdf({width: 100}) - prints with width set to 100 pixels
    • page.pdf({width: '100px'}) - prints with width set to 100 pixels
    • page.pdf({width: '10cm'}) - prints with width set to 10 centimeters.

    All possible units are:

    • px - pixel
    • in - inch
    • cm - centimeter
    • mm - millimeter

    The format options are:

    • Letter: 8.5in x 11in
    • Legal: 8.5in x 14in
    • Tabloid: 11in x 17in
    • Ledger: 17in x 11in
    • A0: 33.1in x 46.8in
    • A1: 23.4in x 33.1in
    • A2: 16.54in x 23.4in
    • A3: 11.7in x 16.54in
    • A4: 8.27in x 11.7in
    • A5: 5.83in x 8.27in
    • A6: 4.13in x 5.83in

    NOTE headerTemplate and footerTemplate markup have the following limitations: > 1. Script tags inside templates are not evaluated. > 2. Page styles are not visible inside templates.

    Parameters

    • Optionaloptions: {
          displayHeaderFooter?: boolean;
          footerTemplate?: string;
          format?: string;
          headerTemplate?: string;
          height?: string | number;
          landscape?: boolean;
          margin?: {
              bottom?: string | number;
              left?: string | number;
              right?: string | number;
              top?: string | number;
          };
          pageRanges?: string;
          path?: string;
          preferCSSPageSize?: boolean;
          printBackground?: boolean;
          scale?: number;
          width?: string | number;
      }
      • OptionaldisplayHeaderFooter?: boolean

        Display header and footer. Defaults to false.

      • OptionalfooterTemplate?: string

        HTML template for the print footer. Should use the same format as the headerTemplate.

      • Optionalformat?: string

        Paper format. If set, takes priority over width or height options. Defaults to 'Letter'.

      • OptionalheaderTemplate?: string

        HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:

        • 'date' formatted print date
        • 'title' document title
        • 'url' document location
        • 'pageNumber' current page number
        • 'totalPages' total pages in the document
      • Optionalheight?: string | number

        Paper height, accepts values labeled with units.

      • Optionallandscape?: boolean

        Paper orientation. Defaults to false.

      • Optionalmargin?: {
            bottom?: string | number;
            left?: string | number;
            right?: string | number;
            top?: string | number;
        }

        Paper margins, defaults to none.

        • Optionalbottom?: string | number

          Bottom margin, accepts values labeled with units. Defaults to 0.

        • Optionalleft?: string | number

          Left margin, accepts values labeled with units. Defaults to 0.

        • Optionalright?: string | number

          Right margin, accepts values labeled with units. Defaults to 0.

        • Optionaltop?: string | number

          Top margin, accepts values labeled with units. Defaults to 0.

      • OptionalpageRanges?: string

        Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.

      • Optionalpath?: string

        The file path to save the PDF to. If path is a relative path, then it is resolved relative to the current working directory. If no path is provided, the PDF won't be saved to the disk.

      • OptionalpreferCSSPageSize?: boolean

        Give any CSS @page size declared in the page priority over what is declared in width and height or format options. Defaults to false, which will scale the content to fit the paper size.

      • OptionalprintBackground?: boolean

        Print background graphics. Defaults to false.

      • Optionalscale?: number

        Scale of the webpage rendering. Defaults to 1. Scale amount must be between 0.1 and 2.

      • Optionalwidth?: string | number

        Paper width, accepts values labeled with units.

    Returns Promise<Buffer>

  • Emitted when the page closes.

    Parameters

    • event: "close"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir. Also emitted if the page throws an error or a warning.

    The arguments passed into console.log appear as arguments on the event handler.

    An example of handling console event:

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

    Parameters

    • event: "console"
    • listener: ((consoleMessage: ConsoleMessage) => void)
        • (consoleMessage): void
        • Parameters

          • consoleMessage: ConsoleMessage

          Returns void

    Returns this

  • Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory. When the page crashes, ongoing and subsequent operations will throw.

    The most common way to deal with crashes is to catch an exception:

    try {
    // Crash might happen during a click.
    await page.click('button');
    // Or while waiting for an event.
    await page.waitForEvent('popup');
    } catch (e) {
    // When the page crashes, exception message contains 'crash'.
    }

    Parameters

    • event: "crash"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must either dialog.accept([promptText]) or dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.

    page.on('dialog', dialog => {
    dialog.accept();
    });

    NOTE When no page.on('dialog') listeners are present, all dialogs are automatically dismissed.

    Parameters

    • event: "dialog"
    • listener: ((dialog: Dialog) => void)
        • (dialog): void
        • Parameters

          • dialog: Dialog

          Returns void

    Returns this

  • Emitted when the JavaScript DOMContentLoaded event is dispatched.

    Parameters

    • event: "domcontentloaded"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.

    Parameters

    • event: "download"
    • listener: ((download: Download) => void)
        • (download): void
        • Parameters

          • download: Download

          Returns void

    Returns this

  • Emitted when a file chooser is supposed to appear, such as after clicking the <input type=file>. Playwright can respond to it via setting the input files using fileChooser.setFiles(files[, options]) that can be uploaded after that.

    page.on('filechooser', async (fileChooser) => {
    await fileChooser.setFiles('/tmp/myfile.pdf');
    });

    Parameters

    • event: "filechooser"
    • listener: ((fileChooser: FileChooser) => void)
        • (fileChooser): void
        • Parameters

          • fileChooser: FileChooser

          Returns void

    Returns this

  • Emitted when a frame is attached.

    Parameters

    • event: "frameattached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when a frame is detached.

    Parameters

    • event: "framedetached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when a frame is navigated to a new url.

    Parameters

    • event: "framenavigated"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Emitted when the JavaScript load event is dispatched.

    Parameters

    • event: "load"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when an uncaught exception happens within the page.

    // Log all uncaught errors to the terminal
    page.on('pageerror', exception => {
    console.log(`Uncaught exception: "${exception}"`);
    });

    // Navigate to a page with an exception.
    await page.goto('data:text/html,<script>throw new Error("Test")</script>');

    Parameters

    • event: "pageerror"
    • listener: ((error: Error) => void)
        • (error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Emitted when the page opens a new tab or window. This event is emitted in addition to the browserContext.on('page'), but only for popups relevant to this page.

    The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with window.open('http://example.com'), this event will fire when the network request to "http://example.com" is done and its response has started loading in the popup.

    // Start waiting for popup before clicking. Note no await.
    const popupPromise = page.waitForEvent('popup');
    await page.getByText('open the popup').click();
    const popup = await popupPromise;
    console.log(await popup.evaluate('location.href'));

    NOTE Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).

    Parameters

    • event: "popup"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see page.route(url, handler[, options]) or browserContext.route(url, handler[, options]).

    Parameters

    • event: "request"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when a request fails, for example by timing out.

    page.on('requestfailed', request => {
    console.log(request.url() + ' ' + request.failure().errorText);
    });

    NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with page.on('requestfinished') event and not with page.on('requestfailed'). A request will only be considered failed when the client cannot get an HTTP response from the server, e.g. due to network error net::ERR_FAILED.

    Parameters

    • event: "requestfailed"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request, response and requestfinished.

    Parameters

    • event: "requestfinished"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events is request, response and requestfinished.

    Parameters

    • event: "response"
    • listener: ((response: Response) => void)
        • (response): void
        • Parameters

          Returns void

    Returns this

  • Emitted when [WebSocket] request is sent.

    Parameters

    • event: "websocket"
    • listener: ((webSocket: WebSocket) => void)
        • (webSocket): void
        • Parameters

          • webSocket: WebSocket

          Returns void

    Returns this

  • Emitted when a dedicated WebWorker is spawned by the page.

    Parameters

    • event: "worker"
    • listener: ((worker: Worker) => void)
        • (worker): void
        • Parameters

          • worker: Worker

          Returns void

    Returns this

  • NOTE Use locator-based locator.press(key[, options]) instead. Read more about locators.

    Focuses the element, and then uses keyboard.down(key) and keyboard.up(key).

    key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:

    F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

    Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft.

    Holding down Shift will type the text that corresponds to the key in the upper case.

    If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

    Shortcuts such as key: "Control+o" or key: "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

    Usage

    const page = await browser.newPage();
    await page.goto('https://keycode.info');
    await page.press('body', 'A');
    await page.screenshot({ path: 'A.png' });
    await page.press('body', 'ArrowLeft');
    await page.screenshot({ path: 'ArrowLeft.png' });
    await page.press('body', 'Shift+O');
    await page.screenshot({ path: 'O.png' });
    await browser.close();

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • key: string

      Name of the key to press or a character to generate, such as ArrowLeft or a.

    • Optionaloptions: {
          delay?: number;
          noWaitAfter?: boolean;
          strict?: boolean;
          timeout?: number;
      }
      • Optionaldelay?: number

        Time to wait between keydown and keyup in milliseconds. Defaults to 0.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<void>

  • This method reloads the current page, in the same way as if the user had triggered a browser refresh. Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

    Parameters

    • Optionaloptions: {
          timeout?: number;
          waitUntil?:
              | "load"
              | "domcontentloaded"
              | "networkidle"
              | "commit";
      }
      • Optionaltimeout?: number

        Maximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via navigationTimeout option in the config, or by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • OptionalwaitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit"

        When to consider operation succeeded, defaults to load. Events can be either:

        • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
        • 'load' - consider operation to be finished when the load event is fired.
        • 'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.
        • 'commit' - consider operation to be finished when network response is received and the document started loading.

    Returns Promise<null | Response>

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "close"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "console"
    • listener: ((consoleMessage: ConsoleMessage) => void)
        • (consoleMessage): void
        • Parameters

          • consoleMessage: ConsoleMessage

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "crash"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "dialog"
    • listener: ((dialog: Dialog) => void)
        • (dialog): void
        • Parameters

          • dialog: Dialog

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "domcontentloaded"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "download"
    • listener: ((download: Download) => void)
        • (download): void
        • Parameters

          • download: Download

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "filechooser"
    • listener: ((fileChooser: FileChooser) => void)
        • (fileChooser): void
        • Parameters

          • fileChooser: FileChooser

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "frameattached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "framedetached"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "framenavigated"
    • listener: ((frame: Frame) => void)
        • (frame): void
        • Parameters

          • frame: Frame

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "load"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "pageerror"
    • listener: ((error: Error) => void)
        • (error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "popup"
    • listener: ((page: Page) => void)
        • (page): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "request"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "requestfailed"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "requestfinished"
    • listener: ((request: Request) => void)
        • (request): void
        • Parameters

          • request: Request

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "response"
    • listener: ((response: Response) => void)
        • (response): void
        • Parameters

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "websocket"
    • listener: ((webSocket: WebSocket) => void)
        • (webSocket): void
        • Parameters

          • webSocket: WebSocket

          Returns void

    Returns this

  • Removes an event listener added by on or addListener.

    Parameters

    • event: "worker"
    • listener: ((worker: Worker) => void)
        • (worker): void
        • Parameters

          • worker: Worker

          Returns void

    Returns this

  • Routing provides the capability to modify network requests that are made by a page.

    Once routing is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.

    NOTE The handler will only be called for the first url if the response is a redirect.

    NOTE page.route(url, handler[, options]) will not intercept requests intercepted by Service Worker. See this issue. We recommend disabling Service Workers when using request interception by setting Browser.newContext.serviceWorkers to 'block'.

    Usage

    An example of a naive handler that aborts all image requests:

    const page = await browser.newPage();
    await page.route('**/*.{png,jpg,jpeg}', route => route.abort());
    await page.goto('https://example.com');
    await browser.close();

    or the same snippet using a regex pattern instead:

    const page = await browser.newPage();
    await page.route(/(\.png$)|(\.jpg$)/, route => route.abort());
    await page.goto('https://example.com');
    await browser.close();

    It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:

    await page.route('/api/**', route => {
    if (route.request().postData().includes('my-string'))
    route.fulfill({ body: 'mocked-data' });
    else
    route.continue();
    });

    Page routes take precedence over browser context routes (set up with browserContext.route(url, handler[, options])) when request matches both handlers.

    To remove a route with its handler you can use page.unroute(url[, handler]).

    NOTE Enabling routing disables http cache.

    Parameters

    • url: string | RegExp | ((url: URL) => boolean)

      A glob pattern, regex pattern or predicate receiving [URL] to match while routing. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor.

    • handler: ((route: Route, request: Request) => any)

      handler function to route the request.

        • (route, request): any
        • Parameters

          • route: Route
          • request: Request

          Returns any

    • Optionaloptions: {
          times?: number;
      }
      • Optionaltimes?: number

        How often a route should be used. By default it will be used every time.

    Returns Promise<void>

  • If specified the network requests that are made in the page will be served from the HAR file. Read more about Replaying from HAR.

    Playwright will not serve requests intercepted by Service Worker from the HAR file. See this issue. We recommend disabling Service Workers when using request interception by setting Browser.newContext.serviceWorkers to 'block'.

    Parameters

    • har: string

      Path to a HAR file with prerecorded network data. If path is a relative path, then it is resolved relative to the current working directory.

    • Optionaloptions: {
          notFound?: "abort" | "fallback";
          update?: boolean;
          updateContent?: "embed" | "attach";
          updateMode?: "full" | "minimal";
          url?: string | RegExp;
      }
      • OptionalnotFound?: "abort" | "fallback"
        • If set to 'abort' any request not found in the HAR file will be aborted.
        • If set to 'fallback' missing requests will be sent to the network.

        Defaults to abort.

      • Optionalupdate?: boolean

        If specified, updates the given HAR with the actual network information instead of serving from file. The file is written to disk when browserContext.close() is called.

      • OptionalupdateContent?: "embed" | "attach"

        Optional setting to control resource content management. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file.

      • OptionalupdateMode?: "full" | "minimal"

        When set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to full.

      • Optionalurl?: string | RegExp

        A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern will be served from the HAR file. If not specified, all requests are served from the HAR file.

    Returns Promise<void>

  • Returns the buffer with the captured screenshot.

    Parameters

    • Optionaloptions: PageScreenshotOptions

    Returns Promise<Buffer>

  • NOTE Use locator-based locator.selectOption(values[, options]) instead. Read more about locators.

    This method waits for an element matching selector, waits for actionability checks, waits until all specified options are present in the <select> element and selects these options.

    If the target element is not a <select> element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be used instead.

    Returns the array of option values that have been successfully selected.

    Triggers a change and input event once all the provided options have been selected.

    Usage

    // single selection matching the value
    page.selectOption('select#colors', 'blue');

    // single selection matching the label
    page.selectOption('select#colors', { label: 'Blue' });

    // multiple selection
    page.selectOption('select#colors', ['red', 'green', 'blue']);

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • values:
          | null
          | string
          | string[]
          | ElementHandle<Node>
          | {
              index?: number;
              label?: string;
              value?: string;
          }
          | ElementHandle<Node>[]
          | {
              index?: number;
              label?: string;
              value?: string;
          }[]

      Options to select. If the <select> has the multiple attribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.

    • Optionaloptions: {
          force?: boolean;
          noWaitAfter?: boolean;
          strict?: boolean;
          timeout?: number;
      }
      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<string[]>

  • NOTE Use locator-based locator.setChecked(checked[, options]) instead. Read more about locators.

    This method checks or unchecks an element matching selector by performing the following steps:

    1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
    2. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
    3. If the element already has the right checked state, this method returns immediately.
    4. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
    5. Scroll the element into view if needed.
    6. Use page.mouse to click in the center of the element.
    7. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
    8. Ensure that the element is now checked or unchecked. If not, this method throws.

    When all steps combined have not finished during the specified timeout, this method throws a [TimeoutError]. Passing zero timeout disables this.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • checked: boolean

      Whether to check or uncheck the checkbox.

    • Optionaloptions: {
          force?: boolean;
          noWaitAfter?: boolean;
          position?: {
              x: number;
              y: number;
          };
          strict?: boolean;
          timeout?: number;
          trial?: boolean;
      }
      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalposition?: {
            x: number;
            y: number;
        }

        A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

        • x: number
        • y: number
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionaltrial?: boolean

        When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

    Returns Promise<void>

  • Parameters

    • html: string

      HTML markup to assign to the page.

    • Optionaloptions: {
          timeout?: number;
          waitUntil?:
              | "load"
              | "domcontentloaded"
              | "networkidle"
              | "commit";
      }
      • Optionaltimeout?: number

        Maximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via navigationTimeout option in the config, or by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • OptionalwaitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit"

        When to consider operation succeeded, defaults to load. Events can be either:

        • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
        • 'load' - consider operation to be finished when the load event is fired.
        • 'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.
        • 'commit' - consider operation to be finished when network response is received and the document started loading.

    Returns Promise<void>

  • This setting will change the default maximum time for all the methods accepting timeout option.

    NOTE page.setDefaultNavigationTimeout(timeout) takes priority over page.setDefaultTimeout(timeout).

    Parameters

    • timeout: number

      Maximum time in milliseconds

    Returns void

  • The extra HTTP headers will be sent with every request the page initiates.

    NOTE page.setExtraHTTPHeaders(headers) does not guarantee the order of headers in the outgoing requests.

    Parameters

    • headers: {
          [key: string]: string;
      }

      An object containing additional HTTP headers to be sent with every request. All header values must be strings.

      • [key: string]: string

    Returns Promise<void>

  • NOTE Use locator-based locator.setInputFiles(files[, options]) instead. Read more about locators.

    Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

    This method expects selector to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • files:
          | string
          | string[]
          | {
              buffer: Buffer;
              mimeType: string;
              name: string;
          }
          | {
              buffer: Buffer;
              mimeType: string;
              name: string;
          }[]
    • Optionaloptions: {
          noWaitAfter?: boolean;
          strict?: boolean;
          timeout?: number;
      }
      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<void>

  • In the case of multiple pages in a single browser, each page can have its own viewport size. However, browser.newContext([options]) allows to set viewport size (and more) for all pages in the context at once.

    page.setViewportSize(viewportSize) will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport size before navigating to the page. page.setViewportSize(viewportSize) will also reset screen size, use browser.newContext([options]) with screen and viewport parameters if you need better control of these properties.

    Usage

    const page = await browser.newPage();
    await page.setViewportSize({
    width: 640,
    height: 480,
    });
    await page.goto('https://example.com');

    Parameters

    • viewportSize: {
          height: number;
          width: number;
      }
      • height: number

        page height in pixels.

      • width: number

        page width in pixels.

    Returns Promise<void>

  • NOTE Use locator-based locator.tap([options]) instead. Read more about locators.

    This method taps an element matching selector by performing the following steps:

    1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
    2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
    3. Scroll the element into view if needed.
    4. Use page.touchscreen to tap the center of the element, or the specified position.
    5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

    When all steps combined have not finished during the specified timeout, this method throws a [TimeoutError]. Passing zero timeout disables this.

    NOTE page.tap(selector[, options]) the method will throw if hasTouch option of the browser context is false.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          force?: boolean;
          modifiers?: (
              | "Alt"
              | "Control"
              | "Meta"
              | "Shift")[];
          noWaitAfter?: boolean;
          position?: {
              x: number;
              y: number;
          };
          strict?: boolean;
          timeout?: number;
          trial?: boolean;
      }
      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • Optionalmodifiers?: (
            | "Alt"
            | "Control"
            | "Meta"
            | "Shift")[]

        Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalposition?: {
            x: number;
            y: number;
        }

        A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

        • x: number
        • y: number
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionaltrial?: boolean

        When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

    Returns Promise<void>

  • NOTE Use locator-based locator.textContent([options]) instead. Read more about locators.

    Returns element.textContent.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          strict?: boolean;
          timeout?: number;
      }
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<null | string>

  • Returns the page's title.

    Returns Promise<string>

  • NOTE Use locator-based locator.type(text[, options]) instead. Read more about locators.

    Sends a keydown, keypress/input, and keyup event for each character in the text. page.type can be used to send fine-grained keyboard events. To fill values in form fields, use page.fill(selector, value[, options]).

    To press a special key, like Control or ArrowDown, use keyboard.press(key[, options]).

    Usage

    await page.type('#mytextarea', 'Hello'); // Types instantly
    await page.type('#mytextarea', 'World', {delay: 100}); // Types slower, like a user

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • text: string

      A text to type into a focused element.

    • Optionaloptions: {
          delay?: number;
          noWaitAfter?: boolean;
          strict?: boolean;
          timeout?: number;
      }
      • Optionaldelay?: number

        Time to wait between key presses in milliseconds. Defaults to 0.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

    Returns Promise<void>

  • NOTE Use locator-based locator.uncheck([options]) instead. Read more about locators.

    This method unchecks an element matching selector by performing the following steps:

    1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
    2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
    3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
    4. Scroll the element into view if needed.
    5. Use page.mouse to click in the center of the element.
    6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
    7. Ensure that the element is now unchecked. If not, this method throws.

    When all steps combined have not finished during the specified timeout, this method throws a [TimeoutError]. Passing zero timeout disables this.

    Parameters

    • selector: string

      A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

    • Optionaloptions: {
          force?: boolean;
          noWaitAfter?: boolean;
          position?: {
              x: number;
              y: number;
          };
          strict?: boolean;
          timeout?: number;
          trial?: boolean;
      }
      • Optionalforce?: boolean

        Whether to bypass the actionability checks. Defaults to false.

      • OptionalnoWaitAfter?: boolean

        Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.

      • Optionalposition?: {
            x: number;
            y: number;
        }

        A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

        • x: number
        • y: number
      • Optionalstrict?: boolean

        When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

      • Optionaltimeout?: number

        Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionaltrial?: boolean

        When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

    Returns Promise<void>

  • Removes a route created with page.route(url, handler[, options]). When handler is not specified, removes all routes for the url.

    Parameters

    • url: string | RegExp | ((url: URL) => boolean)

      A glob pattern, regex pattern or predicate receiving [URL] to match while routing.

    • Optionalhandler: ((route: Route, request: Request) => any)

      Optional handler function to route the request.

        • (route, request): any
        • Parameters

          • route: Route
          • request: Request

          Returns any

    Returns Promise<void>

  • Returns string

  • Video object associated with this page.

    Returns null | Video

  • Returns null | {
        height: number;
        width: number;
    }

  • Emitted when the page closes.

    Parameters

    • event: "close"
    • OptionaloptionsOrPredicate: {
          predicate?: ((page: Page) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((page: Page) => boolean | Promise<boolean>)

    Returns Promise<Page>

  • Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir. Also emitted if the page throws an error or a warning.

    The arguments passed into console.log appear as arguments on the event handler.

    An example of handling console event:

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

    Parameters

    • event: "console"
    • OptionaloptionsOrPredicate: {
          predicate?: ((consoleMessage: ConsoleMessage) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((consoleMessage: ConsoleMessage) => boolean | Promise<boolean>)

    Returns Promise<ConsoleMessage>

  • Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory. When the page crashes, ongoing and subsequent operations will throw.

    The most common way to deal with crashes is to catch an exception:

    try {
    // Crash might happen during a click.
    await page.click('button');
    // Or while waiting for an event.
    await page.waitForEvent('popup');
    } catch (e) {
    // When the page crashes, exception message contains 'crash'.
    }

    Parameters

    • event: "crash"
    • OptionaloptionsOrPredicate: {
          predicate?: ((page: Page) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((page: Page) => boolean | Promise<boolean>)

    Returns Promise<Page>

  • Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must either dialog.accept([promptText]) or dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.

    page.on('dialog', dialog => {
    dialog.accept();
    });

    NOTE When no page.on('dialog') listeners are present, all dialogs are automatically dismissed.

    Parameters

    • event: "dialog"
    • OptionaloptionsOrPredicate: {
          predicate?: ((dialog: Dialog) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((dialog: Dialog) => boolean | Promise<boolean>)

    Returns Promise<Dialog>

  • Emitted when the JavaScript DOMContentLoaded event is dispatched.

    Parameters

    • event: "domcontentloaded"
    • OptionaloptionsOrPredicate: {
          predicate?: ((page: Page) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((page: Page) => boolean | Promise<boolean>)

    Returns Promise<Page>

  • Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.

    Parameters

    • event: "download"
    • OptionaloptionsOrPredicate: {
          predicate?: ((download: Download) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((download: Download) => boolean | Promise<boolean>)

    Returns Promise<Download>

  • Emitted when a file chooser is supposed to appear, such as after clicking the <input type=file>. Playwright can respond to it via setting the input files using fileChooser.setFiles(files[, options]) that can be uploaded after that.

    page.on('filechooser', async (fileChooser) => {
    await fileChooser.setFiles('/tmp/myfile.pdf');
    });

    Parameters

    • event: "filechooser"
    • OptionaloptionsOrPredicate: {
          predicate?: ((fileChooser: FileChooser) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((fileChooser: FileChooser) => boolean | Promise<boolean>)

    Returns Promise<FileChooser>

  • Emitted when a frame is attached.

    Parameters

    • event: "frameattached"
    • OptionaloptionsOrPredicate: {
          predicate?: ((frame: Frame) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((frame: Frame) => boolean | Promise<boolean>)

    Returns Promise<Frame>

  • Emitted when a frame is detached.

    Parameters

    • event: "framedetached"
    • OptionaloptionsOrPredicate: {
          predicate?: ((frame: Frame) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((frame: Frame) => boolean | Promise<boolean>)

    Returns Promise<Frame>

  • Emitted when a frame is navigated to a new url.

    Parameters

    • event: "framenavigated"
    • OptionaloptionsOrPredicate: {
          predicate?: ((frame: Frame) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((frame: Frame) => boolean | Promise<boolean>)

    Returns Promise<Frame>

  • Emitted when the JavaScript load event is dispatched.

    Parameters

    • event: "load"
    • OptionaloptionsOrPredicate: {
          predicate?: ((page: Page) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((page: Page) => boolean | Promise<boolean>)

    Returns Promise<Page>

  • Emitted when an uncaught exception happens within the page.

    // Log all uncaught errors to the terminal
    page.on('pageerror', exception => {
    console.log(`Uncaught exception: "${exception}"`);
    });

    // Navigate to a page with an exception.
    await page.goto('data:text/html,<script>throw new Error("Test")</script>');

    Parameters

    • event: "pageerror"
    • OptionaloptionsOrPredicate: {
          predicate?: ((error: Error) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((error: Error) => boolean | Promise<boolean>)

    Returns Promise<Error>

  • Emitted when the page opens a new tab or window. This event is emitted in addition to the browserContext.on('page'), but only for popups relevant to this page.

    The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with window.open('http://example.com'), this event will fire when the network request to "http://example.com" is done and its response has started loading in the popup.

    // Start waiting for popup before clicking. Note no await.
    const popupPromise = page.waitForEvent('popup');
    await page.getByText('open the popup').click();
    const popup = await popupPromise;
    console.log(await popup.evaluate('location.href'));

    NOTE Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).

    Parameters

    • event: "popup"
    • OptionaloptionsOrPredicate: {
          predicate?: ((page: Page) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((page: Page) => boolean | Promise<boolean>)

    Returns Promise<Page>

  • Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see page.route(url, handler[, options]) or browserContext.route(url, handler[, options]).

    Parameters

    • event: "request"
    • OptionaloptionsOrPredicate: {
          predicate?: ((request: Request) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((request: Request) => boolean | Promise<boolean>)

    Returns Promise<Request>

  • Emitted when a request fails, for example by timing out.

    page.on('requestfailed', request => {
    console.log(request.url() + ' ' + request.failure().errorText);
    });

    NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with page.on('requestfinished') event and not with page.on('requestfailed'). A request will only be considered failed when the client cannot get an HTTP response from the server, e.g. due to network error net::ERR_FAILED.

    Parameters

    • event: "requestfailed"
    • OptionaloptionsOrPredicate: {
          predicate?: ((request: Request) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((request: Request) => boolean | Promise<boolean>)

    Returns Promise<Request>

  • Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request, response and requestfinished.

    Parameters

    • event: "requestfinished"
    • OptionaloptionsOrPredicate: {
          predicate?: ((request: Request) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((request: Request) => boolean | Promise<boolean>)

    Returns Promise<Request>

  • Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events is request, response and requestfinished.

    Parameters

    • event: "response"
    • OptionaloptionsOrPredicate: {
          predicate?: ((response: Response) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((response: Response) => boolean | Promise<boolean>)

    Returns Promise<Response>

  • Emitted when [WebSocket] request is sent.

    Parameters

    • event: "websocket"
    • OptionaloptionsOrPredicate: {
          predicate?: ((webSocket: WebSocket) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((webSocket: WebSocket) => boolean | Promise<boolean>)

    Returns Promise<WebSocket>

  • Emitted when a dedicated WebWorker is spawned by the page.

    Parameters

    • event: "worker"
    • OptionaloptionsOrPredicate: {
          predicate?: ((worker: Worker) => boolean | Promise<boolean>);
          timeout?: number;
      } | ((worker: Worker) => boolean | Promise<boolean>)

    Returns Promise<Worker>

  • Returns when the pageFunction returns a truthy value. It resolves to a JSHandle of the truthy value.

    Usage

    The page.waitForFunction(pageFunction[, arg, options]) can be used to observe viewport size change:

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

    (async () => {
    const browser = await webkit.launch();
    const page = await browser.newPage();
    const watchDog = page.waitForFunction(() => window.innerWidth < 100);
    await page.setViewportSize({width: 50, height: 50});
    await watchDog;
    await browser.close();
    })();

    To pass an argument to the predicate of page.waitForFunction(pageFunction[, arg, options]) function:

    const selector = '.foo';
    await page.waitForFunction(selector => !!document.querySelector(selector), selector);

    Type Parameters

    • R
    • Arg

    Parameters

    • pageFunction: PageFunction<Arg, R>

      Function to be evaluated in the page context.

    • arg: Arg

      Optional argument to pass to pageFunction.

    • Optionaloptions: PageWaitForFunctionOptions

    Returns Promise<SmartHandle<R>>

  • Returns when the pageFunction returns a truthy value. It resolves to a JSHandle of the truthy value.

    Usage

    The page.waitForFunction(pageFunction[, arg, options]) can be used to observe viewport size change:

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

    (async () => {
    const browser = await webkit.launch();
    const page = await browser.newPage();
    const watchDog = page.waitForFunction(() => window.innerWidth < 100);
    await page.setViewportSize({width: 50, height: 50});
    await watchDog;
    await browser.close();
    })();

    To pass an argument to the predicate of page.waitForFunction(pageFunction[, arg, options]) function:

    const selector = '.foo';
    await page.waitForFunction(selector => !!document.querySelector(selector), selector);

    Type Parameters

    • R

    Parameters

    • pageFunction: PageFunction<void, R>

      Function to be evaluated in the page context.

    • Optionalarg: any

      Optional argument to pass to pageFunction.

    • Optionaloptions: PageWaitForFunctionOptions

    Returns Promise<SmartHandle<R>>

  • Returns when the required load state has been reached.

    This resolves when the page reaches a required load state, load by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.

    Usage

    await page.getByRole('button').click(); // Click triggers navigation.
    await page.waitForLoadState(); // The promise resolves after 'load' event.
    const popupPromise = page.waitForEvent('popup');
    await page.getByRole('button').click(); // Click triggers a popup.
    const popup = await popupPromise;
    await popup.waitForLoadState('domcontentloaded'); // Wait for the 'DOMContentLoaded' event.
    console.log(await popup.title()); // Popup is ready to use.

    Parameters

    • Optionalstate: "load" | "domcontentloaded" | "networkidle"

      Optional load state to wait for, defaults to load. If the state has been already reached while loading current document, the method resolves immediately. Can be one of:

      • 'load' - wait for the load event to be fired.
      • 'domcontentloaded' - wait for the DOMContentLoaded event to be fired.
      • 'networkidle' - wait until there are no network connections for at least 500 ms.
    • Optionaloptions: {
          timeout?: number;
      }

    Returns Promise<void>

  • Waits for the main frame navigation and returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with null.

    Usage

    This resolves when the page navigates to a new URL or reloads. It is useful for when you run code which will indirectly cause the page to navigate. e.g. The click target has an onclick handler that triggers navigation from a setTimeout. Consider this example:

    // Start waiting for navigation before clicking. Note no await.
    const navigationPromise = page.waitForNavigation();
    await page.getByText('Navigate after timeout').click();
    await navigationPromise;

    NOTE Usage of the History API to change the URL is considered a navigation.

    Parameters

    • Optionaloptions: {
          timeout?: number;
          url?: string | RegExp | ((url: URL) => boolean);
          waitUntil?:
              | "load"
              | "domcontentloaded"
              | "networkidle"
              | "commit";
      }
      • Optionaltimeout?: number

        Maximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via navigationTimeout option in the config, or by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • Optionalurl?: string | RegExp | ((url: URL) => boolean)

        A glob pattern, regex pattern or predicate receiving [URL] to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.

      • OptionalwaitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit"

        When to consider operation succeeded, defaults to load. Events can be either:

        • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
        • 'load' - consider operation to be finished when the load event is fired.
        • 'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.
        • 'commit' - consider operation to be finished when network response is received and the document started loading.

    Returns Promise<null | Response>

    This method is inherently racy, please use page.waitForURL(url[, options]) instead.

  • Waits for the matching request and returns it. See waiting for event for more details about events.

    Usage

    // Start waiting for request before clicking. Note no await.
    const requestPromise = page.waitForRequest('https://example.com/resource');
    await page.getByText('trigger request').click();
    const request = await requestPromise;

    // Alternative way with a predicate. Note no await.
    const requestPromise = page.waitForRequest(request => request.url() === 'https://example.com' && request.method() === 'GET');
    await page.getByText('trigger request').click();
    const request = await requestPromise;

    Parameters

    • urlOrPredicate: string | RegExp | ((request: Request) => boolean | Promise<boolean>)

      Request URL string, regex or predicate receiving [Request] object.

    • Optionaloptions: {
          timeout?: number;
      }
      • Optionaltimeout?: number

        Maximum wait time in milliseconds, defaults to 30 seconds, pass 0 to disable the timeout. The default value can be changed by using the page.setDefaultTimeout(timeout) method.

    Returns Promise<Request>

  • Returns the matched response. See waiting for event for more details about events.

    Usage

    // Start waiting for response before clicking. Note no await.
    const responsePromise = page.waitForResponse('https://example.com/resource');
    await page.getByText('trigger response').click();
    const response = await responsePromise;

    // Alternative way with a predicate. Note no await.
    const responsePromise = page.waitForResponse(response => response.url() === 'https://example.com' && response.status() === 200);
    await page.getByText('trigger response').click();
    const response = await responsePromise;

    Parameters

    • urlOrPredicate: string | RegExp | ((response: Response) => boolean | Promise<boolean>)

      Request URL string, regex or predicate receiving [Response] object. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor.

    • Optionaloptions: {
          timeout?: number;
      }

    Returns Promise<Response>

  • Returns when element specified by selector satisfies state option. Returns null if waiting for hidden or detached.

    NOTE Playwright automatically waits for element to be ready before performing an action. Using [Locator] objects and web-first assertions makes the code wait-for-selector-free.

    Wait for the selector to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the function will throw.

    Usage

    This method works across navigations:

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

    (async () => {
    const browser = await chromium.launch();
    const page = await browser.newPage();
    for (let currentURL of ['https://google.com', 'https://bbc.com']) {
    await page.goto(currentURL);
    const element = await page.waitForSelector('img');
    console.log('Loaded image: ' + await element.getAttribute('src'));
    }
    await browser.close();
    })();

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

      A selector to query for.

    • Optionaloptions: PageWaitForSelectorOptionsNotHidden

    Returns Promise<ElementHandleForTag<K>>

  • Returns when element specified by selector satisfies state option. Returns null if waiting for hidden or detached.

    NOTE Playwright automatically waits for element to be ready before performing an action. Using [Locator] objects and web-first assertions makes the code wait-for-selector-free.

    Wait for the selector to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the function will throw.

    Usage

    This method works across navigations:

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

    (async () => {
    const browser = await chromium.launch();
    const page = await browser.newPage();
    for (let currentURL of ['https://google.com', 'https://bbc.com']) {
    await page.goto(currentURL);
    const element = await page.waitForSelector('img');
    console.log('Loaded image: ' + await element.getAttribute('src'));
    }
    await browser.close();
    })();

    Parameters

    • selector: string

      A selector to query for.

    • Optionaloptions: PageWaitForSelectorOptionsNotHidden

    Returns Promise<ElementHandle<HTMLElement | SVGElement>>

  • Returns when element specified by selector satisfies state option. Returns null if waiting for hidden or detached.

    NOTE Playwright automatically waits for element to be ready before performing an action. Using [Locator] objects and web-first assertions makes the code wait-for-selector-free.

    Wait for the selector to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the function will throw.

    Usage

    This method works across navigations:

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

    (async () => {
    const browser = await chromium.launch();
    const page = await browser.newPage();
    for (let currentURL of ['https://google.com', 'https://bbc.com']) {
    await page.goto(currentURL);
    const element = await page.waitForSelector('img');
    console.log('Loaded image: ' + await element.getAttribute('src'));
    }
    await browser.close();
    })();

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

      A selector to query for.

    • options: PageWaitForSelectorOptions

    Returns Promise<null | ElementHandleForTag<K>>

  • Returns when element specified by selector satisfies state option. Returns null if waiting for hidden or detached.

    NOTE Playwright automatically waits for element to be ready before performing an action. Using [Locator] objects and web-first assertions makes the code wait-for-selector-free.

    Wait for the selector to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the function will throw.

    Usage

    This method works across navigations:

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

    (async () => {
    const browser = await chromium.launch();
    const page = await browser.newPage();
    for (let currentURL of ['https://google.com', 'https://bbc.com']) {
    await page.goto(currentURL);
    const element = await page.waitForSelector('img');
    console.log('Loaded image: ' + await element.getAttribute('src'));
    }
    await browser.close();
    })();

    Parameters

    • selector: string

      A selector to query for.

    • options: PageWaitForSelectorOptions

    Returns Promise<null | ElementHandle<HTMLElement | SVGElement>>

  • Waits for the given timeout in milliseconds.

    Note that page.waitForTimeout() should only be used for debugging. Tests using the timer in production are going to be flaky. Use signals such as network events, selectors becoming visible and others instead.

    Usage

    // wait for 1 second
    await page.waitForTimeout(1000);

    Parameters

    • timeout: number

      A timeout to wait for

    Returns Promise<void>

  • Waits for the main frame to navigate to the given URL.

    Usage

    await page.click('a.delayed-navigation'); // Clicking the link will indirectly cause a navigation
    await page.waitForURL('**/target.html');

    Parameters

    • url: string | RegExp | ((url: URL) => boolean)

      A glob pattern, regex pattern or predicate receiving [URL] to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.

    • Optionaloptions: {
          timeout?: number;
          waitUntil?:
              | "load"
              | "domcontentloaded"
              | "networkidle"
              | "commit";
      }
      • Optionaltimeout?: number

        Maximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via navigationTimeout option in the config, or by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

      • OptionalwaitUntil?:
            | "load"
            | "domcontentloaded"
            | "networkidle"
            | "commit"

        When to consider operation succeeded, defaults to load. Events can be either:

        • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
        • 'load' - consider operation to be finished when the load event is fired.
        • 'networkidle' - consider operation to be finished when there are no network connections for at least 500 ms.
        • 'commit' - consider operation to be finished when network response is received and the document started loading.

    Returns Promise<void>

  • This method returns all of the dedicated WebWorkers associated with the page.

    NOTE This does not contain ServiceWorkers

    Returns Worker[]