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

1.0.1 • 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.16,887,385latest
3.0.0-rc.23next
1.0.0-beta13beta

Version History

VersionDownloads (Last 7 Days)Published
3.2.16,887,385
3.2.03,503,690
3.1.22,893
3.1.1729,264
3.1.0140,433
3.0.04,249,554
3.0.0-rc.23
3.0.0-rc.13
3.0.0-rc.01
2.2.03,283,818
2.1.190,269
2.1.0130,548
2.0.111,830
2.0.02
1.1.01,195,709
1.0.25,958
1.0.16
1.0.085
1.0.0-beta21,429
1.0.0-beta13
0.0.82,094
0.0.79
0.0.62
0.0.51
0.0.41
0.0.34
0.0.23
0.0.11

Package Sidebar

Install

npm i postcss-modules-scope@1.0.1

Version

1.0.1

License

ISC

Last publish

Collaborators

  • markdalgleish
  • sokra
  • geelen
  • evilebottnawi