Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bradlc/tailwindcss-alpha
Automatic alpha variants for your Tailwind CSS colors
https://github.com/bradlc/tailwindcss-alpha
tailwind tailwindcss tailwindcss-plugin
Last synced: 6 days ago
JSON representation
Automatic alpha variants for your Tailwind CSS colors
- Host: GitHub
- URL: https://github.com/bradlc/tailwindcss-alpha
- Owner: bradlc
- Created: 2018-04-19T23:09:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-09T07:18:10.000Z (over 4 years ago)
- Last Synced: 2024-09-20T01:06:25.086Z (about 2 months ago)
- Topics: tailwind, tailwindcss, tailwindcss-plugin
- Language: JavaScript
- Size: 6.84 KB
- Stars: 70
- Watchers: 4
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tailwindcss-alpha
> Automatic alpha variants for your Tailwind CSS colors
## Why?
If you’re like me your Tailwind CSS color configuration often ends up looking something like this:
```js
module.exports = {
// ...
backgroundColors: {
red: '#f00',
'red-10': 'rgba(255, 0, 0, 0.1)',
'red-20': 'rgba(255, 0, 0, 0.2)',
'red-50': 'rgba(255, 0, 0, 0.5)',
'red-80': 'rgba(255, 0, 0, 0.8)'
// ...
}
// ...
}
```
`tailwindcss-alpha` automatically generates alpha variations for each of your background, text, and border colors.
## Install
```
npm install --save-dev tailwindcss-alpha
```
```js
// tailwind.js
module.exports = {
// ...
plugins: [
require('tailwindcss-alpha')({
modules: {
backgroundColors: true
},
alpha: {
'10': 0.1,
'30': 0.3
}
})
]
// ...
}
```
## Options
### `modules` (optional)
**Default:** `{ backgroundColors: true, textColors: false, borderColors: false }`
Here is where you define which Tailwind modules you would like to generate alpha variants for, and which state variants (responsive, hover, etc.) to generate for each. This option behaves in the same way as the [`modules` property in the main Tailwind configuration](https://tailwindcss.com/docs/configuration#modules), with one difference: a value of `true` means "inherit from the main Tailwind `modules` configuration."
### `alpha` (optional)
This is an object containing the alpha values for your new color utilities. If this is not specified in the plugin options the `alpha` property in your main Tailwind configuration will be used. If there is no `alpha` property then the `opacity` property is used.
The keys of this object appear at the end of the utility class names. For example if you have a background color with a key of `red` and an alpha with a key of `25` then a `bg-red-25` class would be generated.
## Example
```js
module.exports = {
// ...
backgroundColors: {
red: '#f00'
},
// ...
plugins: [
require('tailwindcss-alpha')({
modules: {
backgroundColors: []
},
alpha: {
'25': 0.25,
'50': 0.5,
'75': 0.75
}
})
]
// ...
}
```
The configuration above yields the following utilities:
```css
.bg-red-25 {
background-color: rgba(255, 0, 0, 0.25);
}
.bg-red-50 {
background-color: rgba(255, 0, 0, 0.5);
}
.bg-red-75 {
background-color: rgba(255, 0, 0, 0.75);
}
```