The Plasmo (opens in a new tab) Framework is a battery-packed browser extension SDK made by hackers for hackers. Build your product and stop worrying about config files and the odd peculiarities of building browser extensions.
It's like Next.js (opens in a new tab) for browser extensions!
- First-class React (opens in a new tab) + Typescript (opens in a new tab) Support
- Declarative Development (opens in a new tab)
- Content Scripts UI (opens in a new tab)
- Tab Pages (opens in a new tab)
- Live-reloading + React HMR
.env*files (opens in a new tab)
- Storage API (opens in a new tab)
- Messaging API (opens in a new tab)
- Remote code bundling (opens in a new tab) (e.g., for Google Analytics)
- Targeting multiple browser and manifest pairs (opens in a new tab)
- Automated deployment via BPP (opens in a new tab)
- Optional support for Svelte (opens in a new tab) and Vue (opens in a new tab)
And many, many more! 🚀
- Node.js 16.14.x or later
- macOS, Windows, or Linux
- (Strongly Recommended) pnpm (opens in a new tab)
pnpm create plasmo # OR yarn create plasmo # OR npm create plasmo
This command will set up the simplest Plasmo browser extension project for you. The structure is straightforward:
|This file exports a default React component, which gets rendered into your popup page. This is all you need to work on your extension popup!|
|Plasmo automatically generates the smaller icons and applies them in the manifest for you from the "icon.png" file|
|Your usual Node.js project descriptor, with an optional "manifest" property to customize Plasmo to your needs|
|For code styling consistency|
|Your friendly neighborhood Git ignore file|
|GitHub Actions workflows for automated deployment|
NOTE: By default, all your code lives on the root of your project. To use an
src directory as the place your source code lives, please follow this
For live-reloading and HMR, you can start the development server with:
The above command will watch for file changes and regenerate a bundle of your extension in
build/chrome-mv3-dev, and automatically reload your extension in your browser.
For a production build, run:
This will create a production version of the extension in
We plan to automate this in the future, but for the time being, these are the steps you need to take to load your extension in Chrome.
Head over to
chrome://extensions and enable Developer Mode.
Click on "Load Unpacked" and navigate to your extension's
To see your popup, click on the puzzle piece icon on the Chrome toolbar, and click on your extension.
Pro tip: pin your extension to the Chrome toolbar for easy access by clicking the pin button.
Plasmo abstracts away the manifest file. The framework generates the manifest under the hood based on your source files and configurations you export from your code, similar to how Next.js (opens in a new tab) abstracts page routing and SSG with the file system and page components.
We will further abstract with auto-permissions and a needs-based permission scheme, removing the need to specify permissions manually! (Coming soon)
Go to the Extension Pages section to learn more about the different UI elements in a Plasmo extension and get inspiration. A modular example accompanies each workflow, showcasing the framework's simplicity. View examples on our GitHub repo (opens in a new tab).
Check out the Customization section for documentation on making Plasmo adapt to your needs.
To see how to integrate Plasmo with other tools (such as TailwindCSS or Firebase), check out the list of examples in the Quickstarts section.
Find the Plasmo community on Discord (opens in a new tab). If you're stuck and want some help or looking to chat more about Plasmo and browser extensions, this is the place to be!
If you find a bug in the Plasmo Framework, please report it using our Bug Report Form.
Our Code of Conduct (opens in a new tab) applies to all Plasmo community channels.