Grayscale
Tailwind CSS version
v2.1+
Utilities for applying grayscale filters to an element.
Default class reference
Class | Properties |
---|---|
grayscale-0 | —tw-grayscale: grayscale(0); |
grayscale | —tw-grayscale: grayscale(1); |
Usage
Use the grayscale
and grayscale-0
utilities alongside the filter
utility to whether an element should be rendered as grayscale or in full color.
<div class="filter grayscale ...">
<!-- ... -->
</div>
Responsive
To control an element’s grayscale filter at a specific breakpoint, add a {screen}:
prefix to any existing grayscale utility. For example, use md:grayscale-0
to apply the grayscale-0
utility at only medium screen sizes and above.
<div class="filter grayscale md:grayscale-0 ...">
<!-- ... -->
</div>
For more information about Tailwind’s responsive design features, check out the Responsive Design documentation.
Customizing
You can customize which grayscale
utilities are generated using the grayscale
key in the theme
section of your tailwind.config.js
file.
// tailwind.config.js
module.exports = {
theme: {
+ extend: {
+ grayscale: {
+ 50: '50%',
+ }
+ }
}
}
Learn more about customizing the default theme in the theme customization documentation.
Variants
By default, only responsive variants are generated for grayscale utilities.
You can control which variants are generated for the grayscale utilities by modifying the grayscale
property in the variants
section of your tailwind.config.js
file.
For example, this config will also generate hover and focus variants:
// tailwind.config.js
module.exports = {
variants: {
extend: {
// ...
+ grayscale: ['hover', 'focus'],
}
}
}
Disabling
If you don’t plan to use the grayscale utilities in your project, you can disable them entirely by setting the grayscale
property to false
in the corePlugins
section of your config file:
// tailwind.config.js
module.exports = {
corePlugins: {
// ...
+ grayscale: false,
}
}