postcss-modules-scope
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/postcss-modules-scope package

1.0.0 • Public • Published

CSS Modules: Scope Locals & Extend

Build Status

Transforms:

:local(.continueButton) {
  color: green;
}

into:

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

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:

.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. It uses this plugin as well as a few others, and it's amazing.

Building

npm install
npm test

Build Status

  • Lines: Coverage Status
  • Statements: codecov.io

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.

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
3.2.17,056,550latest
1.0.0-beta14beta
3.0.0-rc.21next

Version History

VersionDownloads (Last 7 Days)Published
3.2.17,056,550
3.2.03,537,546
3.1.22,660
3.1.1751,329
3.1.0149,792
3.0.04,338,098
3.0.0-rc.21
3.0.0-rc.12
3.0.0-rc.01
2.2.03,279,209
2.1.189,711
2.1.0141,143
2.0.114,315
2.0.02
1.1.01,236,190
1.0.26,291
1.0.15
1.0.071
1.0.0-beta21,491
1.0.0-beta14
0.0.82,554
0.0.711
0.0.62
0.0.51
0.0.41
0.0.34
0.0.21
0.0.12

Package Sidebar

Install

npm i postcss-modules-scope@1.0.0

Version

1.0.0

License

ISC

Last publish

Collaborators

  • markdalgleish
  • sokra
  • geelen
  • evilebottnawi