db3ebd0df0 | ||
---|---|---|
.. | ||
lib | ||
.npmignore | ||
README.md | ||
package.json |
README.md
ICSS — Replace Symbols
Governs the way tokens are searched & replaced during the linking stage of ICSS loading.
This is broken into its own module in case the behaviour needs to be replicated in other PostCSS plugins (i.e. CSS Modules Constants)
API
import replaceSymbols from "icss-replace-symbols"
replaceSymbols(css, translations)
Where:
css
is the PostCSS tree you're working withtranslations
is an JS object ofsymbol: "replacement"
pairs, where all occurrences ofsymbol
are replaced withreplacement
.
Behaviour
A symbol is a string of alphanumeric, -
or _
characters. A replacement can be any string. They are replaced in the following places:
- In the value of a declaration, i.e.
color: my_symbol;
orbox-shadow: 0 0 blur spread shadow-color
- In a media expression i.e.
@media small {}
or@media screen and not-large {}
License
ISC
Glen Maddern, 2015.