File size: 3,454 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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
---
title: Using Chakra UI in Next.js (App)
description: A guide for installing Chakra UI with Next.js app directory
---
## Templates
Use one of the following templates to get started quickly. The templates are
configured correctly to use Chakra UI.
:::card-group
<ResourceCard
type="github"
title="Next.js app template"
url="https://github.com/chakra-ui/chakra-ui/tree/main/sandbox/next-app"
/>
<ResourceCard
type="github"
title="Next.js pages template"
url="https://github.com/chakra-ui/chakra-ui/tree/main/sandbox/next-pages"
/>
:::
## Installation
> The minimum node version required is Node.20.x
:::steps
### Install dependencies
```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
```
### Update tsconfig
If you're using TypeScript, you need to update the `compilerOptions` in the
tsconfig file to include the following options:
```json
{
"compilerOptions": {
"target": "ESNext",
"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.
### 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
```tsx title="app/layout.tsx" {1,6,8}
import { Provider } from "@/components/ui/provider"
export default function RootLayout(props: { children: React.ReactNode }) {
const { children } = props
return (
<html suppressHydrationWarning>
<body>
<Provider>{children}</Provider>
</body>
</html>
)
}
```
> Adding the `suppressHydrationWarning` prop to the `html` element is required
> to prevent the warning about the `next-themes` library.
### Optimize Bundle
We recommend using the `experimental.optimizePackageImports` feature in Next.js
to optimize your bundle size by loading only the modules that you are actually
using.
```tsx title="next.config.mjs" {3}
export default {
experimental: {
optimizePackageImports: ["@chakra-ui/react"],
},
}
```
This also helps to resolve warnings like:
```sh
[webpack.cache.PackFileCacheStrategy] Serializing big strings (xxxkiB)
```
### Hydration errors
If you see an error like this: **Hydration failed because the initial server
rendered HTML did not match the client**, and the error looks similar to:
```diff
+<div className="chakra-xxx">
-<style data-emotion="css-global xxx" data-s="">
```
This is caused by how Next.js hydrates Emotion CSS in `--turbo` mode. Please
remove the `--turbo` flag from your `dev` script in your `package.json` file.
```diff
- "dev": "next dev --turbo"
+ "dev": "next dev"
```
When this is fixed by the `Next.js` team, we'll update this guide.
### 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>
)
}
```
:::
|