WordPress · wwahammy · Mar 27, 2026 · wwahammy · Mar 27, 2026
@@ -20,13 +20,7 @@ npm install @wordpress/e2e-test-utils-playwright --save-dev
 
 ## API
 
-### test
-
-The extended Playwright's [test](https://playwright.dev/docs/api/class-test) module with the `admin`, `editor`, `pageUtils` and the `requestUtils` fixtures.
-
-### expect
-
-The Playwright/Jest's [expect](https://jestjs.io/docs/expect) function.
+<!-- START TOKEN(Autogenerated API docs) -->
 
 ### Admin
 
@@ -37,6 +31,10 @@ const admin = new Admin( { page, pageUtils } );
 await admin.visitAdminPage( 'options-general.php' );
 ```
 
+_Type_
+
+-   `Admin`
+
 ### Editor
 
 End to end test utilities for the WordPress Block Editor.
@@ -57,10 +55,28 @@ Within a test or test utility, use the `canvas` property to select elements with
 await editor.canvas.locator( 'role=document[name="Paragraph block"i]' );
 ```
 
+_Type_
+
+-   `Editor`
+
+### expect
+
+The Playwright/Jest's [expect](https://jestjs.io/docs/expect) function.
+
+### Lighthouse
+
+Undocumented declaration.
+
+### Metrics
+
+Undocumented declaration.
+
 ### PageUtils
 
 Generic Playwright utilities for interacting with web pages.
 
+_Usage_
+
 ```js
 const pageUtils = new PageUtils( { page } );
 await pageUtils.pressKeys( 'primary+a' );
@@ -70,9 +86,10 @@ await pageUtils.pressKeys( 'primary+a' );
 
 Playwright utilities for interacting with the WordPress REST API.
 
-Create a request utils instance.
+_Usage_
 
 ```js
+// Create a request utils instance.
 const requestUtils = await RequestUtils.setup( {
 	user: {
 		username: 'admin',
@@ -81,6 +98,12 @@ const requestUtils = await RequestUtils.setup( {
 } );
 ```
 
+### test
+
+The extended Playwright's [test](https://playwright.dev/docs/api/class-test) module with the `admin`, `editor`, `pageUtils`, `snapshotConfig`, `metrics`, `lighthouse` and the `requestUtils` fixtures.
+
+<!-- END TOKEN(Autogenerated API docs) -->
+
 ## Contributing to this package
 
 This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects.

@@ -20,6 +20,14 @@ type AdminConstructorProps = {
 	editor: Editor;
 };
 
+/**
+ * End to end test utilities for WordPress admin's user interface.
+ *
+ * ```js
+ * const admin = new Admin( { page, pageUtils } );
+ * await admin.visitAdminPage( 'options-general.php' );
+ * ```
+ */
 export class Admin {
 	page: Page;
 	context: BrowserContext;

@@ -34,6 +34,26 @@ type EditorConstructorProps = {
 	page: Page;
 };
 
+/**
+ * End to end test utilities for the WordPress Block Editor.
+ *
+ * To use these utilities, instantiate them within each test file:
+ *
+ * ```js
+ * test.use( {
+ * 	editor: async ( { page }, use ) => {
+ * 		await use( new Editor( { page } ) );
+ * 	},
+ * } );
+ * ```
+ *
+ * Within a test or test utility, use the `canvas` property to select elements within the iframe canvas:
+ *
+ * ```js
+ * await editor.canvas.locator( 'role=document[name="Paragraph block"i]' );
+ * ```
+ *
+ */
 export class Editor {
 	browser: Browser;
 	page: Page;

@@ -22,6 +22,15 @@ type PageUtilConstructorParams = {
 	browserName: PlaywrightWorkerOptions[ 'browserName' ];
 };
 
+/**
+ * Generic Playwright utilities for interacting with web pages.
+ *
+ * @example
+ * ```js
+ * const pageUtils = new PageUtils( { page } );
+ * await pageUtils.pressKeys( 'primary+a' );
+ * ```
+ */
 class PageUtils {
 	browser: Browser;
 	page: Page;

@@ -44,6 +44,20 @@ interface StorageState {
 	rootURL: string;
 }
 
+/**
+ * Playwright utilities for interacting with the WordPress REST API.
+ * @example
+ * ```js
+ * 	// Create a request utils instance.
+ * 	const requestUtils = await RequestUtils.setup( {
+ *		user: {
+ *			username: 'admin',
+ *		password: 'password',
+ *		},
+ *	} );
+ *  ```
+ *
+ */
 class RequestUtils {
 	request: APIRequestContext;
 	user: User;

@@ -2,7 +2,7 @@
  * External dependencies
  */
 import * as path from 'path';
-import { test as base, expect, chromium } from '@playwright/test';
+import { test as base, expect as baseExpect, chromium } from '@playwright/test';
 import type { ConsoleMessage } from '@playwright/test';
 import getPort from 'get-port';
 
@@ -121,6 +121,16 @@ function observeConsoleLogging( message: ConsoleMessage ) {
 	console[ logFunction ]( text );
 }
 
+/**
+ * The extended Playwright's [test](https://playwright.dev/docs/api/class-test) module with the
+ * 	`admin`,
+ * 	`editor`,
+ * 	`pageUtils`,
+ * 	`snapshotConfig`,
+ * 	`metrics`,
+ * 	`lighthouse`
+ * 	and the `requestUtils` fixtures.
+ */
 const test = base.extend<
 	{
 		admin: Admin;
@@ -199,4 +209,9 @@ const test = base.extend<
 	},
 } );
 
+/**
+ * The Playwright/Jest's [expect](https://jestjs.io/docs/expect) function.
+ */
+const expect = baseExpect;
+
 export { test, expect };