ty888/ide-webextension

ide-webextension

WebExtension Vite Starter (with React)

A Vite powered WebExtension (Chrome, FireFox, etc.) starter template.

<sub>Popup

Options Page

Inject Vue App into the Content Script</sub>

Features

• ⚡️ Instant HMR - use Vite on dev (no more refresh!)
• ⚛️ React
• 🦾 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

Pre-packed

WebExtension Libraries

• webextension-polyfill - WebExtension browser API Polyfill with types
• webext-bridge - effortlessly communication between contexts

Vite Plugins

• unplugin-auto-import - Directly use browser without importing

Coding Style

• ESLint
• Prettier

Dev tools

• TypeScript
• yarn - 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

Use the Template

GitHub Template

Create a repo from this template on GitHub.

Clone to local

If you prefer to do it manually with the cleaner git history

If you don't have yarn installed, run: npm install -g yarn

npx degit YangJonghun/vite-react-webext my-webext
cd my-webext
yarn

Usage

Folders

• src - main source.
  • assets - shareable public assets.
  • background - scripts for background.
  • contentScripts - scripts and components to be injected as content_script
  • components - auto-imported Vue components that are shared in popup and options page.
  • styles - styles shared in popup and options page
  • manifest.ts - manifest for the extension (v2).
• extension - extension package root.
  • assets - static assets.
  • dists - built files, also serve stub entry for Vite on development.
• scripts - development and bundling helper scripts.

Development

yarn dev

Then load extension in browser with the extension/ folder.

For Firefox developers, you can run the following command instead:

yarn 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.

Build

To build the extension, run

yarn build

And then pack files under extension, you can upload extension.crx or extension.xpi to appropriate extension store.

Credits

This template codes are based on Anthony Fu's vitesse-webext.