跳到正文

PresenceSelector 在线状态选择器 ​

在线状态选择器,供用户在 在线 / 忙碌 / 离开 / 自定义 之间切换自己的状态。

使用方式 ​

组件以 EmPresenceSelector 为名导出,全局注册后可直接使用:

vue
<script setup lang="ts">
function onSelect(status: 'online' | 'busy' | 'away' | 'custom', ext: string) {
  console.log(status, ext)
}
</script>

<template>
  <em-presence-selector @select="onSelect" />
</template>

基础用法 ​

自定义 ​

弹窗 / 弹出层形态 ​

EmPresenceSelector 还有两个业务封装形态(实现于 @easemob-community/uikit-core,经 @easemob-community/uikit-im 具名 re-export,app.use(UIKit) 全局注册后可直接使用;均依赖登录态,自动向 SDK 发布状态变更):

vue
<script setup lang="ts">
import { ref } from 'vue'

const showModal = ref(false)

// 弹出层形态:锚定任意触发元素(如头像)
const showPopup = ref(false)
const triggerRef = ref<HTMLElement>()
</script>

<template>
  <!-- 弹窗形态 -->
  <em-presence-selector-modal v-model:show="showModal" />

  <!-- 弹出层形态 -->
  <button ref="triggerRef" @click="showPopup = true">切换状态</button>
  <em-presence-selector-popup
    v-model:show="showPopup"
    :anchor="triggerRef"
    @changed="/* 状态发布成功,可刷新本地指示器 */"
  />
</template>

EmPresenceSelectorModal ​

居中弹窗形态:选择后保持弹窗开启,让用户看到已切换的状态,点击遮罩或关闭按钮再关闭(无 changed 事件)。

PresenceSelectorModal API ​

Props ​

属性类型默认值说明
showboolean——
valuestring—当前在线状态描述(ext),未传时自动从当前登录用户的 presence 缓存读取

Events ​

事件名参数说明
update:showvalue: boolean—
close——

EmPresenceSelectorPopup ​

无遮罩锚定弹出层形态:选择后自动关闭;「自定义」状态走独立的输入弹窗(最多 32 字),状态发布成功后触发 changed。

PresenceSelectorPopup API ​

Props ​

属性类型默认值说明
showboolean——
anchorHTMLElement—锚定元素,popup 将相对于该元素定位
placement'bottom' | 'top' | 'left' | 'right'—相对锚点的位置,默认 'bottom'
align'start' | 'center' | 'end'—锚定轴上的对齐方式,默认 'start'
valuestring—当前在线状态描述(ext),未传时自动从当前登录用户的 presence 缓存读取

Events ​

事件名参数说明
update:showvalue: boolean—
close——
changed——

API ​

PresenceSelector API ​

Props ​

属性类型默认值说明
valuestring—当前自定义状态文本
showCustombooleantrue是否允许自定义状态,默认 true
customPlaceholderstring—自定义状态输入框占位符
compactbooleanfalse紧凑模式,popup 场景下更窄的宽度与更小的内边距
showHeaderbooleantrue是否展示标题头部,默认 true
useCustomModalbooleanfalse自定义状态是否使用独立 Modal 输入,默认 false(保持 inline 输入)

Events ​

事件名参数说明
selectstatus: PresenceSelectorValue, ext: string选中某个状态时触发:status 为状态 key,ext 为扩展文本(固定状态为 SDK 状态常量,自定义状态为输入文本)
cancel—点击关闭按钮取消选择时触发(无负载)
custom-click—useCustomModal 模式下点击「自定义」选项时触发(无负载),由外部弹窗接管自定义状态输入