# @zeit/next-less

> Import `.less` files in your Next.js project

Latest version **1.0.1** (published 2018-09-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @zeit/next-less
pnpm add @zeit/next-less
yarn add @zeit/next-less
bun add @zeit/next-less
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-09-20 |
| First published | 2018-01-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2668 |
| Maintainers | arunoda, codetheory, hharnisc, iamevilrabbit, igorklopov, jamo, javivelasco, joecohens, leo, matheuss, nkzawa, olliv, rauchg, timneutkens, tootallnate |

## Links

- npm: https://www.npmjs.com/package/@zeit/next-less
- Repository: https://github.com/zeit/next-plugins
- Homepage: https://github.com/zeit/next-plugins#readme
- Issues: https://github.com/zeit/next-plugins/issues
- npm.io page: https://npm.io/package/@zeit/next-less

## Dependencies (2)

- [less-loader](https://npm.io/package/less-loader.md) 4.1.0
- [@zeit/next-css](https://npm.io/package/@zeit/next-css.md) 1.0.1

## Recent versions

- 1.0.1 (latest) — 2018-09-20
- 0.3.1-canary.4 (canary) — 2019-02-25
- 1.0.2-canary.2 — 2018-11-14
- 1.0.2-canary.0 — 2018-10-22
- 0.3.1-canary.3 — 2018-09-20
- 1.0.0 — 2018-09-19
- 0.3.1-canary.2 — 2018-08-18
- 0.3.1-canary.1 — 2018-07-30
- 0.3.0 — 2018-05-09
- 0.2.0 — 2018-04-11
- 0.1.2 — 2018-03-22
- 0.1.1 — 2018-02-15
- 0.1.0 — 2018-02-15
- 0.0.9 — 2018-02-01
- 0.0.8 — 2018-01-30
- … 4 more at https://npm.io/package/@zeit/next-less/versions

## README

# Next.js + Less

Import `.less` files in your Next.js project

## Installation

```
npm install --save @zeit/next-less less
```

or

```
yarn add @zeit/next-less less
```

## 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

```js
// next.config.js
const withLess = require('@zeit/next-less')
module.exports = withLess()
```

Create a Less file `styles.less`

```less
@font-size: 50px;
.example {
  font-size: @font-size;
}
```

Create a page file `pages/index.js`

```js
import "../styles.less"

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

### With CSS modules

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

Create a Less file `styles.less`

```less
@font-size: 50px;
.example {
  font-size: @font-size;
}
```

Create a page file `pages/index.js`

```js
import css from "../styles.less"

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](https://github.com/css-modules/css-modules/blob/master/docs/local-scope.md#css-modules--local-scope), you can write:

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

Create a CSS file `styles.css`

```css
.example {
  font-size: 50px;
}
```

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

```js
import css from "../style.css"

const Component = props => {
  return (
    <div className={css.backdrop}>
      ...
    </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](https://github.com/webpack-contrib/css-loader#options).

```js
// ./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

```js
// next.config.js
const withLess = require('@zeit/next-less')
module.exports = withLess()
```

Create a `postcss.config.js`

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

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

```css
: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:

```js
// next.config.js
const withLess = require('@zeit/next-less')
module.exports = withLess({
  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

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

---
_Source: https://npm.io/package/@zeit/next-less · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._