@reuse-sh/avatars

中文文档
0.0.4发布于 2026/11/02MITTypeScriptES Module零依赖构建来源已验证

头像与图像和首字母的回落,透明的徽章切割,和重叠组。

中文使用文档
文档目录6 节
  1. 原则
  2. 安装
  3. 浏览器
  4. 反应
  5. 文档
  6. 许可证

@reuse-sh /阿凡达

带有图像的化身,具有unicode识别的首字母,以及从图像中切割出来的徽章,而不是绘制的戒指。群组保持角色重叠的形状。

原则

这些是代码遵守的规则。对任何框架的适应也会保留它们。

  • 切,不要涂。 徽章和重叠是矢量剪辑通过化身,所以没有画环战斗的背景和边缘保持锐利在任何缩放。
  • 把首字母写在下面。 首字母显示,直到图像加载,如果失败则保持。
  • 用文字命名徽章。 徽章标签连接可访问名称,并且绘图保持装饰性。
  • 把文本当作文本。 名称、标签和图标以文本或节点的形式输入,永远不会被解析为HTML。
  • 从徽章上剪下尺寸。 计数为两位数或两位数以上时,将从徽章本身测量出一个胶囊切口。
  • 恢复主机。 Destroy还原了原始的内容、风格和听众。

安装

npm install @reuse-sh/avatars

浏览器

import { enhanceAvatar, createAvatarGroup } from "@reuse-sh/avatars";
import "@reuse-sh/avatars/styles.css";

const avatar = enhanceAvatar(avatarElement);
const group = createAvatarGroup(groupElement, { overlap: 12 });

反应

import { Avatar, AvatarGroup } from "@reuse-sh/avatars/react";
import "@reuse-sh/avatars/styles.css";

<AvatarGroup overlap={12}>
  <Avatar name="Alex Rivers" badge={{ type: "dot", label: "Online" }} />
  <Avatar name="Sam Field" badge={{
    type: "count", count: 128, label: "128 messages",
  }} />
</AvatarGroup>

文档

许可证

麻省理工学院

版本与发布记录

@reuse-sh/avatars 共发布 5 个版本,首次发布于 2026/11/02;过去 12 个月发布了 5 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.0.4latest2026/11/021 天前
0.0.32026/11/021 天前
0.0.22026/11/021 天前
0.0.12026/11/021 天前
0.0.0-stage2026/11/021 天前

关于 @reuse-sh/avatars 的常见问题

@reuse-sh/avatars 是什么?

头像与图像和首字母的回落,透明的徽章切割,和重叠组。

如何安装 @reuse-sh/avatars?

在项目目录运行 npm install @reuse-sh/avatars,或使用 pnpm add / yarn add / bun add。

@reuse-sh/avatars 支持 TypeScript 吗?

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

@reuse-sh/avatars 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@reuse-sh/avatars 可以商用吗?

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

@reuse-sh/avatars 还在维护吗?

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