# @designbycode/tailwindcss-mask-image 中文文档
规范地址：https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/
版本：2\.0\.3
npm 元数据更新时间：2023-08-09T15:25:18.922Z
中文译文更新时间：2026-11-12T02:08:32.969Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40designbycode/tailwindcss-mask-image
原文对照：https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/?lang=original
项目主页：https://github.com/DesignByCode/tailwindcss-mask-image#readme
源码仓库：https://github.com/DesignByCode/tailwindcss-mask-image
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：15.8 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：tailwindcss \>=3\.0\.0 \|\| \>=3\.0\.0-alpha\.1
- 首次发布：2023-08-04T12:04:14.919Z
- 最新版本发布：2023-08-09T15:25:18.736Z
- 近 30 天下载量：3543（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）
## 中文简介
用于中风的尾风工具
## 安装
```sh
npm install @designbycode/tailwindcss-mask-image
```
也可以使用：`pnpm add @designbycode/tailwindcss-mask-image`、`yarn add @designbycode/tailwindcss-mask-image`、`bun add @designbycode/tailwindcss-mask-image`
## README
[](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-installation)
## 尾风 CSS 图像遮罩插件
[](https://badge.fury.io/js/@designbycode%2Ftailwindcss-mask-image)     [](https://github.com/DesignByCode/tailwindcss-mask-image/stargazers) [](http://hits.dwyl.com/designbycode/tailwindcss-mask-image)
[](https://nodei.co/npm/@designbycode/tailwindcss-mask-image/)
Tailwind CSS图像遮罩插件是一个自定义插件,可以将Tailwind CSS与使用CSS梯度应用图像遮罩的公用设备相扩展. 通过这个插件,可以轻松地创建出不同方向和梯度风格的图像口罩.
## 目录
- [安装](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-installation)
- [使用 pnpm](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-using-pnpm)
- [使用 npm](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-using-npm)
- [使用线条](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-using-yarn)
- [使用量](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-usage)
- [公用事业](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-utilities)
- [应用图像遮盖](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-applying-image-masks)
- [默认值](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-default-values)
- [改变渐变起止点](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-changing-gradient-starting-and-ending-points)
- [可用 --mask-image-start和 --mask-image-end的百分比值 :](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-available-percentage-values-for---mask-image-start-and---mask-image-end)
- [配置](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-configuration)
- [示例](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-example)
- [捐款](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-contributing)
- [许可证](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-license)
- [作者](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-author)
- [承认](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/#readme-acknowledgments)
## 安装
要使用此插件, 您需要通过 pnpm, npm 或纱线安装 .
#### 使用 pnpm
```bash
pnpm add @designbycode/tailwindcss-mask-image
```
#### 使用 npm
```bash
npm install @designbycode/tailwindcss-mask-image
```
#### 使用线条
```bash
yarn add @designbycode/tailwindcss-mask-image
```
## 使用量
插件安装后,可以在您的 Tailwind CSS 配置文件中启用. 通常,这个文件被命名为尾风. config.js.
```javascript
module.exports = {
// ...other configurations
plugins: [
// ...other plugins
require("@designbycode/tailwindcss-mask-image"),
],
};
```
## 公用事业
该插件为应用CSS梯度的图像口罩而生成了多个功能类. 您可以使用这些工具类来方便地将口罩应用到您的 HTML 中的任何元素中 .
## 应用图像遮盖
为了工作,你只需要增加一个班 `.mask-image-{value}` 给您 html。 课外休息只是修饰.
```html
```
您可以使用下列工具类应用图像口罩:
| Cs 类名称 | 说明 |
| --- | :-: |
| 任务图像t | 从上到下应用口罩. |
| .mask-image-tr (英语) | 从左上到右下应用口罩. |
| .mask-image-tl (英语) | 从右上到左下应用一个口罩. |
| 任务图像b | 从下到上应用口罩. |
| 任务图像- br | 从左下至右上方应用口罩. |
| .mask-image-bl 地图 | 从右下到左上方应用一个口罩. |
| 任务-图像-r | 使用从左到右的口罩. |
| 任务-图像-l | 使用从右到左的口罩. |
## 默认值
插件在:root元素中设置了一些默认的 CSS 变量,它定义了图像遮罩的颜色和方向的默认值.
| Css 变量 | 说明 |
| --- | :-: |
| \--mask-image- start-{value} 任务图像启动{值} | 默认渐变起点( 默认: 0) |
| \-- mask- image- end- { value} | 默认梯度结束点( 默认: 100%) . |
## 改变渐变起止点
您可以使用下列工具类来动态改变梯度的起始和结尾点:
- `.mask-image-start-0` 改为 `.mask-image-start-100`: 将 --mask-image-start 变量修改为指定的百分比值.
- `.mask-image-end-0 to` `.mask-image-end-100`: 将 --mask-image-end变量修改为指定的百分比值.
```html
```
#### 可用 --mask-image-start和 --mask-image-end的百分比值 :
| 密钥 | 数值 | 产出 |
| --- | :-: | :-- |
| 0 个 | (0%) | .mask-image-start-0 (英语) |
| 页:1 | "5%" (英语) | 任务图像启动-5 |
| 10个 | "10%" (中文(简体) ) | 任务图像启动 10 |
| 15个 | "15%" (英语) | 任务图像启动15 |
| 20国 | "20%" (中文(简体) ) | 任务图像启动 20 |
| 第25条 | "25%" (中文(简体) ) | 任务图像启动 25 |
| 30个 | "30%" (中文(简体) ) | 任务图像启动 30 |
| 第40条 | "40%" (韩语) | 任务图像启动- 40 |
| 第45条 | "45%" (英语) | 任务图像启动 45 |
| 第50条 | "50%" (中文(简体) ) | 任务图像启动- 50 |
| 第55条 | "55%" (中文(简体) ) | 任务图像启动55 |
| 页:1 | "60%" (韩语) | 任务图像启动- 60 |
| 70个 | "70%" (中文(简体) ) | 任务-图像-启动-70 |
| 第75条 | "75%" (英语) | .mask-image-start-75 (英语) |
| 80个 | "80%" (韩语) | 任务图像启动- 80 |
| 85个 | "85%" (韩语) | .mask-image-start-85 (英语) |
| 90 (韩语) | "90%" (中文(简体) ) | .mask-image-start-90 (英语) |
| 95 (韩语) | "95%" (英语) | .mask-image-start-95 (英语) |
| 100个 | "100%" (百分数) | 任务图像启动- 100 |
## 配置
该插件允许您通过修改您 Tailwind CSS 配置文件中的主题对象来自定义梯度步骤和方向 .
```javascript
// tailwind.config.js
module.exports = {
// ...other configurations
plugins: [
// ...other plugins
require("@designbycode/tailwindcss-mask-image"),
],
theme: {
imageMaskSteps: {
// Add your custom gradient steps here
0: "0%",
10: "10%",
25: "25%",
// ...
},
imageMaskDirections: {
// Add your custom mask directions here
t: "to top",
b: "to bottom",
// ...
},
},
};
```
## 示例
以下是您如何使用工具类应用图像口罩的例子:
```html
```
> **说明** 新建为v2. 开始和结束颜色不透明
### 开始和结束不透明颜色
可以设置起始和结尾颜色的不透明,以对口罩进行更多的控制.
```html
```
任意值从0到100不等,以更能控制口罩.
```html
```
## 捐款
欢迎为此插件贡献 ! 如果遇到任何问题,有特性请求,或想要改进插件,可以随意创建拉出请求,或在GitHub寄存器上提交问题.
## 许可证
本项目根据以下规定获得许可证: [麻省理工学院](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/LICENCE) 驾照 - 看 [自由主义](https://npmcn.com/package/%40designbycode/tailwindcss-mask-image/LICENCE) 详细文件.
## 作者
## 克劳德·米堡
- 吉图布: [@ dedesignbycode( 代号)](https://github.com/designbycode)
- 无 : [@ dedesignbycode (英语)](https://www.npmjs.com/~designbycode_)
## 承认
- 这个插件的灵感来自使用Tailwind CSS的网页开发者的需求.
- 特别感谢Tailwind CSS团队创造了这样一个惊人的框架.
## 常见问题
### @designbycode/tailwindcss-mask-image 是什么？
用于中风的尾风工具
### 如何安装 @designbycode/tailwindcss-mask-image？
在项目目录运行 npm install @designbycode/tailwindcss-mask-image，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：tailwindcss（\>=3\.0\.0 \|\| \>=3\.0\.0-alpha\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
### @designbycode/tailwindcss-mask-image 支持 TypeScript 吗？
该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/designbycode\_\_tailwindcss-mask-image 是否存在。
### @designbycode/tailwindcss-mask-image 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。
### @designbycode/tailwindcss-mask-image 可以商用吗？
@designbycode/tailwindcss-mask-image 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @designbycode/tailwindcss-mask-image 的下载量有多少？
根据 npm 官方下载统计，@designbycode/tailwindcss-mask-image 在 2026/10/12 – 2026/11/10 这 30 天内被下载 3,543 次，日均约 118 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @designbycode/tailwindcss-mask-image 还在维护吗？
最新版本 2\.0\.3 发布于 2023/08/09（3 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/08/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。