a fork version of vitesse-webext, but with react
A Vite powered WebExtension (Chrome, FireFox, etc.) starter template.
- β‘οΈ Instant HMR - use Vite on dev (no more refresh!)
- π React
- π¬ Effortless communications - powered by
webext-bridge
- π Windi CSS - on-demand CSS utilities
- π¦Ύ TypeScript - type safe
- π₯ Content Script - Use React even in content script
- π WebExtension - isomorphic extension for Chrome, Firefox, and others
- π Dynamic
manifest.json
with full type support
webextension-polyfill
- WebExtension browser API Polyfill with typeswebext-bridge
- effortlessly communication between contexts
- Windi CSS - next generation utility-first CSS framework
βοΈ experimental
Combine Windi CSS and styled-components by styled-plugin-windicss, it will translate
// input
const Wrapped = styled.div`
@apply m-0 p-0 w-100vw h-100vh overflow-hidden;
`
// output
const Wrapped = styled.div`
color: red;
margin: 0px;
overflow: hidden;
padding: 0px;
width: 100vw;
`
- TypeScript
- pnpm - fast, disk space efficient package manager
- esno - TypeScript / ESNext node runtime powered by esbuild
- npm-run-all - Run multiple npm-scripts in parallel or sequential
- web-ext - Streamlined experience for developing web extensions
src
- main source.contentScript
- scripts and components to be injected ascontent_script
background
- scripts for background.components
- auto-imported React components that shared in popup and options page.styles
- styles shared in popup and options pagemanifest.ts
- manifest for the extension.
extension
- extension package root.assets
- static assets.dist
- built files, also serve stub entry for Vite on development.
scripts
- development and bundling helper scripts.
pnpm dev
Then load extension in browser with the extension/
folder.
For Firefox developers, you can run the following command instead:
pnpm start:firefox
web-ext
auto reload the extension when extension/
files changed.
While Vite handles HMR automatically in the most of the case, Extensions Reloader is still recommanded for cleaner hard reloading.
To build the extension, run
pnpm build
And then pack files under extension
, you can upload extension.crx
or extension.xpi
to appropriate extension store.
built with β€οΈ by πΌ