File size: 2,646 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
---
title: Installation
description: How to install and set up Chakra UI in your project
---
## Framework Guide
Chakra UI works in your favorite framework. We've put together step-by-step
guides for these frameworks
:::card-group
<Card title="Next.js" href="/docs/get-started/frameworks/next-app" icon="nextjs">
Easily add Chakra UI with Next.js app
</Card>
<Card title="Vite" href="/docs/get-started/frameworks/vite" icon="vite">
Use Chakra UI with Vite
</Card>
<Card title="Stackblitz" href="https://stackblitz.com/edit/chakra-ui-v3" icon="stackblitz">
Try Chakra UI in Stackblitz sandbox
</Card>
:::
> The minimum node version required is Node.20.x
## Installation
To manually set up Chakra UI in your project, follow the steps below.
:::steps
### Install `@chakra-ui/react`
```bash
npm i @chakra-ui/react @emotion/react
```
### Add snippets
Snippets are pre-built components that you can use to build your UI faster.
Using the `@chakra-ui/cli` you can add snippets to your project.
```bash
npx @chakra-ui/cli snippet add
```
### Setup provider
Wrap your application with the `Provider` component generated in the
`components/ui/provider` component at the root of your application.
This provider composes the following:
- `ChakraProvider` from `@chakra-ui/react` for the styling system
- `ThemeProvider` from `next-themes` for color mode
```jsx
import { Provider } from "@/components/ui/provider"
function App({ Component, pageProps }) {
return (
<Provider>
<Component {...pageProps} />
</Provider>
)
}
```
### Update tsconfig
If you're using TypeScript, you need to update the `compilerOptions` in the
tsconfig file to include the following options:
```json
{
"compilerOptions": {
"module": "ESNext",
"moduleResolution": "Bundler",
"skipLibCheck": true,
"paths": {
"@/*": ["./src/*"]
}
}
}
```
> If you're using JavaScript, create a `jsconfig.json` file and add the above
> code to the file.
### Enjoy!
With the power of the snippets and the primitive components from Chakra UI, you
can build your UI faster.
```tsx
import { Button, HStack } from "@chakra-ui/react"
const Demo = () => {
return (
<HStack>
<Button>Click me</Button>
<Button>Click me</Button>
</HStack>
)
}
```
:::
## Learn
Watch our official courses and dive into dozens of videos that will teach you
everything you need to know about Chakra UI, from basics to advanced concepts.
## Contribute
Whether you're a beginner or advanced Chakra UI user, joining our community is
the best way to connect with like-minded people who build great products with
the library.
|