Twind is designed to be used in almost any environment and exposes several different bundles from ESM to UMD. The ESM bundles should be preferred for it's smaller size after tree-shaking and faster performance.
Although Twind is compatible with traditional bundlers, there is no build step required to use Twind.
An integration usually has two parts:
installcreates and registers a twind instance that will generate the styles. This allows third-party packages to import
twfrom the twind package and get the same instance.
Extract the styles from the HTML eg server-side rendering.
pseudo code - depends on the used framework or environment
All official integrations are available on npm:
- gatsby-plugin-twind — Gatsby
- @twind/with-next — Next.js
- @twind/with-remix — Remix
- @twind/with-sveltekit — SvelteKit
To find community integrations search for the keyword
twind-with on npm.
TODO: Add documentation for creating a new integration.
Here are some examples of how to write your own integration: