Easemob-chat-uikit NPM

Easemob Chat UIKit Web 使用指南

简介

easemob-chat-uikit 是基于环信 Chat SDK 的一款 UI 组件库，提供通用的 UI 组件，和包含聊天业务逻辑的 module 组件，以及可以完整使用的容器组件，容器组件允许用户使用 renderX 方法来进行自定义。easemob-chat-uikit 提供 provider 来管理数据，provider 自动监听 SDK 事件，来更新数据，并驱动 UI 更新。开发者可根据实际业务需求利用该库快速搭建自定义 IM 应用。

技术原理

UIKIt 由三部分组成：UI 组件，管理数据的 mobx store, chat SDK。UI 组件包含容器组件 container 复合组件 module, 以及纯 UI 组件 components, 这些不同级别的组件全部对外暴露，用户可以引用任意组件构建自己的应用。UIkit 使用 mobx 管理全局数据，用户可以引用 rootStore 来获得全部数据和 action 方法，可以用 action 方法来操作数据。 UIKit 内部集成了 chat SDK，通过 chat SDK 和服务器交互。

功能

easemob-chat-uikit 库提供以下功能：

自动布局，适配容器的宽高；
实现收发消息、消息上屏、消息未读数、清空消息、消息类型包括：（文本、图片、文件、表情、音频、视频消息）；
搜索，删除会话；
定制化 UI。

组件

easemob-chat-uikit 目前提供的组件：

容器组件：Provider， Chat，ConversationList；
module 组件：BaseMessage，AudioMessage，FileMessage， VideoMessage，ImageMessage，TextMessage，Header，Empty，MessageList， ConversationItem，MessageInput，MessageStatus；
纯 UI 组件：Avatar，Badge，Button，Checkbox，Icon，Modal，Tooltip

容器组件介绍

store

UIKit 提供了一个包含全部数据的 rootStore, rootStore 包含:

initConfig：UIKit 初始化数据
client：Chat SDK 实例
conversationStore: 会话列表相关数据
messageStore：消息相关数据
addressStore：通讯录相关数据

前提条件

开启 Easemob Chat 服务前，请确保已经具备以下要素：

React 16.8.0 或以上版本；
React DOM 16.8.0 或以上版本；
Easemob Chat 项目和 App Key。

支持的浏览器

浏览器	支持的版本
IE 浏览器	11 或以上
Edge	43 或以上
Firefox	10 或以上
Chrome	54 或以上
Safari	11 或以上

UIKit 中用到的服务

会话列表
漫游消息
单向删除漫游消息
用户属性

使用步骤

1.创建 chat-uikit 项目

# 安装 CLI 工具。
npm install create-react-app
# 构建一个 my-app 的项目。
npx create-react-app my-app
cd my-app

项目目录：
├── package.json
├── public                  # Webpack 的静态目录。
│   ├── favicon.ico
│   ├── index.html          # 默认的单页面应用。
│   └── manifest.json
├── src
│   ├── App.css             # App 根组件的 CSS。
│   ├── App.js              # App 组件代码。
│   ├── App.test.js
│   ├── index.css           # 启动文件样式。
│   ├── index.js            # 启动文件。
│   ├── logo.svg
│   └── serviceWorker.js
└── yarn.lock

2.集成 easemob-chat-uikit

安装 easemob-chat-uikit

通过 npm 安装，运行以下命令：

npm install easemob-chat-uikit --save

通过 yarn 安装，运行以下命令：

yarn add easemob-chat-uikit

使用 easemob-chat-uikit 组件构建应用

将 easemob-chat-uikit 库导入你的代码中：

// App.js
import React, { Component, useEffect } from 'react';
import { Provider, Chat, ConversationList, useClient, rootStore } from 'easemob-chat-uikit';
import 'easemob-chat-uikit/style.css';

const ChatApp = () => {
  const client = useClient();
  useEffect(() => {
    client &&
      client
        .open({
          user: '',
          token: '',
        })
        .then(res => {
          console.log('get token success', res);
          // create a conversation
          rootStore.conversationStore.addConversation({
            chatType: '', // 'singleChat' || 'groupChat'
            conversationId: '', // target user id or group id
            name: '', // target user nickname or group name
          });
        });
  }, [client]);

  return (
    <div>
      <div>
        <ConversationList />
      </div>
      <div>
        <Chat />
      </div>
    </div>
  );
};

class App extends Component {
  render() {
    return (
      <Provider
        initConfig={{
          appKey: 'your app key',
        }}
      >
        <ChatApp />
      </Provider>
    );
  }
}

export default App;

运行项目并发送你的第一条消息

npm run start

在浏览器可看到你的应用。

在默认 App Key 情况下，为方便快速体验，我们默认支持几种类型的消息下发。点击选中一个成员后，输入你的第一条消息并发送。

注意使用自定义 App Key 时，由于没有联系人，需先添加好友

如何自定义

修改组件样式

可以通过组件 props 传递 className, style, prefix 修改样式

import { Chat, Button } from 'easemob-chat-uikit';

const ChatApp = () => {
  return (
    <div>
      <Chat className="customClass" prefix="custom" />
      <Button style={{ width: '100px' }}>Button</Button>
    </div>
  );
};

使用自定义组件

可以通过容器组件的 renderX 方法来渲染自定义组件

import {Chat, Header} from 'easemob-chat-uikit'

const ChatApp = () => {
  const CustomHeader = <Header back content="Custom Header">
  return(
    <div>
      <Chat renderHeader={(cvs) => CustomHeader}>
    </div>
  )
}

修改主题

UIKit 样式使用 scss 框架开发，定义了一系列全局样式变量，包括但不限于全局样式（主色、背景色、圆角、边框、字体大小）。

// need to use hsla
$blue-base: hsla(203, 100%, 60%, 1);
$green-base: hsla(155, 100%, 60%, 1);
$red-base: hsla(350, 100%, 60%, 1);
$gray-base: hsla(203, 8%, 60%, 1);
$special-base: hsla(220, 36%, 60%, 1);

$font-color: $gray-3;
$title-color: $gray-1;
$component-background: #fff;

$height-base: 36px;
$height-lg: 48px;
$height-sm: 28px;

// vertical margins
$margin-lg: 24px;
$margin-md: 16px;
$margin-sm: 12px;
$margin-xs: 8px;
$margin-xss: 4px;

// vertical paddings
$padding-lg: 24px;
$padding-md: 20px;
$padding-sm: 16px;
$padding-s: 12px;
$padding-xs: 8px;
$padding-xss: 4px;
// font
$font-size-base: 14px;
$font-size-lg: $font-size-base + 2px;
$font-size-sm: 12px;
$text-color: fade($black, 85%);

使用 webpack 进行变量覆盖：

module.exports = {
  module: {
    rules: [
      {
        test: /\.s[ac]ss$/i,
        use: [
          "style-loader",
          "css-loader",
          {
            loader: "sass-loader",
            options: {
              additionalData: `@import "@/styles/index.scss";`
            },
          },
        ],
      },
    ],
  },
};

如果这些不能满足定制化要求，还可以检查元素来覆盖 UIKit 的样式。