# css-plugin-darkmode

> parse css into darkmode

Latest version **0.1.6** (published 2019-11-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install css-plugin-darkmode
pnpm add css-plugin-darkmode
yarn add css-plugin-darkmode
bun add css-plugin-darkmode
```

## 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.6 |
| Published | 2019-11-08 |
| First published | 2019-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | fwon |
| Maintainers | fwon |
| Keywords | darkmode, css |

## Links

- npm: https://www.npmjs.com/package/css-plugin-darkmode
- Repository: https://github.com/fwon/css-plugin-darkmode
- Homepage: https://github.com/fwon/css-plugin-darkmode#readme
- Issues: https://github.com/fwon/css-plugin-darkmode/issues
- npm.io page: https://npm.io/package/css-plugin-darkmode

## Dependencies (1)

- [gonzales-pe](https://npm.io/package/gonzales-pe.md) ^4.2.4

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 0.1.6 (latest) — 2019-11-08
- 0.1.5 — 2019-11-06
- 0.1.4 — 2019-11-06
- 0.1.3 — 2019-11-06
- 0.1.2 — 2019-11-06
- 0.1.1 — 2019-11-06
- 0.1.0 — 2019-11-05

## README

## css-plugin-darkmode

A Preprocessor Plugin for CSS DSL(Less, Sass, SCSS).
Write darkmode css as comments in one place, will be transformed to darkmode media;
### Basic
Write comments using `dm[]` in css which you want to add darkmode media, like
```css
.selector {
  /* dm[color: #fff] */
}
```
can be transformed into media like
```css
@media (prefers-color-scheme: dark) {
  .selector {
    color: #fff
  }
}
```
### Examples
#### 1. CSS
**Before**
```css
:root {
  --color1: #987786;
  --dm__color1: #fff;
}

body {
  font-size: 14px;
  /* dm[color: #888;background-color: #fff;] */
}
.class1 {
  width: 100px;
  color: var(--color1);
  /* dm[color: var(--dm__color1);] */
}
.class1 .class2, .class1 .class3 {
  background-color: #ddd;
  /* dm[ background-color: #888;] */
}
```
**After**
```css
:root {
  --color1: #987786;
  --dm__color1: #fff;
}

body {
  font-size: 14px;
}
.class1 {
  width: 100px;
  color: var(--color1);
}
.class1 .class2, .class1 .class3 {
  background-color: #ddd;
}
/********** Added By CSS-Plugin-Darkmode **********/
@media (prefers-color-scheme: dark) {
  body {
    color: #888;
    background-color: #fff;
  }
  .class1 {
    color: var(--dm__color1);
  }
  .class1 .class2,
  .class1 .class3 {
    background-color: #888;
  }
}
```
#### 2. Less
**Before**
```less
@color1: #987786;
@__dm__color1: #fff;

body {
  font-size: 14px;
  /* dm[color: #888;background-color: #fff;] */
}
.class1 {
  width: 100px;
  color: @color1;
  /* dm[color: @__dm__color1;] */
  .class2, .class3 {
    background-color: #ddd;
    /* dm[background-color: #888;] */
    /* dm[background-image:url('base64:abcd');] */
  }
}
```
**After**
```less
@color1: #987786;
@__dm__color1: #fff;

body {
  font-size: 14px;
}
.class1 {
  width: 100px;
  color: @color1;
  .class2, .class3 {
    background-color: #ddd;
  }
}
/********** Added By CSS-Plugin-Darkmode **********/
@media (prefers-color-scheme: dark) {
  body {
    color: #888;
    background-color: #fff;
  }
  .class1 {
    color: @__dm__color1;
    .class2, .class3 {
      background-color: #888;
      background-image: url('base64:abcd');
    }
  }
}

```

### Usage
#### Webpack
```js
const CSSDarkModePlugin = require('css-plugin-darkmode');
...
rules: [
  {
    test: /\.less$/,
    use: [
      {
        loader: 'style-loader'
      },
      {
        loader: 'css-loader'
      },
      {
        loader: 'less-loader',
        options: {
          plugins: [
            new CSSDarkModePlugin() // Use plugin here
          ]
        }
      }
    ]
  }
]
...
```
#### Grunt
```js
const CSSDarkModePlugin = require('css-plugin-darkmode');
...
less: {
  production: {
    options: {
      paths: ['styles/'],
      plugins: [
        new CSSDarkModePlugin() // Use plugin here
      ]
    },
    files: {
      '../dist/style.css': 'styles/style.less'
    }
  }
}
...
```
#### Node (API)
```js
const CSSDarkModeParser = require('css-plugin-darkmode').Parser;
const cssDarkmode = CSSDarkModeParser(css, {
  syntax: 'less' // less|css|sass|scss
})
```

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