Action (Popup)

Adds a toolbar popup to the browser with a simple page.

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

Create this project

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

!Powered by Extension.js

JavaScript Action Popup Example

Adds a toolbar popup to the browser with a simple page.

What you'll see: A toolbar popup that opens when you click the extension's icon.

How it works: The manifest registers an action and points default_popup at a JavaScript page bundled from src/action/.

Try it locally

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

A fresh browser window opens with the extension already loaded.

Project layout

src/
├── action/
│   ├── index.html
│   ├── scripts.js
│   └── styles.css
├── images/
│   └── icon.png
├── background.js
└── 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