未读/提及角标(UnreadBadge)
未读/提及角标:UnreadBadge 是 IDL 定义的跨端 UI 组件,props / events / behaviors 在各平台语义一致。本页给出契约属性、事件、渲染行为、数据源与 HarmonyOS 端绑定/示例。
契约预留
本平台尚未实现:以下绑定声明来自已冻结契约,示例标注为契约样例。
契约属性(props)
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
count | int | 是 | 未读数量(0 隐藏,>99 显示 99+) |
mentionedCount | int | 否 | @ 提及数量(独立角标) |
muted | bool | 否 | 是否被禁言(禁言时禁用发送并提示) |
事件
该组件未声明事件;交互通过属性和宿主回调完成。
渲染行为
- 0 隐藏;>99 显示 99+;muted 用灰点;提及用 @ 角标
数据源
未在 IDL 声明 dataSource;由宿主从 IMLib 拉取(getConversationList / getHistoryMessages / MESSAGES / CONVERSATION 事件)。
依赖边界
组件不直连网络与数据库:会话/消息由宿主从 IMLib 拉取后传入,组件只做排序、角标、格式化与渲染。
平台绑定
| 项 | 值 |
|---|---|
| 公开符号 / 签名 | struct UnreadBadge(@Component):props count/mentionedCount/muted;方法 displayText(): string(0 隐藏、>99 显示 99+、muted 灰点、提及 @ 角标) |
| 导出列表包含 | 是 |
| UI 框架 | ArkUI 声明式组件(@Component struct),预留命名路由 |
使用示例
ArkTS(契约预留)
// HarmonyOS 绑定为契约预留,以下为声明(bindings.harmony.imkit.methodMap)
// struct UnreadBadge(@Component):props count/mentionedCount/muted;方法 displayText(): string(0 隐藏、>99 显示 99+、muted 灰点、提及 @ 角标)
const kit = new IMKitFacade();
kit.mount(container); // 组件:UnreadBadge
kit.update({ locale: 'zh-CN' });相关文档
- 功能列表:能力矩阵
- 组件 API:全部组件 props / events
- 主题定制
- 多语言与格式化
- HarmonyOS IMLib:数据来源