Blame view

node_modules/postcss-modules-scope/README.md 2.25 KB
aaac7fed   liuqimichale   add
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
  # CSS Modules: Scope Locals & Extend
  
  [![Build Status](https://travis-ci.org/css-modules/postcss-modules-scope.svg?branch=master)](https://travis-ci.org/css-modules/postcss-modules-scope)
  
  Transforms:
  
  ```css
  :local(.continueButton) {
    color: green;
  }
  ```
  
  into:
  
  ```css
  :export {
    continueButton: __buttons_continueButton_djd347adcxz9;
  }
  .__buttons_continueButton_djd347adcxz9 {
    color: green;
  }
  ```
  
  so it doesn't pollute CSS global scope and can be simply used in JS like so:
  
  ```js
  import styles from './buttons.css'
  elem.innerHTML = `<button class="${styles.continueButton}">Continue</button>`
  ```
  
  ## Composition
  
  Since we're exporting class names, there's no reason to export only one. This can give us some really useful reuse of styles:
  
  ```css
  .globalButtonStyle {
    background: white;
    border: 1px solid;
    border-radius: 0.25rem;
  }
  .globalButtonStyle:hover {
    box-shadow: 0 0 4px -2px;
  }
  :local(.continueButton) {
    compose-with: globalButtonStyle;
    color: green;
  }
  ```
  
  becomes:
  
  ```
  .globalButtonStyle {
    background: white;
    border: 1px solid;
    border-radius: 0.25rem;
  }
  .globalButtonStyle:hover {
    box-shadow: 0 0 4px -2px;
  }
  :local(.continueButton) {
    compose-with: globalButtonStyle;
    color: green;
  }
  ```
  
  **Note:** you can also use `composes` as a shorthand for `compose-with`
  
  ## Local-by-default & reuse across files
  
  You're looking for [CSS Modules](https://github.com/css-modules/css-modules). It uses this plugin as well as a few others, and it's amazing.
  
  ## Building
  
  ```
  npm install
  npm test
  ```
  
  [![Build Status](https://travis-ci.org/css-modules/postcss-modules-scope.svg?branch=master)](https://travis-ci.org/css-modules/postcss-modules-scope)
  
  * Lines: [![Coverage Status](https://coveralls.io/repos/css-modules/postcss-modules-scope/badge.svg?branch=master)](https://coveralls.io/r/css-modules/postcss-modules-scope?branch=master)
  * Statements: [![codecov.io](http://codecov.io/github/css-modules/postcss-modules-scope/coverage.svg?branch=master)](http://codecov.io/github/css-modules/postcss-modules-scope?branch=master)
  
  ## Development
  
  - `npm autotest` will watch `src` and `test` for changes and run the tests, and transpile the ES6 to ES5 on success
  
  ## License
  
  ISC
  
  ## With thanks
  
  - Mark Dalgleish
  - Tobias Koppers
  - Guy Bedford
  
  ---
  Glen Maddern, 2015.