Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/L-Blondy/tw-colors
Tailwind plugin to easily add multiple color themes to your projects.
https://github.com/L-Blondy/tw-colors
dark multiple-themes tailwind tailwindcss theme
Last synced: 1 day ago
JSON representation
Tailwind plugin to easily add multiple color themes to your projects.
- Host: GitHub
- URL: https://github.com/L-Blondy/tw-colors
- Owner: L-Blondy
- License: mit
- Created: 2022-11-16T18:37:09.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T12:41:01.000Z (20 days ago)
- Last Synced: 2024-09-06T02:23:04.171Z (19 days ago)
- Topics: dark, multiple-themes, tailwind, tailwindcss, theme
- Language: TypeScript
- Homepage:
- Size: 568 KB
- Stars: 422
- Watchers: 4
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [tw-colors](https://github.com/L-Blondy/tw-colors)
Introducing the ultimate game-changer for your Tailwind app! Say goodbye to cluttered dark variants and messy CSS variables. With this tailwind plugin, switching between color themes is as effortless as changing one className.
## Highlights
* 🚀 **Scalable**, add as many themes and colors as you want. There is no limit on the number of themes and color you can use
* 💫 **Flexible**, don't limit yourself to colors, with the built-in **variants** you can theme any css property
* ✨ **Easy to adopt**, no need to change your markup, it just works!
* 🤩 **Nested themes** are supported for complex use cases
* 🎯 **Full [Tailwind CSS Intellisense][tailwind-intellisense-url] support** 🔥🔥🔥
## Changelog
See the full [changelog here](https://github.com/L-Blondy/tw-colors/blob/master/CHANGELOG.md)
## Usage
```bash
npm i -D tw-colors
```
Take an existing tailwind config and move the colors in the `createThemes` plugin, giving it a name (e.g. light).
*tailwind.config.js*
```diff
+ const { createThemes } = require('tw-colors');
module.exports = {
content: ['./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}'],
theme: {
extends: {
- colors: {
- 'primary': 'steelblue',
- 'secondary': 'darkblue',
- 'brand': '#F3F3F3',
- // ...other colors
- }
},
},
plugins: [
+ createThemes({
+ light: {
+ 'primary': 'steelblue',
+ 'secondary': 'darkblue',
+ 'brand': '#F3F3F3',
+ // ...other colors
+ }
+ })
],
};
```
*💡 **tip:** you can use any color name as you usually do, not just the ones from the example. The same goes for the theme names.*
Apply `class='light'` or `data-theme='light'` anywhere in your app (the html or the body tag is a good spot for it)
*See the [options](https://github.com/L-Blondy/tw-colors#producethemeclass) to customize the className*
```diff
-
+
...
...
...
...
```
That's it, your site has a *light* theme!
### Adding more themes
*tailwind.config.js*
```diff
const { createThemes } = require('tw-colors');
module.exports = {
content: ['./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}'],
plugins: [
createThemes({
light: {
'primary': 'steelblue',
'secondary': 'darkblue',
'brand': '#F3F3F3',
},
+ dark: {
+ 'primary': 'turquoise',
+ 'secondary': 'tomato',
+ 'brand': '#4A4A4A',
+ },
+ forest: {
+ 'primary': '#2A9D8F',
+ 'secondary': '#E9C46A',
+ 'brand': '#264653',
+ },
+ winter: {
+ 'primary': 'hsl(45 39% 69%)',
+ 'secondary': 'rgb(120 210 50)',
+ 'brand': 'hsl(54 93% 96%)',
+ },
})
],
};
```
You now have a **light**, a **dark** and a **forest** theme!
### Switching themes
Simply switch the *class* or the *data-theme* attribute
```diff
-
+
...
```
### Variants
Based on the current theme, specific styles can be applied using variants.
**Note:** In the following example the variants would have no effect with `data-theme='light'`
```html
...
Serif font here
Click Me
```
*See the [options](https://github.com/L-Blondy/tw-colors#producethemevariant) to customize the variant name*
Caveat: group-{modifier}
Always use the group variant before the theme variant.
```html
...
❌ the group variant does not work
✅ the group variant works properly
```
### Nested themes
#### With data-theme
Just nest the themes...
```diff
...
...
...
```
#### With class
For [variants](https://github.com/L-Blondy/tw-colors#variants) to work properly in nested themes, an empty `data-theme` attribute must be added alongside the nested theme `class`
```diff
...
...
...
```
**Caveats:**
Do not set opacity in the color definition
When using nested themes, it is better not to provide a base opacity in your color definitions.
With this setup the *0.8* opacity defined on the primary color of the "parent" theme will be inherited by the "child" theme's primary color.
```js
createThemes({
parent: {
'primary': 'hsl(50 50% 50% / 0.8)', // don't do this, the default opacity will propagate to the child theme
'secondary': 'darkblue',
},
child: {
'primary': 'turquoise',
'secondary': 'tomato',
},
})
```
```html
Click me
...
```
Inherited properties
Inherited properties (e.g. "font-family") are inherited by **all descendants**, including nested themes.
In order to stop the propagation the base styles should be re-declared on nested themes
❌ Unexpected behavior
```html
...
✅ Serif is active
❌ Serif is still active, it got inherited from the parent theme
```
✅ Works as expected
```html
...
✅ Serif is active
✅ Sans is active
```
### CSS color-scheme
`createThemes` also accepts a function that exposes the `light` and `dark` functions. \
To apply the `color-scheme` CSS property, simply wrap a theme with `light` or `dark`."
See the [MDN docs][mdn-color-scheme] for more details on this feature.
*tailwind.config.js*
```js
createThemes(({ light, dark }) => ({
'winter': light({
'primary': 'steelblue',
'base': 'darkblue',
'surface': '#F3F3F3',
}),
'forest': dark({
'primary': 'turquoise',
'base': 'tomato',
'surface': '#4A4A4A',
}),
}))
```
### CSS Variables
**tw-colors** creates CSS variables using the format `--twc-[color name]` by default, they contain HSL values.
For example, with the following configuration, the variables `--twc-primary`, `--twc-base`, `--twc-surface` will be created.
*tailwind.config.js*
```js
module.exports = {
// ...your tailwind config
plugins: [
createThemes({
'winter': {
'primary': 'steelblue',
'base': 'darkblue',
'surface': '#F3F3F3',
},
'forest': {
'primary': 'turquoise',
'base': 'tomato',
'surface': '#4A4A4A',
},
})
],
};
```
Example usage:
```css
.my-class {
color: hsl(var(--twc-primary));
background: hsl(var(--twc-primary) / 0.5);
}
```
*See the [options](https://github.com/L-Blondy/tw-colors#producecssvariable) to customize the css variables*
## Options
The options can be passed as the second argument to the plugin
```js
createThemes({
// your colors config here...
}, {
produceCssVariable: (colorName) => `--twc-${colorName}`,
produceThemeClass: (themeName) => `theme-${themeName}`
produceThemeVariant: (themeName) => `theme-${themeName}`
defaultTheme: 'light'
strict: false
})
```
### defaultTheme
The default theme to use, think of it as a fallback theme when no theme is declared.
**Example: simple default theme**
```js
createThemes({
'winter': {
'primary': 'steelblue',
},
'halloween': {
'primary': 'crimson',
},
}, {
defaultTheme: 'winter' // 'winter' | 'halloween'
})
```
The default theme can also be chosen according to the user *light* or *dark* preference (see [MDN prefers-color-scheme][mdn-prefers-color-scheme])
**Example: adapting to user preference**
```js
createThemes({
'winter': {
'primary': 'steelblue',
},
'halloween': {
'primary': 'crimson',
},
}, {
defaultTheme: {
/**
* when `@media (prefers-color-scheme: light)` is matched,
* the default theme is the "winter" theme
*/
light: 'winter',
/**
* when `@media (prefers-color-scheme: dark)` is matched,
* the default theme is the "halloween" theme
*/
dark: 'halloween',
}
})
```
### strict
**default**: `false`
If `false` invalid colors are ignored. \
If `true` invalid colors produce an error.
*Example*
```js
createThemes({
'christmas': {
// invalid color
'primary': 'redish',
},
'darkula': {
'primary': 'crimson',
},
}, {
// an error will be thrown
strict: true
})
```
### produceCssVariable
**default**: (colorName) => \`--twc-${colorName}\`
Customize the css variables generated by the plugin.
With the below configuration, the following variables will be created:
* `--a-primary-z` (instead of *twc-primary*)
* `--a-secondary-z` (instead of *twc-secondary*)
* `--a-base-z` (instead of *twc-base*)
```js
createThemes({
'light': {
'primary': 'steelblue',
'secondary': 'darkblue',
'base': '#F3F3F3',
},
'dark': {
'primary': 'turquoise',
'secondary': 'tomato',
'base': '#4A4A4A',
},
}, {
produceCssVariable: (colorName) => `--a-${colorName}-z`
})
```
### produceThemeClass
**default**: (themeName) => themeName
Customize the classNames of the themes and variants
With the below configuration, the following theme classNames and variants will be created:
* `theme-light` (instead of *light*)
* `theme-dark` (instead of *dark*)
```js
createThemes({
'light': {
'primary': 'steelblue',
'secondary': 'darkblue',
'base': '#F3F3F3',
},
'dark': {
'primary': 'turquoise',
'secondary': 'tomato',
'base': '#4A4A4A',
},
}, {
produceThemeClass: (themeName) => `theme-${themeName}`
})
```
```html
...
Click Me
...
```
### produceThemeVariant
**default**: same as `produceThemeClass`
Customize the variants
With the below configuration, the following variants will be created:
* `theme-light` (instead of *light*)
* `theme-dark` (instead of *dark*)
```js
createThemes({
'light': {
'primary': 'steelblue',
'secondary': 'darkblue',
'base': '#F3F3F3',
},
'dark': {
'primary': 'turquoise',
'secondary': 'tomato',
'base': '#4A4A4A',
},
}, {
produceThemeVariant: (themeName) => `theme-${themeName}`
})
```
```html
...
Click Me
...
```
## From the same Author
[up-fetch](https://github.com/L-Blondy/up-fetch): Tiny 1kb configuration tool for the fetch API with sensible default
Please share
[![][tweet]][tweet-url]
[tweet]: https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fsaadeghi%2Fdaisyui
[tweet-url]: https://twitter.com/intent/tweet?text=tw-colors%0ATailwind%20color%20themes%20made%20easy!%0Ahttps://github.com/L-Blondy/tw-colors
[tailwind-intellisense-url]: https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss
[mdn-color-scheme]: https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme
[mdn-prefers-color-scheme]: https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme