Getting started
Frameworks
A clear map of supported integrations and future adapters.
React and Vite
The implemented component registry is React with TypeScript. The Playground is a Vite application and a working integration reference. Import @pimolu/web-styles/styles.css at the entry and compose the application below PimoluProvider.
The React and React DOM peer ranges are ^18.0.0 || ^19.0.0. This website runs React 19. Test the version your application uses; a declared peer range is not evidence that every workflow was checked on every minor version.
Next.js App Router
apps/website and examples/nextjs use the App Router. Published packages contain compiled ESM and TypeScript declarations, so no Pimolu-specific transpilePackages setting is needed. Load the shared CSS once in app/layout.tsx and keep the Provider and event handlers in a client module. The Next.js guide shows the complete setup.
Desktop and native ambitions
An Electron renderer can potentially use the existing React web implementation, but there is no dedicated Electron integration verified by this site. React Native, Angular and direct CDN adapters are future directions, not currently shipped registries.
Platform-neutral palette and visual-token data are a foundation for future adapters. A native component will need its own rendering, interaction and accessibility implementation; web CSS cannot simply be reused as a native stylesheet.