# @maa/monkey-css

> Import `.css` files in your Monkey.js project

Latest version **0.1.1** (published 2019-12-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @maa/monkey-css
pnpm add @maa/monkey-css
yarn add @maa/monkey-css
bun add @maa/monkey-css
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2019-12-22 |
| First published | 2019-12-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | zan |

## Links

- npm: https://www.npmjs.com/package/@maa/monkey-css
- npm.io page: https://npm.io/package/@maa/monkey-css

## Dependencies (6)

- [find-up](https://npm.io/package/find-up.md) ^4.1.0
- [css-loader](https://npm.io/package/css-loader.md) ^3.4.0
- [ignore-loader](https://npm.io/package/ignore-loader.md) ~0.1.2
- [postcss-loader](https://npm.io/package/postcss-loader.md) ^3.0.0
- [extract-css-chunks-webpack-plugin](https://npm.io/package/extract-css-chunks-webpack-plugin.md) ^4.7.1
- [optimize-css-assets-webpack-plugin](https://npm.io/package/optimize-css-assets-webpack-plugin.md) ^5.0.3

## Recent versions

- 0.1.1 (latest) — 2019-12-22
- 0.1.0 — 2019-12-22
- 0.0.2 — 2019-12-20
- 0.0.1 — 2019-12-18

## README

# Monkey.js + CSS

Import `.css` files in your Monkey.js project

## Installation

```
npm install --save @maa/monkey-css
```

or

```
yarn add @maa/monkey-css
```

## Usage

The stylesheet is compiled to `.next/static/css`. Monkey.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 the root of your project (next to pages/ and package.json)

```js
// next.config.js
const withCSS = require('@maa/monkey-css');
module.exports = withCSS({
	/* config options here */
});
```

Create a CSS file `style.css`

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

Create a page file `pages/index.js`

```js
import '../style.css';

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

### With CSS modules

```js
// next.config.js
const withCSS = require('@maa/monkey-css');
module.exports = withCSS({
	cssModules: true
});
```

Create a CSS file `style.css`

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

Create a page file `pages/index.js`

```js
import css from '../style.css';

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 withCSS = require('@maa/monkey-css');
module.exports = withCSS({
	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.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](https://github.com/webpack-contrib/css-loader#options).

### PostCSS plugins

Create a `next.config.js` in your project

```js
// next.config.js
const withCSS = require('@maa/monkey-css');
module.exports = withCSS({
	/* config options here */
});
```

Create a `postcss.config.js`

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

Create a CSS file `style.css` 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 withCSS = require('@maa/monkey-css');
module.exports = withCSS({
	postcssLoaderOptions: {
		parser: true,
		config: {
			ctx: {
				theme: JSON.stringify(process.env.REACT_APP_THEME)
			}
		}
	}
});
```

### Configuring Monkey.js

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

```js
// next.config.js
const withCSS = require('@maa/monkey-css');
module.exports = withCSS({
	webpack(config, options) {
		return config;
	}
});
```

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