跳到主要内容

自定义表情

Emoji 表情​

Global IM UIKit 提供了基础的 Emoji 表情列表，包含 u+1f601 - u+1f64f 和 u+1f910 - u+1f92f 共 111 个 Emoji 字符。

提示

上图为参考设计图，并非 Global IM UIKit 默认实现。图中会话列表筛选组件、会话页面右上角的扩展功能项目和菜单中的部分项目需要应用程序自行实现。

您可以通过 cloneChatEmojiLibrary 方法获取 Emoji 表情列表，以便于自定义修改。修改完成后，通过 setChatEmojiLibrary 方法进行更新。

const library = kitApp.cloneChatEmojiLibrary();

// 修改 Emoji 表情面板图标，建议使用 svg 图片资源
library.icon = '';
// 修改 Emoji 字符列表
library.chats.push('📚');

// 方法仅限 kitApp.ready() 调用前有效
kitApp.setChatEmojiLibrary(library);
提示

setChatEmojiLibrary 方法仅在 kitApp.ready() 调用前有效。

图片表情​

Global IM UIKit 当前不提供任何内置图片表情包，但您可以通过 setImageEmojiLibraries 方法进行自定义图片表情包的配置。当用户点击图片表情时，Global IM UIKit 会将图片消息或 Gif 消息的形式进行发送。

提示

setImageEmojiLibraries 方法仅在 kitApp.ready() 调用前有效。

参数列表

参数类型必传说明
idString是表情包 ID，业务层自行定义
iconString是表情包图标，建议使用 svg 图片资源，用于表情面板不同表情库切换按钮显示
orderNumber是icon 图标在表情面板中的展示顺序，order 值越小，展示越靠前
itemWidthNumber是表情包单个表情在表情面板内的展示宽度
itemHeightNumber是表情包单个表情在表情面板内的展示高度
itemsArray of IRCKitImageEmoji是表情包中的表情元素列表，元素结构请查阅 APIDoc IRCKitImageEmoji

代码示例

// 定义图片表情包
const library1 = {
  id: 'library1',
  icon: '', // 表情包图标，建议使用 svg 图片资源，用于表情面板切换按钮显示
  itemWidth: 100, // 表情包单个表情在表情面板内的展示宽度
  itemHeight: 80, // 表情包单个表情在表情面板内的展示高度
  order: 0, // 表情包在表情面板中的展示顺序，order 值越小，展示越靠前
  items: [
    // 静态图片表情
    {
      url: 'https://xxxxx', // 网络资源托管地址，地址需确保各端网络环境的可访问性
      thumbnail: '', // 缩略图数据，需为 base64 字符串，同时也作为表情面板展示用，以避免大量请求原图造成流量浪费
    },
    // Gif 表情
    {
      url: 'https://xxxxx',
      thumbnail: '',
      // 若图片资源为 Gif 图片，且希望以 Gif 消息形式发送，则需要补充提供 Gif 图片信息
      // 否则 SDK 将默认以普通图片消息形式进行发送
      gif: {
        size: 100, // 图片尺寸，单位为 Byte
        width: 100,
        height: 100,
      }
    },
    // ...
  ],
}
const library2 = { /* ... */ }
// SDK 支持同时配置多个图片表情包
kitApp.setImageEmojiLibraries([ library1, library2 ]);
最后于 更新