@cypress-design/vue-icon

中文文档
3.4.0发布于 2026/10/25MITTypeScriptESM + CJS近 30 天下载 2.2万

bash npm install @cypress-design/vue-icon

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 导入
  4. 颜色

图标

安装

npm install @cypress-design/vue-icon

或者用纱线

yarn add @cypress-design/vue-icon

使用量

import Icon from '@cypress-design/vue-icon'

导入

装入此组件有两种方法:

使用您计划使用的每个图标的命名导入 . 一、导 言 建议 这种方法的原因是:

  • 是树可摇: 只有你使用的图标才会被捆绑起来
  • 您可以得到颜色道具的 TS 校验 : 如果没有颜色, 将在编辑器中显示 squigles
<script setup>
import { IconObjectBookCode } from '@cypress-design/vue-icon'
</script>

<template>
  <IconObjectBookCode />
</template>

导入默认值 Icon 组件并传递图标的名称。 它可能有用,但你应该避免它在生产,除非你知道你在做什么.

其优点是:

  • 允许快速浏览模板右侧可用的图标
  • 允许传递身份标识,并授权颜色和大小直至执行.

但也有缺点:

  • 它能防止树木发抖.
  • 它使用TypeScript来检查大小和颜色,但带有扭矩:
    • 如果所选图标的大小不可用,且可供另一个图标使用,则错误将出现在图标组件上,而不会出现在大小道具上.
<script setup>
import Icon from '@cypress-design/vue-icon'
</script>

<template>
  <Icon name="object-book-code" />
</template>

颜色

如果您需要更改图标的颜色 hover 或者说 focus 前缀这些字的道具.

在这里 strokeColor 将改变在徘徊 从indigo到玉

<script setup>
import { IconObjectBook } from '@cypress-design/vue-icon'
</script>

<template>
  <button class="flex items-center gap-[8px]">
    <IconObjectBook
      size="16"
      strokeColor="blue-600"
      hoverStrokeColor="jade-600"
    />Read
  </button>
</template>

如果你需要的话 hover 或者说 focus 要被触发到父组的效应, 使用 interactiveColorsOnGroup。 。 。 . 此道具会更改所有伪前缀为分组焦点而不是由图标本身所触发.

为了实现同样的目标,在WindiCSS中,我们将利用 group-hover: 改为 hover:。 。 。 .

<script setup>
import { IconObjectBook } from '@cypress-design/vue-icon'
</script>

<template>
  <button class="group flex items-center gap-[8px] hover:text-jade-800">
    <IconObjectBook
      size="16"
      strokeColor="blue-600"
      hoverStrokeColor="jade-600"
      interactiveColorsOnGroup
    />Read
  </button>
</template>

版本与发布记录

@cypress-design/vue-icon 共发布 143 个版本,首次发布于 2022/05/18;过去 12 个月发布了 15 个版本。

版本发布日期距今
3.4.0latest2026/10/2516 天前
3.3.22026/10/051 个月前
3.3.12026/09/112 个月前
3.3.02026/07/293 个月前
3.2.02026/07/223 个月前
3.1.02026/07/213 个月前

其他发布通道:next → 2.0.0-next.0。

关于 @cypress-design/vue-icon 的常见问题

@cypress-design/vue-icon 是什么?

bash npm install @cypress-design/vue-icon

如何安装 @cypress-design/vue-icon?

在项目目录运行 npm install @cypress-design/vue-icon,或使用 pnpm add / yarn add / bun add。

@cypress-design/vue-icon 支持 TypeScript 吗?

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

@cypress-design/vue-icon 支持 ESM 还是 CommonJS?

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

@cypress-design/vue-icon 可以商用吗?

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

@cypress-design/vue-icon 的下载量有多少?

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

@cypress-design/vue-icon 还在维护吗?

最新版本 3.4.0 发布于 2026/10/25(16 天前);至今共发布 143 个版本,其中过去 12 个月发布了 15 个;首次发布于 2022/05/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。