next-mui

v1.1.0

Published

4 years ago

Material-UI for Next.js

Downloads

0High
0Medium
0Low

shadowwalker1117

Material-UI for Next.js

Use Material-UI with Next.js server-side rendering app.

This plugin implement the method in these examples:

Usage

Add Dependencies

In your Next.js app, run

yarn add next-mui @material-ui/core @material-ui/styles

Custom App And Document

Following examples are written in typescript, next-mui also works out of box in javascript as needed.

pages/_app.tsx

import React from 'react'
import MUI from 'next-mui'
import { ThemeOptions } from '@material-ui/core/styles/createMuiTheme'
import App from 'next/app'

// Customized theme is optional
const theme: ThemeOptions = {
  typography: {
    useNextVariants: true,
    fontFamily: [
      '-apple-system',
      'BlinkMacSystemFont',
      'Microsoft YaHei',
      'Segoe UI',
      'Roboto',
      'Oxygen',
      'Ubuntu',
      'Cantarell',
      'Fira Sans',
      'Droid Sans',
      'Helvetica Neue',
      'sans-serif'
    ].join(',')
  }
}

export default class extends App {
  static async getInitialProps({ Component, ctx }) {
    let pageProps = {}

    if (Component.getInitialProps) {
      pageProps = await Component.getInitialProps(ctx)
    }

    return { pageProps }
  }

  render() {
    const { Component, pageProps } = this.props

    return (
      <Container>
      	<MUI theme={theme}>
	  <Component {...pageProps} />
        </MUI>
      </Container>
    )
  }
}

pages/_document.tsx

import React from 'react'
import Document, { Head, Main, NextScript } from 'next/document'
import { MuiStyles } from 'next-mui'

export default class extends Document {
  static async getInitialProps(ctx) {
    const page = ctx.renderPage()

    return {
      ...page,
      styles: <MuiStyles />
    }
  }

  render() {
    return (
      <html lang='en' dir='ltr'>
        <Head>
          <meta name='viewport' key='viewport' content='minimum-scale=1, initial-scale=1, width=device-width, shrink-to-fit=no, user-scalable=no' />
          <meta name='theme-color' key='theme-color' content='#FFFFFF' />
          <link rel='preload' href='https://fonts.googleapis.com/css?family=Roboto:300,400,500' as='style' />
      	  {/* <link rel='preload' href='https://fonts.googleapis.com/icon?family=Material+Icons' as='style' /> */}
        </Head>
        <body>
          <Main />
          <NextScript />
        </body>
      </html>
    )
  }
}

Create Material-UI Styled Component / Page

~~If you are using Material-UI V4 (alpha) styling solution, temporarily you have to import next-mui/bootstrap before everything else. More information.~~

import React from 'react'
import { withStyles } from '@material-ui/styles'
import Button from '@material-ui/core/Button'

const styles = {
  root: {
    background: 'linear-gradient(45deg, #FE6B8B 30%, #FF8E53 90%)',
    border: 0,
    borderRadius: 3,
    boxShadow: '0 3px 5px 2px rgba(255, 105, 135, .3)',
    color: 'white',
    height: 48,
    padding: '0 30px'
  }
}

type IProps = {
    // some props
} & WithStyles<typeof styles>

export default withStyles(styles)(({ classes }: IProps) => (
    <Button className={classes.root}>Higher-order component</Button>
))

API

MUI

Optional properties:

theme: object
- Object structure and default theme could be found here

MuiStyles

(No API)

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Material-UI for Next.js

Usage

Add Dependencies

Custom App And Document

Create Material-UI Styled Component / Page

API