@designbycode/tailwindcss-text-stroke

中文文档
1.3.0发布于 2024/11/22MITTypeScriptESM + CJS零依赖近 30 天下载 6132

用于中风的尾风工具

中文使用文档
文档目录12 节
  1. 尾风 CSS 文本插件
  2. 目录
  3. 安装
  4. 设置
  5. 使用
  6. 示例
  7. 带有修饰符
  8. 捐款
  9. 许可证
  10. 作者
  11. 克劳德·米堡
  12. 承认
Title banner

尾风 CSS 文本插件

npm version npm NPM npm bundle size ts GitHub stars

NPM

使用此插件在您的 Tailwind CSS 工程中添加自定义文本中键功能 。 它允许您使用基于 WebKit 的浏览器支持的 CSS 属性在文本周围应用类似大纲的中键 .

目录

安装

要使用此插件, 您需要通过 pnpm, npm 或纱线安装 .

使用 pnpm

pnpm add @designbycode/tailwindcss-text-stroke

使用 npm

npm install @designbycode/tailwindcss-text-stroke

使用线条

yarn add @designbycode/tailwindcss-text-stroke

首先,确保您在您的项目中安装了 Tailwind CSS 。 如果没有,则按照正式文件安装.

下一步,需要您 Tailwind CSS 配置文件中的插件(通常命名为尾风.config.js) .

设置

  1. 首先,确保您在您的项目中安装了 Tailwind CSS 。 如果没有,则按照正式文件安装.

  2. 下一步,需要您 Tailwind CSS 配置文件中的插件(通常命名为尾风.config.js) .

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

一旦您需要插件并添加到插件阵列中,您就可以在您的 HTML 模板中使用新的文本中键工具.

使用

Text Stroke 插件为具有中风效果的文本样式提供以下工具类:

  • .text-stroke: 设置默认文本中键样式的基础组件。 您可以使用 CSS 变量来覆盖这些样式 .
  • .text-stroke-{value}: 将中风宽度设置为指定的 {value}。 可用的选项在文本StrokeWidth主题配置中定义.
  • .text-stroke-{color}: 将自定义颜色应用到文本中键上. {color} 应匹配您 Tailwind CSS 彩色调色板中的颜色 .
  • .text-stroke-fill-{color}: 将自定义的填充颜色应用到文本中键上。 {color} 应匹配您 Tailwind CSS 彩色调色板中的颜色 .

示例

以下是您如何使用工具类应用图像口罩的例子:

<h1 class="text-7xl font-black text-stroke ">
    Hello, TailwindCSS
</h1>

带有修饰符

<h1 class="text-7xl font-black text-stroke text-stroke-indigo-200 text-stroke-fill-indigo-600">
    Hello, TailwindCSS
</h1>

捐款

欢迎为此插件贡献 ! 如果遇到任何问题,有特性请求,或想要改进插件,可以随意创建拉出请求,或在GitHub寄存器上提交问题.

许可证

本项目根据以下规定获得许可证: 麻省理工学院 驾照 - 看 自由主义 详细文件.

作者

Claude Myburgh

克劳德·米堡

承认

  • 这个插件的灵感来自使用Tailwind CSS的网页开发者的需求.
  • 特别感谢Tailwind CSS团队创造了这样一个惊人的框架.

版本与发布记录

@designbycode/tailwindcss-text-stroke 共发布 7 个版本,首次发布于 2023/08/05;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.3.0latest2024/11/222 年前
1.2.12023/08/113 年前
1.2.02023/08/113 年前
1.1.22023/08/083 年前
1.1.12023/08/083 年前
1.0.12023/08/053 年前

关于 @designbycode/tailwindcss-text-stroke 的常见问题

@designbycode/tailwindcss-text-stroke 是什么?

用于中风的尾风工具

如何安装 @designbycode/tailwindcss-text-stroke?

在项目目录运行 npm install @designbycode/tailwindcss-text-stroke,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:tailwindcss(>=3.0.0 || >=3.0.0-alpha.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@designbycode/tailwindcss-text-stroke 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@designbycode/tailwindcss-text-stroke 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@designbycode/tailwindcss-text-stroke 可以商用吗?

@designbycode/tailwindcss-text-stroke 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@designbycode/tailwindcss-text-stroke 的下载量有多少?

根据 npm 官方下载统计,@designbycode/tailwindcss-text-stroke 在 2026/10/12 – 2026/11/10 这 30 天内被下载 6,132 次,日均约 204 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@designbycode/tailwindcss-text-stroke 还在维护吗?

最新版本 1.3.0 发布于 2024/11/22(2 年前);至今共发布 7 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/08/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。