探客时代
Plasmo
The Browser Extension Framework
README
Plasmo Framework
The Plasmo 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 for browser extensions!
Features
First-class React + Typescript Support
Live-reloading + React HMR
Targeting multiple browser and manifest pairs
Remote code bundling (e.g for gtag4)
And many, many more! 🚀
System Requirements
Node.js 16.x or later
MacOS, Windows, or Linux
(Strongly Recommended) pnpm
Examples
We have examples showcasing how one can use Plasmo with Firebase Authentication , Redux , Supabase authentication , Tailwind , and many more. To check them out, visit our examples repository .
Documentation
Check out the documentation to get a more in-depth view into the Plasmo Framework.
Usage
- ``` null
- pnpm create plasmo example-dir
- cd example-dir
- pnpm dev
- ```
The road ahead is filled with many turns.
Popup changes go in popup.tsx
Options page changes go in options.tsx
Content script changes go in content.ts
Background service worker changes go in background.ts
Directories
You can also organize these files in their own directories:
- ``` null
- ext-dir
- ├───assets
- | └───icon512.png
- ├───popup
- | ├───index.tsx
- | └───button.tsx
- ├───options
- | ├───index.tsx
- | ├───utils.ts
- | └───input.tsx
- ├───contents
- | ├───site-one.ts
- | ├───site-two.ts
- | └───site-three.ts
- ...
- ```
Finally, you can also avoid putting source code in your root directory by putting them in a srcsub-directory, following this guide . Note thatassetsand other config files will still need to be in the root directory.
Community
The Plasmo community can be found on Discord . This is the appropriate channel to get help with using the Plasmo Framework.
Our Code of Conduct applies to all Plasmo community channels.
Contributing
Please see the contributing guidelines to learn more.
Disclaimer
Plasmo is currently alpha software, and some things might change from version to version, so please be mindful and use it at your own risk.
