跳到正文

图标 ​

UIKit 内置一套 SVG 图标体系,由 EmIcon 组件统一渲染。所有图标集中在 packages/uikit-core/src/assets/icons-v2/,命名与设计师 svg 文件名 1:1。面性图标放在 icons-v2/filled/,name 带 filled/ 前缀,目前主要用于在线状态等需要实心图形的场景。旧库 assets/icons/ 已整目录删除,V2 是唯一图标库。

不再依赖外部图标库兜底。

图标体系说明 ​

  • 渲染组件:EmIcon(全局注册为 <Icon />)。图标以 inline SVG 方式渲染,不依赖图片请求。
  • name 规则:name 与资源目录下的 <路径>.svg 文件一一对应。例如 chevron/down 对应 icons-v2/chevron/down.svg,filled/circle/empty 对应 icons-v2/filled/circle/empty.svg。构建时通过 import.meta.glob 自动注册,新增文件即生效,无需手工登记。
  • 着色:图标统一使用 currentColor(填充式 path fill="currentColor",描边式 path stroke="currentColor"),颜色跟随 CSS color,天然适配主题体系;也可通过 color prop 显式指定。SVG 源文件中禁止写死 fill="black" / stroke="black",否则深色模式下图标不会随主题反色。
  • 尺寸:通过 size prop 指定(单位 px,默认 20),SVG 原始 viewBox 会被保留,不会被裁切。
vue
<template>
  <!-- 基础用法 -->
  <Icon name="chevron/right" />
  <!-- 指定尺寸与颜色 -->
  <Icon name="trash" :size="18" color="var(--uikit-color-danger)" />
  <!-- 语义色 -->
  <Icon name="circle/bang" :size="16" type="danger" />
  <!-- 面性图标(在线状态示例) -->
  <Icon name="filled/circle/empty" :size="10" color="#6CE191" />
</template>

线性图标常见顶层分类包括:arrow(箭头)、audio-video(音视频)、bell(通知)、bubble(气泡)、camera(相机)、check(勾选)、chevron(折角箭头)、circle(圆圈状态)、console(控制台)、file(文件类型)、folder(文件夹)、mic(麦克风)、person(人员)、pin(置顶)、rect(矩形容器内的图形)、search(搜索)、shield(权限)、speaker(扬声器)、trash(删除)、xmark(关闭)等。

图标一览 ​

下方展示 UIKit 当前内置的全部 V2 SVG 图标,按目录分类排列,点击即可复制名称。

业务图标映射 ​

消息状态 ​

己方消息发送状态使用如下图标:

状态常量默认图标说明
发送中MESSAGE_STATUS.SENDINGloading/arc/normal旋转 loading
已发送MESSAGE_STATUS.SENTcircle/empty空心圆
已送达MESSAGE_STATUS.DELIVEREDcircle/empty空心圆
已读MESSAGE_STATUS.READcircle/checked圆圈内对勾
发送失败MESSAGE_STATUS.FAILEDcircle/bang圆圈内感叹号,可点击重发

PC 端发送失败图标 hover 时会放大 1.2 倍并切换为 ringarrow/cw(重发箭头);H5 直接点击感叹号触发重发。颜色上失败状态使用 --uikit-danger-color,已读状态使用 --uikit-primary-color,其余跟随 --uikit-text-secondary。

群聊已读回执激活时,状态区域会切换为「已读人数圆圈」:全部已读时显示 check/double 图标,否则显示已读人数数字。

在线状态 ​

PresenceSelector / PresenceAvatar 使用 filled/circle/* 面性 SVG 图标,颜色与多端常量对应:

状态常量值图标颜色变量默认色
在线Onlinefilled/circle/empty--uikit-presence-online-color#6CE191
离线Offlinefilled/circle/empty--uikit-presence-offline-color#454545
离开Awayfilled/circle/clock--uikit-presence-away-color#B9BBC5
忙碌Busyfilled/circle/equals--uikit-presence-busy-color#ED7587
勿扰Do Not Disturbfilled/circle/minus--uikit-presence-dnd-color#EE798C
自定义Customfilled/circle/star--uikit-presence-custom-color#F3C850

在线状态常量发布时须与多端保持一致:Online、Offline、Away、Busy、Do Not Disturb、Custom。

图标设计规范 ​

为保持图标库视觉一致,新增或替换 SVG 时请遵循以下规范:

维度规范说明
画布24×24 viewBox统一画布尺寸,保证不同图标在相同 size 下视觉权重一致
描边1.5px ~ 2px线性图标统一描边粗细,避免部分图标过细或过粗
端点圆角端点(round)保持整体圆润风格,与组件圆角体系呼应
转角圆角连接(round)拐角处不过于尖锐,符合现代 UI 风格
着色currentColor 唯一禁止写死 fill / stroke 色值,确保主题/暗色切换正常
命名目录/文件名 层级与 assets/icons-v2/<目录>/<文件>.svg 一一对应,语义清晰

已有图标若存在风格不一致(描边粗细、端点、画布),建议在设计侧统一走一遍规范后再批量替换。

操作图标交互约束 ​

业务中所有“操作类图标按钮”(关闭、返回、+、设置、编辑、删除等)必须统一使用 IconButton 组件,禁止自行用 <button> + <Icon> 实现。详细约束见:UIKIT UI 交互约束。

核心原则:

  • 关闭按钮统一使用 xmark/light,由 Popup 的 show-close 或 IconButton 渲染。
  • 返回按钮统一使用 chevron/left。
  • 添加按钮统一使用 plus。
  • 默认 variant="ghost"、size="small",统一圆角背景 hover,不手写 hover 样式。

覆盖与新增图标 ​

替换已有图标:直接用同名 SVG 文件覆盖 packages/uikit-core/src/assets/icons-v2/<路径>.svg 即可,所有 name 引用不变,无需改动任何业务代码。面性图标放在 icons-v2/filled/<目录>/。建议使用 24×24 viewBox、currentColor 着色的 SVG,以保证与主题体系一致。

新增图标:

  1. 线性图标放入 packages/uikit-core/src/assets/icons-v2/<目录>/(目录层级即 name 前缀);
  2. 面性图标放入 packages/uikit-core/src/assets/icons-v2/filled/<目录>/(name 自动带 filled/ 前缀);
  3. 在代码中通过 <Icon name="目录/文件名" /> 引用即可。

构建时会自动执行 icons:check 校验:扫描源码中所有图标 name 引用并与图标库文件比对,引用不存在的图标会导致构建失败并列出缺失清单,避免图标静默不渲染。也可单独执行:

bash
pnpm -F @easemob-community/uikit-im run icons:check

许可与免责声明 ​

本 UIKit 内置图标来源为设计师交付的线性图标集。当您自行替换或新增图标时,须自行确保对所用图标素材拥有合法的使用权(包括但不限于版权授权、商标许可);本项目不对用户自备素材的版权合规性承担任何责任。