Vite web extension template. Setup with React, Typescript and TailwindCSS
MIT License
This boilerplate is meant to be a minimal quick start for creating chrome extensions using React, Typescript and Tailwind CSS.
Built for:
For improved DX and rapid building vite and nodemon are used.
Chrome does not accept manifest v2 extensions since Jan 2022, therefore this template uses manifest v3.
Firefox + other browsers don't yet support manifest v3, so cross browser usage is not encouraged.
As soon as Firefox supports manifest v3, support will be added in this repo as well.
Oh by the way ... I also implemented a chrome local/sync storage hook for react, which works well with this template. Check it out here.
I have used webpack react boilerplates and found it too hard to configure.
Vite is mega easy to understand which makes it easier to get into and to maintain for others.
I couldn't find another minimal boilerplate for React, TypeScript and Tailwind CSS. So here it is.
name
and description
in manifest.json
yarn
or npm i
(check your node version >= 16)yarn dev
or npm run dev
dist
folder in this project (after dev or build)yarn build
or npm run build
.The template includes all of the Chrome extension pages. You will likely have to customize it to fit your needs.
E.g. you don't want the newtab page to activate whenever you open a new tab:
newtab
and its contents in src/pages
chrome_url_overrides: { newtab: 'src/pages/newtab/index.html' },
in manifest.json
If you need to declare extra HTML pages beyond those the manifest accommodates, place them in the Vite config under build.rollupOptions.input.
This example includes a welcome page to open when the user installs the extension.
CSS files in the src/pages/*
directories are not necessary. They are left in there in case you want
to use it in combination with Tailwind CSS. Feel free to delete them.
Tailwind can be configured as usual in the tailwind.config.cjs
file. See doc link below.
To upload an extension to the Chrome store you have to pack (zip) it and then upload it to your item in entry in the Chrome Web Store.
This repo includes a Github Action Workflow to create a optimized prod build and create the zip file.
To run the workflow do the following:
Heavily inspired by Jonghakseo's vite chrome extension boilerplate. It uses SASS instead of TailwindCSS if you want to check it out.
Feel free to open PRs or raise issues!