🏝 Preact Island Starter

Bootstraps a Preact Island project with no configuration.

Features

🚀 Multi entry point builds by default. Make all the islands you need!
🌲 Infinitely tree shakeable. Each entry point tree shakes both the JS and CSS.
🧩 First class web component support (including web component portals 🤯)
🧁 Zero runtime styles in Typescript thanks to vanilla-extract
⛷️ Dev environment injects scripts just like you would use in production.
🐿️ Dynamic island build environment thanks to Webpack layers
🚢 Built in Netlify deployments
🙏 Environmental variable support
🔥 Playwright testing built in
👔 Fully typed with TypeScript

Stack

⚛️ Preact
👔 TypeScript
🌐 Webpack 5
🧁 Vanilla-Extract
🤡 Netlify
🔥 Playwright testing

What's Preact Island?

Sometimes you need to embed a component onto someone else's website. This could be a Shopify widget, email sign up form, CMS comment list, social media share icon, etc. Creating these experiences are tedious and difficult because you aren't in control of the website your code will be executed on.

Preact Island helps you build these experiences by adding a lightweight layer on top of Preact. For <5kB, you get a React style workflow (with hooks!), and a framework for rendering your widget with reactive props.

Head on over to the repo for more details!

Using the Template

No fancy CLI (yet), so to use the template we're going old school!

git clone [email protected]:mwood23/preact-island-starter.git <NAME OF YOUR PROJECT>

cd <NAME OF YOUR PROJECT>

# Remove the Git history from the repo
rm -rf .git

# Edit the name in the package.json

# Create a new Git history
git init
git add .
git commit -m "Initial commit"


#############################################################
# From here, create a new repo, hook up the remote and push #
#############################################################

# Node 16 is recommended!
# To run the app
npm install

npm run dev

API

Adding Islands

To add a new island, create a file suffixed with .island.tsx. The webpack compiler will automatically pick it up and add your new island to the index.html page. You may need to restart your development server to see the changes take hold.

Styling Islands

This template uses vanilla-extract for all styles. Please refer to their docs for more information. The starter has some base patterns set up, including a Box component that everything is built off of. There are some footguns with vanilla extract due to how CSS is interpreted by browsers so watch out!

If you use a style() object those are going to have higher specificity than any sprinkles, including props passed directly to a <Box padding="4"></Box>
Make sure reset.css is imported at the top of every island. This makes sure it is executed first in the stylesheet so that your styles can override it.

Deploying Islands

Run npm run build to create your islands and a demo page that you can deploy anywhere. These are static files so it's best to go somewhere with a good CDN like Vercel, Cloudflare, Netlify, etc. The islands are in a separate directory /islands so you don't pollute the root domain. You can alter this output in the webpack.config.js if you need.

Environmental Variables

The starter ships with support with environmental variables. To develop locally, add variables to .env.local. The starter uses Netlify for the CI and deployment process so that is where you would add variables per environment if you choose to use them for deployment.

Remember that nearly all islands are going to run on a client somewhere. These are meant to be use to create environments, all variables will be exposed onto the client (aka public), so don't put anything secretive in here!

Credits

Artwork by vik4graphic

arndvs / preact-island-starter Goto Github PK