extension-js/extension.jsPublic

NotificationsYou must be signed in to change notification settings
Fork115
Star4.3k

🧩 The cross-browser extension framework.

License

MIT license

4.3k stars 115 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 955 Commits
.changeset		.changeset
.github		.github
.husky		.husky
examples		examples
programs		programs
templates		templates
.env.example		.env.example
.gitignore		.gitignore
.lintstagedrc.json		.lintstagedrc.json
.npmrc		.npmrc
.prettierrc		.prettierrc
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
codecov.yml		codecov.yml
eslint.config.mjs		eslint.config.mjs
meta.json		meta.json
package.json		package.json
playwright.config.ts		playwright.config.ts
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
tsconfig.json		tsconfig.json
turbo.json		turbo.json

Repository files navigation

The cross-browser extension framework

Extension.js

Create A New Extension — How to create a new extension.
Get Started Immediately — Get work done in no time.
Start From An Example — Start with your favorite tool.
I have An Extension — Use only specific parts of Extension.js.

Extension.js makes it very easy to develop cross-browser extensions.
Developers prefer it for its fast builds, unified interface, and zero configuration setup.

Create A New Extension

Use thecreate command to generate a new extension. Also works with pnpm, yarn, and bun.

npx extension@latest create my-extensioncd my-extensionnpm run dev

Watch Demo

create-a-new-extension.mp4

Web Standards and Framework Support


ESNext latest	TypeScript latest	WASM latest	React 18+	Vue 3+	Svelte 5+	Preact 10+	Angular 👋	Solid 👋

👋 = PR Welcome!

Get Started Immediately

Start developing an extension using a sample from Chrome Extension Samples

See the example below where we request the samplepage-redder fromGoogle Chrome Extension Samples.

Watch Demo

chrome-extension-sample-page-redder-on-edge.mp4

Try Yourself

npx extension@latest dev https://github.com/GoogleChrome/chrome-extensions-samples/tree/main/functional-samples/sample.page-redder --browser=edge

I have An Extension

If you have an existing extension which is using a package manager, you can install the Extension.js package and manually create the scripts used to run your extension.

See How It Works

usage-with-an-existing-extension.mp4

Step 1 - Install extension as adevDependency

npm install extension@latest --save-dev

Step 2 - Link your npm scripts with the executable Extension.js commands

{"scripts": {"build":"extension build","dev":"extension dev","preview":"extension preview"  },"devDependencies": {// ...other dependencies"extension":"latest"  }}

Done. You are all set!

To develop the extension, runnpm run dev.
To build the extension in production mode, runnpm run build.
To visualize the extension in production mode, runnpm run build andnpm run preview.

Using a specific browser for development

Desktop Browsers


Chrome ✅	Edge ✅	Firefox ✅	Opera ☑️	Safari ⛔️	Chromium ☑️

The browsers listed above represent those with official extension stores. Note that Chromium-based browsers (like Arc, Brave, Vivaldi, and many others) are theoretically supported through the Chrome/Chromium compatibility layer.