Compatibility & Installation

Compatibility matrix

Stareezy UI is tested against the following framework versions in CI (both the lowest and highest end of each supported range):

Installation

# Next.js 14, 15, or 16
npm install @stareezy-ui/components @stareezy-ui/tokens @stareezy-ui/compiler
# or
pnpm add @stareezy-ui/components @stareezy-ui/tokens @stareezy-ui/compiler
# or
yarn add @stareezy-ui/components @stareezy-ui/tokens @stareezy-ui/compiler

// next.config.ts
import { stareezyVitePlugin } from '@stareezy-ui/compiler'
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  webpack(config) {
    config.plugins.push(stareezyVitePlugin())
    return config
  },
}
export default nextConfig

# Vite 4, 5, 6, or 7
npm install @stareezy-ui/components @stareezy-ui/tokens @stareezy-ui/compiler

// vite.config.ts
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import { stareezyVitePlugin } from '@stareezy-ui/compiler'

export default defineConfig({
  plugins: [
    react(),
    stareezyVitePlugin(),
  ],
})

// main.tsx — import the generated CSS once
import 'virtual:stareezy-ui/styles'

# Expo SDK 54, 55, or 56
yarn add @stareezy-ui/components @stareezy-ui/tokens @stareezy-ui/compiler

// metro.config.js
const { getDefaultConfig } = require('expo/metro-config')
const config = getDefaultConfig(__dirname)

config.transformer = {
  ...config.transformer,
  babelTransformerPath: require.resolve('@stareezy-ui/compiler/metro'),
}

module.exports = config

peerDependencies

All @stareezy-ui/* packages declare the following peerDependencies with optional flags where the peer is not required on all platforms:

// Declared across all packages:
{
  "peerDependencies": {
    "react":        "^18 || ^19",
    "react-dom":    "^18 || ^19",
    "react-native": ">=0.81 <0.87"
  },
  "peerDependenciesMeta": {
    "react-dom":    { "optional": true },
    "react-native": { "optional": true }
  }
}

react-dom is optional because React Native projects do not need it. react-native is optional because web-only (Vite / Next.js) projects do not need it.

Quick scaffolding with the CLI

Instead of wiring everything manually, use the CLI to scaffold a pre-wired project in one command:

npx stareezy create my-app --template next   # Next.js App Router
npx stareezy create my-app --template vite   # Vite + React
npx stareezy create my-app --template expo   # Expo SDK 55

See the CLI guide for details on the create, init, and add commands.

Version-specific notes