Preact

Adds a sidebar panel to the browser with a simple Preact page.

Runs on Chrome, Edge, Firefox · Manifest V3 · Surfaces: sidebar, content script, popup, background service worker · Styling: CSS · Framework: preact

Create this project

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

!Powered by Extension.js

Preact Sidebar Example

Adds a sidebar panel to the browser with a simple Preact page.

What you'll see: A sidebar panel with a Preact page, plus a small Preact UI injected into any web page, isolated in a Shadow DOM so site styles don't bleed through.

How it works: The side panel loads a Preact + TypeScript page. A content script also mounts a Preact UI inside a Shadow DOM and applies scoped styles so the host page can't bleed through.

Try it locally

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

A fresh browser window opens with the extension already loaded.

Project layout

src/
├── content/
│   ├── ContentApp.tsx
│   ├── scripts.tsx
│   └── styles.css
├── images/
│   └── icon.png
├── public/
│   ├── extension.svg
│   └── logo.svg
├── sidebar/
│   ├── index.html
│   ├── scripts.tsx
│   ├── SidebarApp.tsx
│   └── 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