summaryrefslogtreecommitdiff
path: root/node_modules/postcss-unroot/README.md
blob: c6a63d1c1a82d8b0c77f115e35be7c86a9934158 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# UnRoot [![Build Status][ci-img]][ci]

<img align="right" width="135" height="95" src="http://postcss.github.io/postcss/logo-leftp.png" title="Philosopher’s stone, logo of PostCSS">

[UnRoot] replaces selectors containing `:root` with `html`. This can be useful for outputting CSS for older browsers like Internet Explorer 8.

```css
/* before */

:root {
    background-color: black;
    color: white;
}

/* after */

html {
    background-color: black;
    color: white;
}
```

## Usage

Follow these steps to use [UnRoot].

Add [UnRoot] to your build tool:

```bash
npm install postcss-unroot --save-dev
```

#### Node

```js
require('postcss-unroot')({ /* options */ }).process(YOUR_CSS);
```

#### PostCSS

Add [PostCSS] to your build tool:

```bash
npm install postcss --save-dev
```

Load [UnRoot] as a PostCSS plugin:

```js
postcss([
    require('postcss-unroot')({ /* options */ })
]);
```

#### Gulp

Add [Gulp PostCSS] to your build tool:

```bash
npm install gulp-postcss --save-dev
```

Enable [UnRoot] within your Gulpfile:

```js
var postcss = require('gulp-postcss');

gulp.task('css', function () {
    return gulp.src('./css/src/*.css').pipe(
        postcss([
            require('postcss-unroot')({ /* options */ })
        ])
    ).pipe(
        gulp.dest('./css')
    );
});
```

#### Grunt

Add [Grunt PostCSS] to your build tool:

```bash
npm install grunt-postcss --save-dev
```

Enable [UnRoot] within your Gruntfile:

```js
grunt.loadNpmTasks('grunt-postcss');

grunt.initConfig({
    postcss: {
        options: {
            processors: [
                require('postcss-unroot')({ /* options */ })
            ]
        },
        dist: {
            src: 'css/*.css'
        }
    }
});
```

### Options

#### `method`

Type: `String`  
Default: `'replace'`

##### `replace`
Replace any selectors with `:root` with `html`.
```css
/* before */

:root {
    color: red;
}

/* after */

html {
    color: red;
}
```

##### `copy`
Copy any selectors with `:root` into a cloned rule as `html`.
```css
/* before */

:root {
    color: red;
}

/* after */

html {
    color: red;
}

:root {
    color: red;
}
```

##### `warn`
Warn when a `:root` selector is used.

[ci]: https://travis-ci.org/jonathantneal/postcss-unroot
[ci-img]: https://travis-ci.org/jonathantneal/postcss-unroot.svg
[Gulp PostCSS]: https://github.com/postcss/gulp-postcss
[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss
[PostCSS]: https://github.com/postcss/postcss
[UnRoot]: https://github.com/jonathantneal/postcss-unroot