React
chat-uikit-react 介绍
chat-uikit-react 是基于腾讯云 Chat SDK 的一款 react UI 组件库,它提供了一些通用的 UI 组件,包含会话、聊天、群组等功能。基于这些精心设计的 UI 组件,您可以快速构建优雅的、可靠的、可扩展的 Chat 应用。
开发环境要求
React version 18+(不支持 17.x 版本)
TypeScript
Node.js version 16+
npm(版本请与 node 版本匹配)
chat-uikit-react 集成
步骤1:创建项目
创建一个新的 React 项目,您可自行选择是否需要使用 ts 模版。
npx create-react-app sample-chat --template typescript
创建项目完成后,切换到项目所在目录。
cd sample-chat
步骤2:下载 chat-uikit-react 组件
npm install @tencentcloud/chat-uikit-react
步骤3:引入 chat-uikit-react 组件
注意:
以下代码中未填入
SDKAppID
、userID
和 userSig
,需在 步骤4 中获取相关信息后进行替换。为尊重表情设计版权,IM Demo/TUIKit 工程中不包含大表情元素切图,正式上线商用前请您替换为自己设计或拥有版权的其他表情包。下图所示默认的小黄脸表情包版权归腾讯云所有,可有偿授权使用,如需获得授权可 提交工单 联系我们。
替换 App.tsx 中的内容,或者您可以新建一个组件引入。
import React from 'react';import { UIKitProvider, Chat, ChatHeader, ConversationList, ChatSetting, MessageInput, MessageList, Profile } from '@tencentcloud/chat-uikit-react';import { TUIConversationService } from '@tencentcloud/chat-uikit-engine';import { TUILogin } from '@tencentcloud/tui-core';import '@tencentcloud/chat-uikit-react/dist/cjs/index.css';const config = {SDKAppID: 0, // Your SDKAppID, Get it from Step 4userID: 'YOUR_USER_ID', // Login UserID, Get it from Step 5userSig: 'YOUR_USER_SIG', // Your userSig, Get it from Step 5}TUILogin.login({...config,useUploadPlugin: true}).then(() => {openDefaultChat();}).catch(() => {});function openDefaultChat() {// 1v1 chat: conversationID = `C2C${userID}`// group chat: conversationID = `GROUP${groupID}`const userID = 'administrator'; // userID: Recipient of the Message userID, Get it from Step 5const conversationID = `C2C${userID}`;TUIConversationService.switchConversation(conversationID);}export default function SampleChat() {// language support en-US / zh-CN / ja-JP / ko-KRreturn (<div style={{display: 'flex', height: '100vh'}}><UIKitProvider language={"en-US"}><div style={{maxWidth: '400px'}}><Profile /><ConversationList /></div><Chat><ChatHeader /><MessageList /><MessageInput /></Chat><ChatSetting /></UIKitProvider></div>);}
import React from 'react';import { UIKitProvider, Chat, ChatHeader, ChatSetting, MessageInput, MessageList, Profile } from '@tencentcloud/chat-uikit-react';import { TUIConversationService } from '@tencentcloud/chat-uikit-engine';import { TUILogin } from '@tencentcloud/tui-core';import '@tencentcloud/chat-uikit-react/dist/cjs/index.css';const config = {SDKAppID: 0, // Your SDKAppID, Get it from Step 4userID: 'YOUR_USER_ID', // Login UserID, Get it from Step 5userSig: 'YOUR_USER_SIG', // Your userSig, Get it from Step 5}TUILogin.login({...config,useUploadPlugin: true}).then(() => {openDefaultChat();}).catch(() => {});function openDefaultChat() {// 1v1 chat: conversationID = `C2C${userID}`// group chat: conversationID = `GROUP${groupID}`const userID = 'administrator'; // userID: Recipient of the Message userID, Get it from Step 5const conversationID = `C2C${userID}`;TUIConversationService.switchConversation(conversationID);}export default function SampleChat() {// language support en-US / zh-CN / ja-JP / ko-KRreturn (<div style={{height: '100vh'}}><UIKitProvider language={"en-US"}><Chat><ChatHeader /><MessageList /><MessageInput /></Chat><ChatSetting /></UIKitProvider></div>);}
说明:
conversationID:会话 ID。会话ID组成方式:
C2C${userID}(单聊)
GROUP${groupID}(群聊)
关于群聊:
通过调用 API createGroup 可获取 groupID
如果是直播群, 需要通过调用 API joinGroup 加入群,才可以进行聊天。
进入聊天
通过调用 API switchConversation,传入 conversationID 进入聊天页面。
步骤4:创建一个应用
1. 登录 Chat Console 。
2. 单击 Create Application,输入您的应用程序名称,然后单击 Create。
3. 创建完成后,您可以在控制台概览页面看到新应用的状态、服务版本、SDKAppID、创建时间、标签、过期时间。
步骤5:获取 userID 和 userSig
userID
单击进入您上面创建的 Application,会在左侧边栏看到
Chat
产品入口,单击进入。进入 Chat 产品子页面后,点击
Users
,进入用户管理页面。单击
Create account
,弹出创建账号信息填写框。如果只是普通成员,我们建议您选择General
类型。为了您更好的体验消息收发等功能,建议您创建两个 userID。
userSig
,可使用控制台提供的开发工具实时生成,开发工具请点击 Chat Console > Development Tools > UserSig Tools > Signature (UserSig) Generator 。
步骤6:启动项目
替换 App.tsx 中的 SDKAppID、userID、userSig,然后运行命令如下:
npm run start
注意:
1. 请确保 步骤3 代码中
SDKAppID
、userID
和 userSig
均已成功替换,如未替换将会导致项目表现异常。2.
userID
和 userSig
为一一对应关系,具体参见 生成 UserSig。3. 如遇到项目启动失败,请检查 开发环境要求 是否满足。
步骤7:发送您的第一条消息
在输入框中输入您的消息,然后按 Enter 发送。
常见问题
什么是 UserSig?
UserSig 是用户登录 Chat 的密码,其本质是对 UserID 等信息加密后得到的密文。
如何生成 UserSig?
UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向项目的接口,在需要 UserSig 时由您的项目向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig。
注意:
本文示例代码采用的获取 UserSig 的方案是在客户端代码中配置 SECRETKEY,该方法中 SECRETKEY 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量,因此该方法仅适合本地跑通功能调试。 正确的 UserSig 签发方式请参见上文。
如何集成 UIKit 源码?
我么建议您优先采用 npm 集成方式,如果 npm 集成方式不能满足您更深层次的定制需求,您可以采用源码集成,源码集成方式如下:
1. 将 TUIKit 拷贝到自己项目的 src 文件目录下:
mkdir -p ./src/TUIKit && rsync -av ./node_modules/@tencentcloud/chat-uikit-react/ ./src/TUIKit
xcopy .\node_modules\@tencentcloud\chat-uikit-react .\src\TUIKit /i /e
2. 替换项目中所有
@tencentcloud/chat-uikit-react
为 ./TUIKit
// 比如,替换 TUIKit、TUIChat 等组件引入源为 './TUIKit'// beforeimport { Chat, UIKitProvider } from 'tencentcloud/chat-uikit-react'
;// afterimport { Chat, UIKitProvider } from './TUIKit';