About this guide
This development guide walks you through everything you need to do to build a high-quality Next.js app integrated with Material UI. Check out the tasks below to get started. To save time, you can also use our boilerplate, which gives you a complete React codebase with all of these tasks done for you. Okay, let's dive in!
Tasks
Setup your Next.js app
Create a Next.js app usingnpx create-next-app
and then run your project locally with thenpm run dev
command.Server render Material UI styles with Next.js
You'll need to server-render your Material UI styles to avoid a flash of unstyled content before your client-side javascript loads. To do this you'll need to update your Next.jsDocument
component to extract component styles. After mount you'll then remove the server stylesheet so that the client can take over with style management.Ensure Material UI link components hook into Next.js routing
Make all Material UI link components hook into Next.js routing by wrapping them with theLink
component fromnext/link
and settingpassHref
to true.Create a persistent layout
Add any components that you'd like displayed across all pages (such asNavbar
andFooter
) to your Next.jsApp
component. If you need multiple persistent layouts you can instead have each page define its own layout. In that case, create multiple layout components (such asLandingPageLayout
andAdminLayout
) and wrap the contents of each page.Add a Material UI ThemeProvider
Add the Material UIThemeProvider
component so that you customize theme values. If your entire app uses the same theme (as opposed to different nested themes), then the best way to do this is update your Next.jsApp
component so thatThemeProvider
wraps all your pages.To support Add dark mode supportdark mode you'll need to define a light and dark Material UI theme object, read the user's preference from local storage on mount, fall back to their browser default using
prefers-color-scheme
, and pass the correct theme object toThemeProvider
. You'll also want to create auseDarkMode
React hook that any component can call to get/toggle the user's preference. Be sure to check out our example Material UI components with dark mode toggle.Build out the rest of your UI using Material UI components and composing them into high-level page sections, such as Finish your app UI with Material UI
HeroSection
andAccountSettings
. Use Material UI's CSS-in-JS solution for styling your components and overriding default component styles. You should find our library of pre-built Material UI components to be helpful.
Get the code
You can get the code for this guide with our Next.js and Material UI Boilerplate. You'll get a complete Next.js codebase with Material UI integration, all the tasks listed above done for you, and a responsive multi-page template. It should save you about two weeks of development time.
127 downloads today