Getting Started with Nextjs

A guide for installing Saas UI with Nextjs projects

Server components in the new app directory are currently not supported due to a limitation of Emotion.js. Client components are supported, you can enable this by adding 'use client'; at the top of the file.

More information

1. Installation#

In your Next.js project, install Saas UI by running either of the following:

npm i @saas-ui/react @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6
yarn add @saas-ui/react @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6

2. Provider Setup#

After installing Saas UI, you need to set up the SaasProvider at the root of your application. If you already have ChakraProvider in your app, you can replace this with SaasProvider.

Go to pages/_app.js or pages/_app.tsx (create it if it doesn't exist) and wrap the Component with the SaasProvider:

// pages/_app.js
import { SaasProvider } from '@saas-ui/react'
function MyApp({ Component, pageProps }) {
return (
<SaasProvider>
<Component {...pageProps} />
</SaasProvider>
)
}
export default MyApp

Configure a linkComponent to make the Saas UI Link work with the Next.js router.

import NextLink from 'next/link'
import { SaasProvider, LinkProps } from '@saas-ui/react'
const Link: React.FC<LinkProps> = (props) => {
return <NextLink {...props} legacyBehavior />
}
function MyApp({ Component, pageProps }) {
return (
<SaasProvider linkComponent={Link}>
<Component {...pageProps} />
</SaasProvider>
)
}

The legacyBehavior is only required for Next.js 13+.

4. Customizing Theme#

If you intend to customise the default theme object to match your design requirements, you can extend the theme from @chakra-ui/react.

Chakra UI provides an extendTheme function that deep merges the default theme with your customizations.

// 1. Import the extendTheme function
import { extendTheme } from '@chakra-ui/react'
// 2. Import the Saas UI theme
import { SaasProvider, theme as baseTheme } from '@saas-ui/react'
// 2. Extend the theme to include custom colors, fonts, etc
const colors = {
brand: {
900: '#1a365d',
800: '#153e75',
700: '#2a69ac',
},
}
const theme = extendTheme({ colors }, baseTheme)
// 3. Pass the `theme` prop to the `SaasProvider`
function MyApp({ Component, pageProps }) {
return (
<SaasProvider theme={theme}>
<Component {...pageProps} />
</SaasProvider>
)
}

To further customize components or build your own design system, the theme-tools package includes useful utilities.

6. Color Mode Script#

The color mode script needs to be added before the content inside the body tag for local storage syncing to work correctly.

When setting the initial color mode, we recommend adding it as a config to your theme and reference that in the ColorModeScript.

To use ColorModeScript on a site with strict Content-Security-Policy, you can use the nonce prop that will be passed to the <script> tag.

// pages/_document.js
import { ColorModeScript } from '@chakra-ui/react'
import NextDocument, { Html, Head, Main, NextScript } from 'next/document'
import theme from './theme'
export default class Document extends NextDocument {
render() {
return (
<Html lang="en">
<Head />
<body>
{/* 👇 Here's the script */}
<ColorModeScript initialColorMode={theme.config.initialColorMode} />
<Main />
<NextScript />
</body>
</Html>
)
}
}

Notes on TypeScript 🚨#

Please note that when adding Chakra UI to a TypeScript project, a minimum TypeScript version of 4.1.0 is required.

Was this helpful?