web-extension-starter/README.md

🚀 web-extension-starter

Web Extension starter to build "Write Once Run on Any Browser" extension

Features

• Cross Browser Support (Web-Extensions API)
• Browser Taylored Manifest generation
• Automatic build on code changes.
• Auto packs browser specific build files
• ES6 modules support
• SASS styling

Browser Support

| | | | | | |

49 & later ✔	52 & later ✔	36 & later ✔	Latest ✔	Latest ✔	Latest ✔	Latest ✔

Demo

• abhijithvijayan/kutt-extension

🚀 Quick Start

• yarn install to install dependencies.
• yarn run dev:chrome to start the development server for chrome extension.
• yarn run dev:firefox to start the development server for firefox addon.
• yarn run dev:opera to start the development server for opera extension.
• yarn run build:chrome to build chrome extension.
• yarn run build:firefox to build firefox addon.
• yarn run build:opera to build opera extension.
• yarn run build builds and packs extensions all at once to extension/ directory.

Usage

Update src/manifest/index.js file with browser vendor prefixed manifest keys

{
  "__chrome__name": "SuperChrome",
  "__firefox__name": "SuperFox",
  "__edge__name": "SuperEdge",
  "__opera__name": "SuperOpera"
}

if the vendor is chrome this compiles to:

{
  "name": "SuperChrome",
}

---

Add keys to multiple vendors by seperating them with | in the prefix

{
  __chrome|opera__name: "SuperBlink"
}

if the vendor is chrome or opera, this compiles to:

{
  "name": "SuperBlink"
}

See the original README of wext-manifest package for more details

Show your support

Give a ⭐️ if this project helped you!

Licence

Code released under the MIT License.