Installation
Using Panda CSS with Solid.js
Setting up Panda CSS in a Solid.js project using PostCSS.
Start a new project
Create Vite project
To get started, we will need to create a new SolidJS project using solidjs/templates/ts
template.
Install Panda
Install panda and create your panda.config.ts
file.
Update package.json scripts
Open your package.json
file and update the scripts
section as follows:
{
"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"
}
}
-
"prepare"
- script that will run Panda CSS CLI codegen before each build. Read more about codegen in the CLI section.💡This step ensures that the panda output directory is regenerated after each dependency installation. So you can add the output directory to your
.gitignore
file and not worry about it.
Configure the content
Make sure that all of the paths of your SolidJS components are included in the include
section of the panda.config.ts
file.
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: [],
// The output directory for your css system
outdir: "styled-system",
})
Configure the entry CSS with layers
Add this code to an src/index.css
file imported in the root component of your project.
@layer reset, base, tokens, recipes, utilities;
Note: Feel free to remove src/App.module.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.
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.
import type { Component } from 'solid-js';
import { css } from '../styled-system/css';
const App: Component = () => {
return (
<div class={css({ fontSize: "2xl", fontWeight: 'bold' })}>Hello 🐼!</div>
);
};
export default App;
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:
{
// ...
"include": ["src", "styled-system"]
}