跳到正文

GroupManagement 群管理 ​

群管理模块覆盖群详情页常见的管理能力:全员禁言、禁言列表、黑名单、白名单、共享文件与入群申请,以及群公告、群成员列表、群详情卡片等业务组件。所有组件均以 Em 前缀命名导出,需在 EmUIKitProvider 内使用(依赖登录态与群组 store)。

群详情抽屉与群管理入口

使用方式 ​

vue
<script setup lang="ts">
import { EmUIKitProvider, EmGroupManagementSection } from '@easemob-community/uikit-im'
</script>

<template>
  <EmUIKitProvider
    app-key="your-app-key"
    :auto-init="true"
  >
    <div style="width: 360px;">
      <!-- 群管理入口 + 二级页(默认 drawer 抽屉形态) -->
      <em-group-management-section group-id="group-id" display-mode="drawer" />
    </div>
  </EmUIKitProvider>
</template>

管理入口按当前用户角色做权限门控:全员禁言、禁言列表、黑名单、入群申请对群主 / 管理员可见;白名单仅群主可见。

EmGroupManagementSection 群管理入口 ​

群管理入口区块,渲染「全员禁言」开关与各管理入口列表(带数量角标),点击入口后以二级页展示对应管理列表。二级页支持 drawer(抽屉)与 modal(居中弹窗)两种形态,通过 display-mode 切换。

GroupManagementSection API ​

Props ​

属性类型默认值说明
groupIdstring—群 ID
displayMode'drawer' | 'modal''drawer'二级页面展示方式:drawer(抽屉)或 modal(居中弹窗)
showMuteAllbooleantrue是否展示全员禁言开关
showMuteListbooleantrue是否展示禁言列表入口
showBlocklistbooleantrue是否展示黑名单入口
showAllowlistbooleanfalse是否展示白名单入口
showSharedFilesbooleantrue是否展示共享文件入口
showJoinRequestsbooleanfalse是否展示入群申请入口

Events ​

事件名参数说明
group-operationpayload: { type: string, groupId: string, userId?: string }—

Slots ​

插槽名说明
mute-list—
block-list—
allow-list—
shared-files—
join-requests—

权限门控:全员禁言开关、禁言列表、黑名单、入群申请入口对群主 / 管理员可见;白名单入口仅群主可见。 group-operation 事件的 type 取值:mute-all / unmute-all / mute-member / unmute-member / block-member / unblock-member / remove-allowlist-member / accept-join-request / reject-join-request。

二级页接管插槽 ​

以下插槽用于完全接管对应二级页的渲染。作用域类型为 GroupManagementSectionSlotScope:

插槽名说明
mute-list接管禁言列表二级页
block-list接管黑名单二级页
allow-list接管白名单二级页
shared-files接管共享文件二级页
join-requests接管入群申请二级页

插槽作用域(GroupManagementSectionSlotScope):

字段类型说明
showboolean该二级页当前是否激活
groupIdstring群 ID
open(key: GroupManagementKey) => void打开指定二级页
close() => void关闭二级页

GroupManagementKey 类型:'mute' | 'block' | 'allow' | 'files' | 'requests'。

vue
<template>
  <em-group-management-section group-id="group-id">
    <!-- 示例:接管禁言列表二级页 -->
    <template #mute-list="{ show, groupId, close }">
      <div v-if="show">
        <button @click="close">返回</button>
        <custom-mute-panel :group-id="groupId" />
      </div>
    </template>
  </em-group-management-section>
</template>

EmGroupMuteList 禁言列表 ​

禁言成员列表,内置加载、取消禁言二次确认与「添加禁言」弹窗。

GroupMuteList API ​

Props ​

属性类型默认值说明
groupIdstring——
showHeaderbooleantrue是否显示顶部计数操作栏,默认 true;会话详情抽屉分栏页传 false(tabs 页不显示计数栏)
borderboolean | 'top' | 'bottom'—行分隔线(透传 EmCell border 能力),默认无;会话详情抽屉分栏页传 'bottom'

Events ​

事件名参数说明
unmutemember: UiGroupMember—
mutemembers: UiGroupMember[]—

unmute / mute 事件声明负载为 UiGroupMember,实际回传 { userId }(mute 为批量操作,回传数组)。

实例方法 ​

  • openAddMember():打开「添加禁言」成员选择弹窗

EmGroupBlocklist 黑名单 ​

群黑名单列表,内置加载、移出黑名单二次确认与「添加」弹窗。

GroupBlocklist API ​

Props ​

属性类型默认值说明
groupIdstring——
borderboolean | 'top' | 'bottom'—行分隔线(透传 EmCell border 能力),默认无;会话详情抽屉分栏页传 'bottom'

Events ​

事件名参数说明
unblockmember: UiGroupMember—
blockmembers: UiGroupMember[]—

unblock / block 事件声明负载为 UiGroupMember,实际回传 { userId }(block 为批量操作,回传数组)。

实例方法 ​

  • openAddMember():打开「添加黑名单」成员选择弹窗

EmGroupAllowlist 白名单 ​

群白名单(全员禁言时可发言成员)列表,内置加载与移除操作。

GroupAllowlist API ​

Props ​

属性类型默认值说明
groupIdstring——

Events ​

事件名参数说明
removemember: UiGroupMember—

remove 事件声明负载为 UiGroupMember,实际回传 { userId }。

EmGroupSharedFileList 共享文件列表 ​

群共享文件列表,内置加载、上传(移动端 ActionSheet / 桌面端右键菜单)、下载与删除(按角色与文件归属门控)。

GroupSharedFileList API ​

Props ​

属性类型默认值说明
groupIdstring——
borderboolean | 'top' | 'bottom'—行分隔线(透传 EmCell border 能力),默认无;会话详情抽屉群文件页传 'bottom'

实例方法 ​

  • triggerUpload():触发文件上传(供二级页头部「上传」按钮调用)

EmGroupJoinRequestList 入群申请列表 ​

入群申请列表,内置加载与同意 / 拒绝操作,数据源来自群组 store 的申请缓存。

GroupJoinRequestList API ​

Props ​

属性类型默认值说明
groupIdstring——

Events ​

事件名参数说明
accepteduserId: string—
rejecteduserId: string—

EmGroupAnnouncement 群公告 ​

群公告展示与编辑组件:默认单行省略(仅超一行时提供展开 / 收起),群主 / 管理员可编辑,长度受 GROUP_INFO_LIMIT.ANNOUNCEMENT_MAX_LENGTH 限制。

GroupAnnouncement API ​

Props ​

属性类型默认值说明
groupIdstring——
loadingboolean——

Events ​

事件名参数说明
updatedannouncement: string—

EmGroupMemberList 群成员列表 ​

群成员列表,内置搜索、触底加载、成员在线状态(presence 可视区域懒加载)与行尾 ⋮ 操作菜单(私聊 / 添加联系人 / 设管理员 / 禁言 / 拉黑 / 转让群主 / 移除,按角色与好友关系动态门控)。

GroupMemberList API ​

Props ​

属性类型默认值说明
groupIdstring——
groupUiGroup | nullnull—
membersUiGroupMember[]() => []—
loadingbooleanfalse—
hasMorebooleanfalse—
currentUserIdstring''—
showSearchbooleantrue—
closablebooleanfalse是否在标题栏显示关闭按钮
showHeaderbooleantrue是否展示头部标题栏
allowChat'all' | 'contact' | 'none''all'是否允许对成员发起单聊:'all' 所有人,'contact' 仅联系人,'none' 不允许
showMuteActionbooleantrue是否展示禁言/取消禁言操作
showBlockActionbooleantrue是否展示拉黑/取消拉黑操作
showAdminActionbooleantrue是否展示设/取消管理员操作
showRemoveActionbooleantrue是否展示移除成员操作
showChatActionbooleantrue是否展示发消息操作
showIdbooleantrue成员行是否显示第二行 ID,默认 true;会话详情抽屉成员页传 false(设计稿无 ID 行)
showNoMorebooleantrue列表末尾是否显示「没有更多了」,默认 true;会话详情抽屉成员页传 false(设计稿无结尾文字)
borderboolean | 'top' | 'bottom'—成员行分隔线(透传 EmCell border 能力),默认无;会话详情抽屉成员页传 'bottom'
menuWithIconboolean—⋮ 菜单项是否显示图标,默认 false(设计稿菜单为纯文字项)
searchPillboolean—搜索框是否使用椭圆(pill)形态,默认 false;会话详情抽屉成员页传 true
enablePresenceboolean—是否展示成员头像在线状态,默认跟随 Provider 全局 enablePresence 配置;
可视区懒查询策略仍由全局 fetchGroupMemberPresenceOnVisible 控制。
Whether to show presence dots on member avatars. Defaults to the global enablePresence feature.
keywordstring—受控搜索关键词:传入时优先于内部搜索框输入(会话详情抽屉成员页的共享搜索框走该入口),
此时通常配合 show-search=false 隐藏自带搜索框

Events ​

事件名参数说明
click-membermember: UiGroupMember—
chat-membermember: UiGroupMember—
remove-membermember: UiGroupMember—
set-adminmember: UiGroupMember—
remove-adminmember: UiGroupMember—
mute-membermember: UiGroupMember—
unmute-membermember: UiGroupMember—
block-membermember: UiGroupMember—
unblock-membermember: UiGroupMember—
transfer-ownermember: UiGroupMember—
load-more——
close——

Slots ​

插槽名说明
member-menu—

插槽 ​

  • member-menu:接管成员行尾 ⋮ 操作菜单内容,作用域为 { member, actions, select, close }:
    • member:当前成员(UiGroupMember)
    • actions:内置动作列表(GroupMemberMoreAction[],元素含 key / label / icon / danger)
    • select(key: string):触发指定内置动作(与点击内置菜单项一致)
    • close():关闭菜单

实例方法 ​

  • refresh():重新拉取成员列表
  • removeMember(userId):本地移除指定成员
  • setMemberRole(userId, role):本地更新成员角色

EmGroupDetail 群详情卡片 ​

群详情卡片,展示群头像、群名(群主可改名)、群 ID 与「发消息」胶囊按钮,底部为退出 / 解散群操作(含二次确认)。

GroupDetail API ​

Props ​

属性类型默认值说明
groupIdstring—群 ID
groupUiGroup | nullnull外部已缓存的群摘要(可选,用于首屏快速展示)

Events ​

事件名参数说明
send-messagegroupId: string—
leavedgroupId: string退出群聊成功后触发(组件内部已删除对应会话与消息缓存)
destroyedgroupId: string解散群聊成功后触发(组件内部已删除对应会话与消息缓存)

Slots ​

插槽名说明
avatar—
header—
extra—
actions—
footer—

插槽 ​

  • avatar:接管群头像区,作用域 { groupId, avatar, displayName }
  • header:接管群名(含编辑)与群 ID 信息区,作用域 { groupId, displayName, isOwner, group }
  • extra:在头部与操作按钮之间插入自定义内容(如群介绍、成员数),作用域 { groupId, group }
  • actions:接管「发消息」胶囊按钮区,作用域 { groupId }
  • footer:接管退出 / 解散按钮区,作用域 { groupId, isOwner, group }

相关链接 ​

  • 群组模块:群组列表容器 EmGroupListContainer 与在线演练场