小程序

最近更新时间:2023-09-11 17:12:42

我的收藏

如何集成 TUIKit ?

步骤1: 下载源码

TUIKit 支持以原生 js 的方式集成。可从 Github 下载 TUIKit 源码。命令行执行:
git clone https://github.com/tencentyun/TIMSDK.git

步骤2: 初始化 TUIKit

cd TIMSDK/MiniProgram/TUIKit
找到并打开TUIKit/miniprogram/debug/GenerateTestUserSig.js文件,并填写 SDKAppID 以及 SECRETKEY (默认为空字符串,请设置为实际的密钥信息)。
import LibGenerateTestUserSig from './lib-generate-test-usersig-es.min.js';
const SDKAPPID = 0;
const SECRETKEY = "";

步骤3: 集成静态资源文件

在自己的项目中集成静态资源文件(工具、图片等)。



步骤4: 集成所需模块

由于微信对于小程序的主包体积要求不得超过2M,所以 TUIKit 推出分包的解决方案,为客户解决体积超出这一问题。

集成整个分包

1. 客户自己设置主包的内容并放置在 page 文件夹内,建议主包尽可能的只放首页,减少首屏渲染时间以及主包的体积大小。
2. 将分包引入,并和主包置于同一层级。分包内部独立并包含整个模块的逻辑。


在 app.json 中配置分包路径。主包路径为原来的 page 路径不变。
"subPackages":[
{
"root":"TUI-CustomerService",
"name": "TUI-CustomerService",
"pages": [
"pages/TUI-Conversation/conversation/conversation",
"pages/TUI-Chat/chat",
"pages/TUI-Conversation/create-conversation/create",
"pages/TUI-Group/create-group/create",
"pages/TUI-Group/join-group/join",
"pages/TUI-Group/memberprofile-group/memberprofile"
],
"independent": false
}
],
是否启用预加载(启用后,在进入主包后就会预加载分包内的资源,否则,进入分包后才会加载分包内的资源)。
"preloadRule": {
"pages/TUI-Index/index" :{
"network": "all",
"packages": [
"TUI-CustomerService"
]
}
},

只集成目标模块

1. 客户自己设置主包的内容并放置在 page 文件夹内,建议主包尽可能的只放首页,减少首屏渲染时间以及主包的体积大小。
2. 将引入的模块设置为分包,并和主包置于同一层级。分包内部独立并包含整个模块的逻辑。
引入模块所需静态资源



引入自己所需的模块



在 app.json 中配置分包路径。主包路径为原来的 page 路径不变。
"subPackages":[
{
"root":"TUI-CustomerService",
"name": "TUI-CustomerService",
"pages": [
"pages/TUI-Conversation/conversation/conversation",
"pages/TUI-Chat/chat",
"pages/TUI-Conversation/create-conversation/create"
],
"independent": false
}
],
是否启用预加载(启用后,在进入主包后就会预加载分包内的资源,否则,进入分包后才会加载分包内的资源)。
"preloadRule": {
"pages/TUI-Index/index" :{
"network": "all",
"packages": [
"TUI-CustomerService"
]
}
},

常见问题

小程序如果需要上线或者部署正式环境怎么办?

请在微信公众平台 > 开发 > 开发设置 > 服务器域名中进行域名配置:
将以下域名添加到 request 合法域名
从v2.11.2起 SDK 支持了 WebSocket,WebSocket 版本须添加以下域名:
域名
说明
是否必须
wss://wss.im.qcloud.com
Web IM 业务域名
必须
wss://wss.tim.qq.com
Web IM 业务域名
必须
https://web.sdk.qcloud.com
Web IM 业务域名
必须
https://webim.tim.qq.com
Web IM 业务域名
必须
v2.10.2及以下版本使用 HTTP,HTTP 版本须添加以下域名:
域名
说明
是否必须
https://webim.tim.qq.com
Web IM 业务域名
必须
https://yun.tim.qq.com
Web IM 业务域名
必须
https://events.tim.qq.com
Web IM 业务域名
必须
https://grouptalk.c2c.qq.com
Web IM 业务域名
必须
https://pingtas.qq.com
Web IM 统计域名
必须
https://aegis.qq.com
Web IM 统计域名
必须
将以下域名添加到 uploadFile 合法域名
域名
说明
是否必须
https://cos.ap-shanghai.myqcloud.com
文件上传域名
必须
将以下域名添加到 downloadFile 合法域名
域名
说明
是否必须
https://cos.ap-shanghai.myqcloud.com
文件下载域名
必须

相关文档