https://github.com/intuit/postcss-themed
A PostCSS plugin for generating themes.
https://github.com/intuit/postcss-themed
hacktoberfest
Last synced: 9 months ago
JSON representation
A PostCSS plugin for generating themes.
- Host: GitHub
- URL: https://github.com/intuit/postcss-themed
- Owner: intuit
- License: mit
- Created: 2019-11-07T19:18:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T22:01:32.000Z (12 months ago)
- Last Synced: 2025-05-07T22:35:10.692Z (10 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 904 KB
- Stars: 62
- Watchers: 7
- Forks: 30
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - postcss-themed
README
PostCSS plugin for adding multiple themes to CSS files.
Will create class overrides for legacy browsers and use CSS variables for modern browsers.
:rocket: Supports `light` and `dark` color schemes
:rocket: Create component level themes
:rocket: Supports scoping CSS Variable names to mitigate conflicts
:rocket: Themes can extend other themes
[postcss]: https://github.com/postcss/postcss
## Contributing
We appreciate any and all pull requests!
### Setup
First install the dependencies.
```sh
yarn
```
Then write a test for your changes and run the test command! That's it!.
```sh
yarn test
```
## Usage
```js
const config = {
default: {
color: 'white',
},
other: {
color: 'black',
},
};
```
or for per theme `light` and `dark` modes:
```js
const config = {
default: {
light: {
color: 'white',
},
dark: {
color: 'black',
},
},
// Can still just have one level which defaults to light
other: {
color: 'purple',
},
more: {
light: {
color: 'red',
},
dark: {
color: 'blue',
},
},
};
```
```js
postcss([require('postcss-themed')({ config })]);
```
See [PostCSS] docs for examples for your environment.
### Using Theme Variables
**Input:**
```css
.foo {
color: @theme color;
border: @theme border-width solid @theme color;
}
/* OR */
.foo {
color: theme('color');
border: theme('border-width') solid theme('color');
}
```
**Output:**
```css
.foo {
color: white;
border: 1px solid white;
}
.other .foo {
color: black;
border: 10px solid black;
}
```
### Theming with Objects
You can even keep theme values in deeply nested objects.
**Input:**
```js
const config = {
default: {
colors: {
primary: 'white',
},
},
other: {
colors: {
primary: 'black',
},
},
};
```
```css
.foo {
color: @theme colors.primary;
}
```
**Output:**
```css
.foo {
color: white;
}
.other .foo {
color: black;
}
```
### Component themes
Define a component level theme in either commonjs or typescript. A file names `themes.(js|ts)` must be co-located with the themeable CSS file.
**themes.js:**
```js
module.exports = (theme) => ({
default: {
border: `1px solid ${theme.default.color}`
}
other: {
border: `1px solid ${theme.other.color}`
}
});
```
**themes.ts:**
```js
import { Theme } from '@your/themes';
const CardTheme = (theme: Theme): Theme => ({
default: {
border: '1px solid red',
},
other: {
border: `1px solid ${theme.other.color}`,
},
});
export default CardTheme;
```
or provide a function to locate the theme function
### Theme Resolution
By default this plugin will looks for a sibling `theme.js` or `theme.ts`. You can
customize the lookup behavior by supplying your own theme resolution function.
```js
postcss([
require('postcss-themed')({
config,
resolveTheme: (cssFileName) => {
// return a function like the ones above
},
}),
]);
```
Now you can use `@theme border` in your CSS file.
### Theme Extension
Any theme can extend another theme.
This is useful when you are defining a child theme that customizes some stuff but in general adopts most of the styling of another theme.
**Config:**
```js
const config = {
default: {
color: 'white',
background: 'black',
},
myTheme: {
color: 'purple',
background: 'green',
},
myChildTheme: {
extends: 'myTheme',
background: 'red',
},
};
```
**Input:**
```css
.test {
color: @theme color;
background: @theme background;
}
```
**Output:**
```css
.test {
color: var(--color, white);
background: var(--background, black);
}
.myTheme {
--color: purple;
--background: green;
}
.myChildTheme {
--color: purple;
--background: red;
}
```
### Theming Root class (LEGACY ONLY)
Only needed when targeting legacy environments that do not support CSS Variables.
**Input:**
```css
:theme-root(.foo) {
border: 1px solid @theme color;
}
```
or by nesting
**Input:**
```css
:theme-root {
&.foo {
border: 1px solid @theme color;
}
}
```
**Output:**
```css
.foo {
border: 1px solid white;
}
.foo.other {
border: 1px solid black;
}
```
## Options
### `modules`
This plugin also support scoping your CSS Variable names in a very similar way to CSS Modules. This option should be used when targeting browsers with css variables to avoid name collisions.
You can use any of the tokens listed [here](https://github.com/webpack/loader-utils#interpolatename) to create a scoped name.
The token `[local]` is also available which is the name of the original theme variable.
```js
postcss([
require('postcss-themed')({
config,
modules: '[folder]-[name]-[local]',
}),
]);
```
Another option is to use the default function for scoping variable names.
To use the default function:
```js
postcss([
require('postcss-themed')({
config,
modules: 'default',
}),
]);
```
The default function combines the filepath, name and hashed css into a single string and uses it as a variable name.
```js
const defaultLocalizeFunction = (
name: string,
filePath: string,
css: string
) => {
const hash = crypto.createHash('md5').update(css).digest('hex').slice(0, 6);
return `${filePath || 'default'}-${name}-${hash}`;
};
```
You can also supply your own function for scoping variable names, again following the API from CSS Modules. If PostCSS does not have a path for the file both the path and css will return an empty string.
```js
postcss([
require('postcss-themed')({
config,
modules: (name: string, filePath: string, css: string) => {
const hash = crypto
.createHash('sha1')
.update(css)
.digest('hex')
.slice(0, 3);
return `${filePath}-${name}-${hash}`;
},
}),
]);
```
### `defaultTheme`
An optional parameter to change the name of the _default_ theme (where no extra classes are added to the selector). It defaults to `default`, and also corresponds to the only required key in your `theme.ts` files.
### `lightClass` + `darkClass`
Classes to apply to color scheme overrides.
```js
postcss([
require('postcss-themed')({
config,
lightClass: '.light-theme',
darkClass: '.dark-theme',
}),
]);
```
### `forceEmptyThemeSelectors` - only legacy
By default this plugin will not produce class names for theme that have no component level configuration if there are no styles. (ex: you have 3 themes but your component only uses 1, then only 1 extra set of classnames is produced).
You can use the `forceEmptyThemeSelectors` to force these empty classes to be added. If you use this option you should also use some form of css minification that can get rid of the empty classes. If you don't your CSS will be bloated.
This feature is useful if your are converting your css-modules to typescript and need the generated typescript file to include all of the possible themes.
```js
postcss([
require('postcss-themed')({ config, forceEmptyThemeSelectors: true }),
]);
```
### `forceSingleTheme`
This is a niche option which only inserts a single theme.
At first glance, this may seem strange because this plugin primarily allows you to support _many_ themes in a _single_ CSS file.
This option helps if you want to generate _many_ CSS files, each with their own theme. You'll run PostCSS multiple times, switching the single theme.
In practice, we use this to generate extra CSS files for teams that only need a single theme. The main CSS file still has all of them, but teams can optionally use the one that only has the theme they need.
It is still recommended to set defaultTheme with this option, as any missing variables will be merged with the default.
**Config:**
```js
const config = {
default: {
light: {
color: 'purple',
},
dark: {
color: 'black',
},
},
chair: {
light: {
color: 'beige',
},
dark: {
color: 'dark-purple',
},
},
};
postcss([
require('postcss-themed')({
config,
defaultTheme: 'default',
forceSingleTheme: 'chair',
}),
]);
```
**Input:**
```css
.test {
color: @theme color;
}
```
**Output:**
```css
.test {
color: var(--color);
}
:root {
--color: beige;
}
.dark {
--color: dark-purple;
}
```
As you can see in the above example, only one theme will be generated using this option.
### `optimizeSingleTheme`
This option should only be used in conjunction with `forceSingleTheme`.
By default `forceSingleTheme` will always add CSS variables, since many users still want to be able to modify and override them.
However, if you are not going to be modifying them, we can optimize the single theme further by removing variables when possible.
If only a light theme is specified, this config option will just do in-place replacement of the theme variables.
**Config:**
```js
const config = {
default: {
color: 'purple',
},
chair: {
color: 'beige',
},
};
postcss([
require('postcss-themed')({
config,
defaultTheme: 'default',
forceSingleTheme: 'chair',
optimizeSingleTheme: true,
}),
]);
```
**Input:**
```css
.test {
color: @theme color;
}
```
**Output:**
```css
.test {
color: beige;
}
```
## Debug
This package uses the npm package [debug](https://www.npmjs.com/package/debug) to log errors while it's running.
Simply set the `DEBUG` environment variable to `postcss-themed`.
```sh
DEBUG=postcss-themed postcss input.css -o output.css
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Tyler Krupicka
💻 ⚠️ 📖
Andrew Lisowski
💻 ⚠️ 📖
Adam Dierkens
💻
Christy Jacob
💻 📖
Sharps
🎨
Amanda Yoshiizumi
🎨
Ratnamala Korlepara
⚠️ 📖
Enzo Zafra
💻 📖 🚇 ⚠️
Joshua Tymburski
⚠️ 💻
Kendall Gassner
⚠️ 💻
Kelly Harrop
💻 📖 ⚠️
yoqwerty
⚠️
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!