mcpField
S
syncfusion-javascript-avatar

syncfusion-javascript-avatar

github.com/syncfusion设计与 UI055 次安装6 天前更新
代码仓库

关于 syncfusion-javascript-avatar

面向使用 Syncfusion Avatar 的界面开发者,介绍用于展示用户形象的轻量组件。支持图片、SVG、图标和文字,并可调整形状、尺寸及颜色。

主要功能

  1. 01显示图片、SVG、图标或文字
  2. 02提供圆形与圆角矩形形状
  3. 03包含五种预设尺寸
  4. 04通过 CSS 类自定义颜色
  5. 05可与 Badge 和 ListView 组合
  6. 06尺寸随字体大小响应变化

适用场景

  1. 01在个人资料卡中展示头像
  2. 02在联系人列表中显示头像
  3. 03为头像添加通知徽标
  4. 04在聊天消息中标识发送者
  5. 05在团队网格中展示成员

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/syncfusion/javascript-ui-controls-skills --skill syncfusion-javascript-avatar

安装后在 Claude Code 中输入/syncfusion-javascript-avatar确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
avatar-in-listview.md
avatar-types-and-sizes.md
avatar-with-badge.md
customization.md
getting-started.md

详细介绍

实现 Avatar 控件

Syncfusion Avatar 控件是一种轻量级组件,可用于以多种格式显示用户个人资料和形象,包括图像、SVG、字体图标、字母和单词。Avatar 对于面向用户的应用、联系人列表、通知徽章和个人资料区域至关重要。

何时使用 Avatar

在需要以下功能时使用 Avatar 控件:

  • 显示用户头像或姓名首字母
  • 创建圆形或矩形的用户形象
  • 使用徽章显示通知数量
  • 构建联系人列表或用户目录
  • 在消息或社交应用中实现用户头像
  • 使用自定义尺寸和颜色显示个人资料指示器
  • 将用户形象与其他 UI 组件集成

控件概览

Avatar 控件提供:

  • 多种形状:默认(圆角矩形)和圆形
  • 5 种预定义尺寸:XLarge、Large、Default、Small、XSmall
  • 多种媒体格式:图像、SVG、字体图标、字母和单词
  • 颜色自定义:默认灰色或自定义 CSS 类
  • 组件集成:可与 Badge 和 ListView 控件配合使用
  • 响应式设计:根据字体大小缩放
  • 支持 ES5 和现代模块:兼容各种项目设置

文档与导航指南

入门

📄 阅读: references/getting-started.md

  • 安装和依赖项设置
  • Webpack 和 CSS 配置
  • 使用 HTML span 实现基本 Avatar
  • 运行应用
  • ES5 全局脚本替代方案
  • CDN 设置选项
Avatar 类型和尺寸

📄 阅读: references/avatar-types-and-sizes.md

  • Avatar 形状类型(Default 和 Circle)
  • 五种尺寸类说明
  • 尺寸参考表
  • 每种类型和尺寸的完整代码示例
  • 可视化演示
自定义与样式设置

📄 阅读: references/customization.md

  • 使用 CSS 类自定义颜色
  • 使用字体大小缩放自定义尺寸
  • 支持多种媒体格式(图像、SVG、图标、字母、单词)
  • CSS 类自定义示例
  • 响应式设计注意事项
  • 自定义调色板示例
Avatar 与 Badge 集成

📄 阅读: references/avatar-with-badge.md

  • 将 Avatar 与 Badge 控件组合使用
  • 通知徽章的位置和样式设置
  • 徽章重叠技巧
  • 所有尺寸组合的示例
  • 显示不同数量的通知徽章
ListView 中的 Avatar

📄 阅读: references/avatar-in-listview.md

  • 将 Avatar 与 ListView 控件集成
  • 创建联系人列表应用
  • 使用数据绑定的 TypeScript 实现
  • 使用条件渲染进行模板绑定
  • 在列表项中设置 Avatar 的位置和样式
  • 包含多个联系人的完整可运行示例

快速入门示例

使用默认样式的基本 Avatar:

<!DOCTYPE html>
<html lang="en">
<head>
    <title>Avatar Quick Start</title>
    <link href="url" rel="stylesheet" />
    <link href="url" rel="stylesheet" />
</head>
<body>
    
    <span class="e-avatar">AB</span>
    
    
    <span class="e-avatar e-avatar-circle">JD</span>
    
    
    <span class="e-avatar e-avatar-circle" style="background-image: url('profile.jpg')"></span>
</body>
</html>

常见模式

模式 1:不同尺寸

将尺寸类与基础 .e-avatar 类搭配使用:

<span class="e-avatar e-avatar-xlarge">AB</span>
<span class="e-avatar e-avatar-large">AB</span>
<span class="e-avatar">AB</span>
<span class="e-avatar e-avatar-small">AB</span>
<span class="e-avatar e-avatar-xsmall">AB</span>
模式 2:颜色变化

为 Avatar 创建自定义颜色类:

<span class="e-avatar e-avatar-circle primary">JD</span>
<span class="e-avatar e-avatar-circle success">MK</span>
<span class="e-avatar e-avatar-circle warning">LP</span>
.e-avatar.primary {
    background-color: #0071c1;
    color: white;
}

.e-avatar.success {
    background-color: #00b251;
    color: white;
}

.e-avatar.warning {
    background-color: #ffc900;
    color: #333;
}
模式 3:混合媒体类型

在一行中显示不同格式的 Avatar:

<div class="avatar-group">
    
    <span class="e-avatar e-avatar-large" style="background-image: url('user1.jpg')"></span>
    
    
    <span class="e-avatar e-avatar-large">
        <svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg">
            <circle cx="16" cy="16" r="15" fill="currentColor"/>
        </svg>
    </span>
    
    
    <span class="e-avatar e-avatar-large">AB</span>
    
    
    <span class="e-avatar e-avatar-large">
        <i class="icon-user"></i>
    </span>
</div>
模式 4:带状态徽章的 Avatar

将 Avatar 与通知指示器组合使用:

<div style="position: relative; display: inline-block;">
    <span class="e-avatar e-avatar-large e-avatar-circle">JD</span>
    <span class="e-badge e-badge-success e-badge-overlap e-badge-circle">●</span>
</div>

关键属性和类

尺寸类
  • .e-avatar-xlarge - 超大 Avatar
  • .e-avatar-large - 大号 Avatar
  • .e-avatar - 默认尺寸
  • .e-avatar-small - 小号 Avatar
  • .e-avatar-xsmall - 超小 Avatar
形状类
  • .e-avatar - 默认(圆角矩形)
  • .e-avatar-circle - 圆形
媒体支持
  • 图像:使用 background-image 属性和 background-size: cover
  • SVG:嵌入 SVG 标记或引用 SVG 文件
  • 图标:使用图标字体或图标库
  • 文本:直接显示姓名首字母或简短文本

常见用例

用户资料展示 在资料卡片中显示用户头像和信息,并采用合适的尺寸和形状。

联系人列表 在 ListView 中使用小号或特小号头像,通过姓名首字母或个人照片展示联系人列表。

通知徽标 将头像与 Badge 控件结合,以显示通知数量或状态指示器。

团队成员网格 以网格布局展示团队成员,并使用不同的头像类型和自定义颜色。

聊天应用 在消息线程中使用头像识别发送者,采用自定义颜色的小号圆形头像。

用户选择界面 在下拉列表或选择列表中展示用户,并保持头像样式和尺寸一致。

后续步骤

评论

支持 Markdown