@zeit/next-sass NPM

Next.js + Sass

Import .sass or .scss files in your Next.js project

Installation

npm install --save @zeit/next-sass node-sass

yarn add @zeit/next-sass node-sass

Usage

The stylesheet is compiled to .next/static/css. Next.js will automatically add the css file to the HTML. In production a chunk hash is added so that styles are updated when a new version of the stylesheet is deployed.

Without CSS modules

Create a next.config.js in your project

// next.config.js
const withSass = require('@zeit/next-sass')
module.exports = withSass()

Create a Sass file styles.scss

$font-size: 50px;
.example {
  font-size: $font-size;
}

Create a page file pages/index.js

import "../styles.scss"

export default () => <div className="example">Hello World!</div>

With CSS modules

// next.config.js
const withSass = require('@zeit/next-sass')
module.exports = withSass({
  cssModules: true
})

Create a Sass file styles.scss

$font-size: 50px;
.example {
  font-size: $font-size;
}

Create a page file pages/index.js

import css from "../styles.scss"

export default () => <div className={css.example}>Hello World!</div>

With CSS modules and options

You can also pass a list of options to the css-loader by passing an object called cssLoaderOptions.

For instance, to enable locally scoped CSS modules, you can write:

// next.config.js
const withSass = require('@zeit/next-sass')
module.exports = withSass({
  cssModules: true,
  cssLoaderOptions: {
    importLoaders: 1,
    localIdentName: "[local]___[hash:base64:5]",
  }
})

Create a SCSS file style.scss

.example {
  font-size: 50px;
}

Create a page file pages/index.js that imports your stylesheet and uses the hashed class name from the stylesheet

import css from "../style.scss"

const Component = props => {
  return (
    <div className={css.example}>
      ...
    </div>
  )
}

export default Component

Your exported HTML will then reflect locally scoped CSS class names.

For a list of supported options, refer to the webpack css-loader README.

With SASS loader options

You can pass options from node-sass

// next.config.js
const withSass = require('@zeit/next-sass')
module.exports = withSass({
  sassLoaderOptions: {
    includePaths: ["absolute/path/a", "absolute/path/b"]
  }
})

// ./pages/_document.js
import Document, { Head, Main, NextScript } from 'next/document'

export default class MyDocument extends Document {
  render() {
    return (
      <html>
        <Head>
          <link rel="stylesheet" href="/_next/static/style.css" />
        </Head>
        <body>
          <Main />
          <NextScript />
        </body>
      </html>
    )
  }
}

PostCSS plugins

Create a next.config.js in your project

// next.config.js
const withSass = require('@zeit/next-sass')
module.exports = withSass()

Create a postcss.config.js

module.exports = {
  plugins: {
    // Illustrational
    'postcss-css-variables': {}
  }
}

Create a CSS file styles.scss the CSS here is using the css-variables postcss plugin.

:root {
  --some-color: red;
}

.example {
  /* red */
  color: var(--some-color);
}

When postcss.config.js is not found postcss-loader will not be added and will not cause overhead.

You can also pass a list of options to the postcss-loader by passing an object called postcssLoaderOptions.

For example, to pass theme env variables to postcss-loader, you can write:

// next.config.js
const withSass = require('@zeit/next-sass')
module.exports = withSass({
  postcssLoaderOptions: {
    parser: true,
    config: {
      ctx: {
        theme: JSON.stringify(process.env.REACT_APP_THEME)
      }
    }
  }
})

Configuring Next.js

Optionally you can add your custom Next.js configuration as parameter

// next.config.js
const withSass = require('@zeit/next-sass')
module.exports = withSass({
  webpack(config, options) {
    return config
  }
})

@zeit/next-css sass-loader

@sprucelabs/spruce-skill flok jerrygreen.me nextjs-setup nextjs-speed-test deneme-button-deneme cirplus-frontend pops-app-sstv pops-kids-sstv pops-plus-web shelf-app-agent-assist @brudi/brudi-toolbox-next rootservercheck @next-zero/framework xr3-client @infinitebrahmanuniverse/nolb-_zei @everything-registry/sub-chunk-1072 syom terampilalpha with-apollo with-typescript-eslint-jest web-styleguide-next shopify-node-app scpdb-terminal speedruns mnra-scripts grommet-nextjs interactive_ca-ballot mixin-venuee mtm-docs kidjs lucas-app onesite propalt-smart-report-components proyecto_base next-aida next-starter-pack next-demo-yfl nextjs-argon-dashboard nextjs-material-dashboard nate-tv new-package-v3 react-booking sly-scripts soya-next-scripts uepay-ops uepay-ops-no-auth @aller/theming @base-cms/nextjs-web-bootstrap @brudi-toolbox/next @adhitiadarmawan/tmcomponents ts-next-helpers @etidbury/ts-next-helpers @nestacademy/design-system @ninetynine/create-next-boilerplate @mies-co/next-ant @mkplace/catalog-next @jeremybanks/speedruns @jsweb001/blog_blue_theme_01 @jsweb001/blog_blue_theme_02 @jsweb001/blog_carbon_white_theme @jsweb001/blog_gray_theme_01 @jsweb001/blog_gray_theme_02 @jsweb001/blog_green_theme_02 @jsweb001/blog_white_theme_01 @jsweb001/company_profile_light_blue_theme @jsweb001/school_green_theme_light_dashed @jsweb001/school_white_theme_light @jsweb001/school_white_theme_light_dashed @mooglee/core @proerd/nextpress @sprucelabs/sprucebot-skills-kit @remy/ffconf2018 animal-ui @therealcodekraft/kinow-frontend abc-teacher-report abc-ability-ui @yarnaimo/next-config character_creation dungeoncrawler bonde-public aqueduct-flood cannerio enavia-io-app-core-test

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago