@designbycode/tailwindcss-mask-image weekly downloads statistics

<a href="#installation" width="100%"> <img src="banner.svg" alt="Title banner"/> </a>

Tailwind CSS Image Mask Plugin

The Tailwind CSS Image Mask Plugin is a custom plugin that extends Tailwind CSS with utilities for applying image masks using CSS gradients. With this plugin, you can easily create image masks with different directions and gradient styles.

📇 Table of Contents

• Installation
  • Using pnpm
  • Using npm
  • Using yarn
• Usage
• Utilities
• Applying Image Masks
• Default Values
• Changing Gradient Starting and Ending Points
  • Available percentage values for --mask-image-start and --mask-image-end:
• Configuration
• Example
• Contributing
• License
• Author
• Acknowledgments

Installation

To use this plugin, you need to install it via pnpm, npm or yarn.

Using pnpm

pnpm add @designbycode/tailwindcss-mask-image

Using npm

npm install @designbycode/tailwindcss-mask-image

Using yarn

yarn add @designbycode/tailwindcss-mask-image

Usage

Once the plugin is installed, you can enable it in your Tailwind CSS configuration file. Usually, this file is named tailwind.config.js.

module.exports = {
    // ...other configurations
    plugins: [
        // ...other plugins
        require("@designbycode/tailwindcss-mask-image"),
    ],
};

Utilities

The plugin generates several utility classes for applying image masks using CSS gradients. You can use these utility classes to easily apply masks to any element in your HTML.

Applying Image Masks

To make it work you only need to add the class of .mask-image-{value} to you html. The rest off the classes is just modifiers.

<div class="mask-image-r"></div>

You can apply image masks by using the following utility classes:

Css class name	Description
.mask-image-t	Applies a mask from top to bottom.
.mask-image-tr	Applies a mask from top left to bottom right.
.mask-image-tl	Applies a mask from top right to bottom left.
.mask-image-b	Applies a mask from bottom to top.
.mask-image-br	Applies a mask from bottom left to top right.
.mask-image-bl	Applies a mask from bottom right to top left.
.mask-image-r	Applies a mask from left to right.
.mask-image-l	Applies a mask from right to left.

Default Values

The plugin sets some default CSS variables in the :root element, which define the default values for the color and direction of the image masks.

Css Variable	Description
--mask-image-start-{value}	Default gradient starting point (default: 0%)
--mask-image-end-{value}	Default gradient ending point (default: 100%).

Changing Gradient Starting and Ending Points

You can dynamically change the starting and ending points of the gradient using the following utility classes:

• .mask-image-start-0 to .mask-image-start-100: Changes the --mask-image-start variable to the specified percentage value.

• .mask-image-end-0 to .mask-image-end-100: Changes the --mask-image-end variable to the specified percentage value.

<div class="mask-image-b mask-image-start-25 mask-image-end-75"></div>
<!-- or by arbitrary value -->
<div class="mask-image-[73%] mask-image-start-[33%] mask-image-end-[66%]"></div>

Available percentage values for --mask-image-start and --mask-image-end:

Key	Value	Output
0	"0%"	.mask-image-start-0
5	"5%"	.mask-image-start-5
10	"10%"	.mask-image-start-10
15	"15%"	.mask-image-start-15
20	"20%"	.mask-image-start-20
25	"25%"	.mask-image-start-25
30	"30%"	.mask-image-start-30
40	"40%"	.mask-image-start-40
45	"45%"	.mask-image-start-45
50	"50%"	.mask-image-start-50
55	"55%"	.mask-image-start-55
60	"60%"	.mask-image-start-60
70	"70%"	.mask-image-start-70
75	"75%"	.mask-image-start-75
80	"80%"	.mask-image-start-80
85	"85%"	.mask-image-start-85
90	"90%"	.mask-image-start-90
95	"95%"	.mask-image-start-95
100	"100%"	.mask-image-start-100

Configuration…