v4.2.12

Usage with Next.js

Mantine is fully compatible with Next.js, follow following guide to setup your application

Get started with template

If you are starting new project you can skip all configuration steps and use Next.js template. To get started follow this link and create new repository. Alternatively you can download or clone repository to get started on your machine.

Adding to existing Next.js project

  1. Install @mantine/next
yarn add @mantine/next


npm install @mantine/next
  1. Create pages/_document.tsx file:
import { createGetInitialProps } from '@mantine/next';
import Document, { Head, Html, Main, NextScript } from 'next/document';


const getInitialProps = createGetInitialProps();


export default class _Document extends Document {
  static getInitialProps = getInitialProps;


  render() {
    return (
      <Html>
        <Head />
        <body>
          <Main />
          <NextScript />
        </body>
      </Html>
    );
  }
}
  1. (Optional) Replace your pages/_app.tsx with
import { AppProps } from 'next/app';
import Head from 'next/head';
import { MantineProvider } from '@mantine/core';


export default function App(props: AppProps) {
  const { Component, pageProps } = props;


  return (
    <>
      <Head>
        <title>Page title</title>
        <meta name="viewport" content="minimum-scale=1, initial-scale=1, width=device-width" />
      </Head>


      <MantineProvider
        withGlobalStyles
        withNormalizeCSS
        theme={{
          /** Put your mantine theme override here */
          colorScheme: 'light',
        }}
      >
        <Component {...pageProps} />
      </MantineProvider>
    </>
  );
}

Create your own getInitialProps

In some cases you would want to have access to getInitialProps in Next Document, to do so you will need to setup Mantine ssr styles extraction on your own:

import Document, { DocumentContext } from 'next/document';
import { ServerStyles, createStylesServer } from '@mantine/next';


const stylesServer = createStylesServer();


export default class _Document extends Document {
  static async getInitialProps(ctx: DocumentContext) {
    const initialProps = await Document.getInitialProps(ctx);


    // Add your app specific logic here


    return {
      ...initialProps,
      styles: [
        initialProps.styles,
        <ServerStyles html={initialProps.html} server={stylesServer} key="styles" />,
      ],
    };
  }
}

Mantine components with Next Link

You can use polymorphic components (Button, ActionIcon, Anchor, etc.) with Next Link, to do so:

  • set component prop to a
  • wrap it with Link
import Link from 'next/link';
import { Button } from '@mantine/core';


function Demo() {
  return (
    <Link href="/hello" passHref>
      <Button component="a">Next link button</Button>
    </Link>
  );
}
Go back
Server side rendering – Theming
Up next
Usage with Gatsby.js – Theming
Build fully functional accessible web applications faster than ever
About
ContributeMedia assetsChangelogReleases
Community
Chat on DiscordFollow on TwitterFollow on GithubGitHub discussions
Project
Mantine UIDocumentationGithub organizationnpm organization
Built by Vitaly Rtishchev and these awesome people
Join Discord community
Follow Mantine on Twitter