Skip to content

Want to skip the docs? Check out pandamastery.com - the best way to learn Panda CSS

Frameworks

Using Vite

Easily use Panda with Vite, React and Typescript with our dedicated integration.

This guide will show you how to set up Panda CSS in a Vite project using the @pandacss/vite plugin.

Prefer PostCSS? Run panda init --postcss instead of the plugin step below and follow Using PostCSS. Everything else on this page stays the same.

Start a new project

Create Vite project

To get started, we will need to create a new Vite project using react-ts template.

pnpm create vite test-app --template react-ts
cd test-app
pnpm install

Install Panda

Install panda, the Vite plugin, and create your panda.config.ts file.

pnpm install -D @pandacss/dev @pandacss/vite
pnpm panda init

Add the Vite plugin

Add pandacss() before your framework plugin. It generates the styled-system folder, injects the CSS, and keeps both up to date on save. No separate watcher needed.

vite.config.ts

import { defineConfig } from 'vite'
import pandacss from '@pandacss/vite'
import react from '@vitejs/plugin-react'
 
export default defineConfig({
  plugins: [pandacss(), react()]
})

Update package.json scripts

Open your package.json file and update the scripts section as follows:

package.json

{
  "scripts": {
+    "prepare": "panda codegen",
    "dev": "vite",
    "build": "tsc && vite build",
    "lint": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
    "preview": "vite preview"
  }
}

The plugin only runs with Vite. The "prepare" script covers tsc and your editor, which read styled-system before Vite starts, and lets the folder stay gitignored.

Configure the content

Make sure that all of the paths of your React components are included in the include section of the panda.config.ts file.

panda.config.ts

import { defineConfig } from '@pandacss/dev'
 
export default defineConfig({
  // Whether to use css reset
  preflight: true,
 
  // Where to look for your css declarations
  include: ['./src/**/*.{js,jsx,ts,tsx}', './pages/**/*.{js,jsx,ts,tsx}'],
 
  // Files to exclude
  exclude: [],
 
  // Generates JSX utilities with options of React, Preact, Qwik, Solid, Vue
  jsxFramework: 'react',
 
  // The output directory for your css system
  outdir: 'styled-system'
})

Configure CSS layers

Add this code to an src/index.css file imported in the root component of your project.

src/index.css

@layer reset, base, tokens, recipes, utilities;

This file only sets the layer order. The plugin injects the generated CSS for you.

💡

Note: Feel free to remove src/App.css file as we don't need it anymore, and make sure to remove the import from the src/App.tsx file.

Start your build process

Run the following command to start your development server.

pnpm dev

Start using Panda

Now you can start using Panda CSS in your project. Here is the snippet of code that you can use in your src/App.tsx file.

src/App.tsx

import { css } from '../styled-system/css'
 
function App() {
  return <div className={css({ fontSize: '2xl', fontWeight: 'bold' })}>Hello 🐼!</div>
}
 
export default App

Optional: drop the styling runtime

By default css() resolves class strings in the browser with a small runtime. Turn on source transforms and the plugin rewrites static calls to plain class strings at build time, so the runtime never ships:

vite.config.ts

plugins: [pandacss({ transform: true }), react()]

Dynamic values keep their runtime form. See Source transforms.

Troubleshooting

If you're not getting import autocomplete in your IDE, you may need to include the styled-system directory in your tsconfig.json file:

tsconfig.json

{
  // ...
  "include": ["src", "styled-system"]
}
Edit this page on GitHubView as markdown
Last updated on