wot-design-uni/components/wd-avatar-group/types.ts

一个基于Vue3+TS开发的uni-app组件库，提供70+高质量组件，支持暗黑模式、国际化和自定义主题。

/*
 * @Author: weisheng
 * @Date: 2025-12-30
 * @LastEditTime: 2025-12-30
 * @LastEditors: weisheng
 * @Description: AvatarGroup 头像组类型定义
 * @FilePath: /wot-design-uni/src/uni_modules/wot-design-uni/components/wd-avatar-group/types.ts
 * 记得注释
 */
import type { ExtractPropTypes, PropType } from 'vue'
import type { InjectionKey } from 'vue'
import { baseProps, makeStringProp, makeNumericProp } from '../common/props'
import type { AvatarShape, AvatarSize } from '../wd-avatar/types'

export type AvatarGroupCascadingValue = 'left-up' | 'right-up'

export type AvatarGroupProvide = {
  props: AvatarGroupProps
}

export const AVATAR_GROUP_KEY: InjectionKey<AvatarGroupProvide> = Symbol('wd-avatar-group')

export const avatarGroupProps = {
  ...baseProps,

  /**
   * 最多显示的头像数量
   * 类型: string | number
   * 默认值: undefined
   */
  maxCount: makeNumericProp(undefined),

  /**
   * 头像层叠方向
   * 可选值: left-up(左侧叠层) / right-up(右侧叠层)
   * 类型: string
   * 默认值: 'left-up'
   */
  cascading: makeStringProp<AvatarGroupCascadingValue>('left-up'),

  /**
   * 统一设置组内所有头像的形状
   * 类型: string
   * 默认值: undefined
   */
  shape: String as PropType<AvatarShape>,

  /**
   * 统一设置组内所有头像的尺寸
   * 类型: string | number
   * 默认值: undefined
   */
  size: [String, Number] as PropType<number | string | AvatarSize>,

  /**
   * 超出最大数量时折叠头像显示的内容
   * 类型: string
   * 默认值: undefined
   */
  collapseAvatar: makeStringProp('')
}

export type AvatarGroupProps = ExtractPropTypes<typeof avatarGroupProps>