Skip to content

xtf-avatar-group ​

组件说明 ​

xtf-avatar-group 是头像组,用于叠放展示成员并汇总超出数量。当前实现读取 items 数据、通过 item-click 等事件反馈交互。

  • 实际 Demo 路由:#/pages/components/xtf-avatar-group/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

提供能够直接看到或操作组件的最少业务内容。

vue
<template>
  <view class="doc-minimum">
    <XtfAvatarGroup :items="fixture" />
  </view>
</template>

<script setup lang="uts">
import XtfAvatarGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-avatar-group/xtf-avatar-group.uvue"

const fixture = [{ name: '林', src: '/static/logo.png' }, { name: '陈' }] as Array<any>
</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件 ​

使用组件真实数据入口,并记录当前源码声明的主要事件。

vue
<template>
  <view class="doc-core">
    <XtfAvatarGroup :items="fixture" :clickable="true" @item-click="onPrimaryEvent" />
  </view>
</template>

<script setup lang="uts">
import XtfAvatarGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-avatar-group/xtf-avatar-group.uvue"

const fixture = [{ name: '林', src: '/static/logo.png' }, { name: '陈' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-avatar-group:item-click", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 disabled 状态 ​

运行时切换 disabled,观察组件对应状态变化。

vue
<template>
  <view class="doc-dynamic">
    <XtfAvatarGroup :items="fixture" :disabled="state" />
    <button class="doc-action-button" @click="toggleState">切换 disabled</button>
    <text class="doc-state-text">disabled: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfAvatarGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-avatar-group/xtf-avatar-group.uvue"

import { ref } from "vue"
const fixture = [{ name: '林', src: '/static/logo.png' }, { name: '陈' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("disabled", state.value) }
</script>

<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>

4. 定制 item 插槽 ​

使用源码真实声明的 item slot 替换对应内容。

vue
<template>
  <view class="doc-slot">
    <XtfAvatarGroup :items="fixture">
      <template #item="scope"><text class="doc-content-text">自定义 item 内容:{{ scope.item }}</text></template>
    </XtfAvatarGroup>
  </view>
</template>

<script setup lang="uts">
import XtfAvatarGroup from "@/uni_modules/xtf-linkuiunix/components/xtf-avatar-group/xtf-avatar-group.uvue"

const fixture = [{ name: '林', src: '/static/logo.png' }, { name: '陈' }] as Array<any>
</script>

<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
itemsUTSJSONObject[]() => [] as UTSJSONObject[]参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 75、script 行 77、script 行 111数据驱动或选项渲染场景。
sizestring | number"md"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 72需要覆盖组件默认业务值时设置。
shapestring"circle"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 64需要覆盖组件默认业务值时设置。
themestring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 64需要调整布局或视觉表现时设置。
ringbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 66需要覆盖组件默认业务值时设置。
ringColorstring""设置对应区域的颜色;消费位置:script 行 67、template 行 8需要调整布局或视觉表现时设置。
maxstring | number5参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 74需要覆盖组件默认业务值时设置。
overlapstring | number14参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 100需要覆盖组件默认业务值时设置。
layoutstring"stack"参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 103、script 行 104、script 行 105需要调整布局或视觉表现时设置。
alignstring"start"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 94需要调整布局或视觉表现时设置。
reversebooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 77需要覆盖组件默认业务值时设置。
wrapbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 94需要覆盖组件默认业务值时设置。
morePositionstring"end"参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 89需要覆盖组件默认业务值时设置。
clickablebooleanfalse开关对应显示或交互行为;消费位置:script 行 85需要覆盖组件默认业务值时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 85、script 行 88需要控制显示、可用性或交互状态时设置。
hoverablebooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 3需要覆盖组件默认业务值时设置。
fallbackIconstring"person"设置对应区域的图标名称;消费位置:script 行 68、template 行 8需要提供业务文案或图标内容时设置。
moreTextstring""设置对应区域的显示文案;消费位置:script 行 81需要提供业务文案或图标内容时设置。
moreSrcstring""参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
moreTypestring"text"参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
moreShapestring"circle"参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
moreThemestring"inverse"参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
moreVariantstring"solid"参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 95、script 行 96需要覆盖组件默认业务值时设置。
moreRingbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
moreRingColorstring""设置对应区域的颜色;消费位置:template 行 8需要调整布局或视觉表现时设置。
moreClickablebooleantrue参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 88需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 94需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
item-clickhandleEntryClick 内触发(script 行 112);参数表达式:{ item: entry.item, index: entry.index, event };前置 guard:!entry.clickable(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
more-clickhandleEntryClick 内触发(script 行 111);参数表达式:{ restCount: hiddenCount.value, items: props.items, hiddenItems: hiddenItems.value, event };前置 guard:!entry.clickable(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

插槽Scope 参数实际渲染位置
item{ item, index }仅在模板对应 <slot> 渲染位置生效。
more{ rest-count, items, label }仅在模板对应 <slot> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
--当前组件没有公开实例方法。

公开状态 ​

状态类型 / 包装读取边界
--当前组件没有公开状态。

主题说明 ​

  • var(--xtf-avatar-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-avatar-more-bg):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-avatar-more-text):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-card-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-glass):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface-muted):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。

平台与实现边界 ​

  • 基线为 HBuilderX 5.26+ 与 uni-app x;当前报告已验证 Web Chromium 的对应 Demo,不据此承诺 Safari、小程序或 App 原生端等价。
  • Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力,只有源码或完整性报告明确覆盖的部分才可视为已验证。
  • 本文按当前源码生成,不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
  • 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。

MIT Licensed