UserCard 用户卡片
展示用户信息的卡片组件,支持在线状态、操作按钮与信息行配置,适用于聊天侧边栏、通讯录详情等场景。
使用方式
组件以 EmUserCard 为名导出,全局注册后可直接使用:
vue
<template>
<em-user-card user-id="user_001" name="张三" avatar="https://..." />
</template>基础用法
在线状态
操作与信息行
弹窗形态 EmUserCardModal
EmUserCardModal 是用户卡片的弹窗形态:在 EmUserCard 之上封装数据加载与联系人操作(加好友 / 删除 / 拉黑 / 备注编辑),按查看对象自动呈现自己档 / 好友档 / 陌生人档。默认居中弹窗;传入 anchor 后改为相对触发元素的无遮罩弹出(仅桌面端,移动端一律回落为底部抽屉)。依赖登录态,需在 EmUIKitProvider 内使用。
vue
<script setup lang="ts">
import { ref } from 'vue'
const show = ref(false)
const userId = 'user_001'
function onSendMessage(id: string) {
// 跳转到与该用户的会话
}
</script>
<template>
<em-user-card-modal
v-model:show="show"
:user-id="userId"
@send-message="onSendMessage"
/>
</template>打开弹窗时自动拉取在线状态与黑名单;enableAudioAction / enableVideoAction 仅展示语音 / 视频通话入口(SDK 无 RTC 能力),点击后抛 audio-call / video-call 事件,通话能力由消费方实现。
UserCardModal API
Props
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| show | boolean | — | — |
| userId | string | — | — |
| enableAudioAction | boolean | false | 是否展示语音通话入口(SDK 无 RTC 能力,点击仅抛 audio-call 事件由消费方接管),默认 false |
| enableVideoAction | boolean | false | 是否展示视频通话入口(SDK 无 RTC 能力,点击仅抛 video-call 事件由消费方接管),默认 false |
| showAlias | boolean | true | 联系人档是否展示备注(User Alias)编辑区,默认 true |
| anchor | HTMLElement | — | 锚定触发元素:传入后名片相对该元素无遮罩弹出(仅桌面端,移动端回落为底部抽屉);不传维持居中弹窗 |
| placement | 'bottom' | 'top' | 'left' | 'right' | 'right' | 相对锚点的位置,默认 'right'(仅锚定模式生效,边界不足时自动翻转) |
| align | 'start' | 'center' | 'end' | 'start' | 锚定轴上的对齐方式,默认 'start'(仅锚定模式生效) |
| offset | number | 8 | 与锚点的间距(px),默认 8(仅锚定模式生效) |
| enablePresence | boolean | — | 是否展示在线状态,默认跟随 Provider 全局 enablePresence 配置; 主动查看场景(名片)默认展示,传 false 可单独关闭。 Whether to show presence. Defaults to the global enablePresence feature; pass false to opt out. |
Events
| 事件名 | 参数 | 说明 |
|---|---|---|
update:show | value: boolean | — |
send-message | userId: string | — |
contact-added | userId: string | 陌生人档点击「加好友」且申请发送成功后触发 |
deleted | userId: string | 删除联系人成功后触发 |
block-changed | userId: string, blocked: boolean | 拉黑/取消拉黑成功后触发 |
remark-changed | userId: string, remark: string | 备注保存成功后触发 |
audio-call | userId: string | 点击语音通话入口时触发(需 enableAudioAction 开启,通话能力由消费方实现) |
video-call | userId: string | 点击视频通话入口时触发(需 enableVideoAction 开启,通话能力由消费方实现) |
close | — | — |
send-message/deleted触发后会自动关闭弹窗。
API
UserCard API
Props
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| userId | string | — | 用户 ID |
| name | string | — | 展示名称 |
| avatar | string | — | 头像 URL |
| layout | 'banner' | 'plain' | 'banner' | 布局:banner(顶部横幅+大头像,默认)/ plain(无横幅,头像与文字水平排列) |
| subtitle | string | — | 名称下方的副标题行(如 Username),有值才渲染 |
| subtitleLabel | string | — | 副标题行前置标签(如 Username),仅 subtitle 有值时随其渲染 |
| userIdLabel | string | — | 用户 ID 行前置标签(如 UserID),有值才渲染 |
| userIdCopyable | boolean | true | 用户 ID 是否支持点击复制(展示复制图标),默认 true |
| banner | string | — | 顶部背景图 URL,不传时使用默认渐变(仅 banner 布局生效) |
| status | PresenceDisplayStatus | — | 在线状态 |
| editable | boolean | false | 头像是否可编辑(用于当前用户变更在线状态),默认 false |
| selectorPlacement | 'bottom' | 'top' | 'left' | 'right' | — | 弹层相对头像的位置,默认 'bottom' |
| actions | UserCardAction[] | () => [] | 底部操作按钮 |
| infoRows | UserCardInfoRow[] | () => [] | 信息行 |
Events
| 事件名 | 参数 | 说明 |
|---|---|---|
action-click | key: string | 点击底部操作按钮时触发,负载为按钮对应的 action key |
info-click | key: string | 点击信息行时触发(仅当该行 clickable 为 true),负载为行对应的 key |
avatar-click | — | 点击头像时触发(不含在线状态指示器点击,避免与 presence-click 重复) |
presence-click | — | 点击头像上的在线状态指示器时触发(由 Avatar 内部转发);editable 时同时弹出在线状态选择器 |
presence-changed | — | 在线状态选择器中成功变更状态后触发(转发 PresenceSelectorPopup 的 changed 事件) |
Slots
| 插槽名 | 说明 |
|---|---|
meta-extra | — |
