Playwright E2E Sidebar

Adds a sidebar panel to the browser, covered end to end by Playwright tests.

Runs on Chrome, Edge, Firefox · Manifest V3 · Surfaces: sidebar, popup, background service worker · Styling: CSS · Level: intermediate

Create this project

npx extension@latest create my-playwright --template playwright
cd my-playwright
npm install
npm run dev

!Powered by Extension.js

Playwright E2E Starter

Adds a sidebar panel to the browser, covered end to end by Playwright tests.

What you'll see: A browser side panel that loads when you open the sidebar.

How it works: The manifest registers a side panel (chromium:side_panel / firefox:sidebar_action) that loads a TypeScript page bundled from src/sidebar/.

Designed for Playwright-driven E2E tests. The template ships a sidebar panel together with a Playwright fixture (extension-fixtures) so you can drive the extension from a real browser session in CI.

Try it locally

npx extension@latest create my-playwright --template playwright
cd my-playwright
npm install
npm run dev

A fresh browser window opens with the extension already loaded.

Project layout

src/
├── images/
│   └── icon.png
├── sidebar/
│   ├── index.html
│   ├── scripts.ts
│   ├── SidebarApp.ts
│   └── styles.css
├── background.ts
└── manifest.json

Commands

Cloned this repo instead? The examples ship without npm scripts, so run Extension.js directly from the example directory. Run npm install first when the example declares dependencies.

dev

Run the extension in development mode. Target a browser with --browser:

npx extension@latest dev .                  # Chromium (default)
npx extension@latest dev . --browser=chrome
npx extension@latest dev . --browser=edge
npx extension@latest dev . --browser=firefox

build

Build for production:

npx extension@latest build .                # Chromium (default)
npx extension@latest build . --browser=firefox
npx extension@latest build . --browser=edge

preview

Preview the production build with the bundled browser:

npx extension@latest preview .

Tests

This template ships an end-to-end check (template.spec.ts) validated by the examples-repo CI on every commit.

Learn more

extension.devDocumentation for extension.dev