tencent cloud

Feedback

Web & H5(Vue)

Last updated: 2024-06-12 18:00:47

    TUIKit Overview

    TUIKit is a UI component library based on Tencent Cloud Chat SDK. It provides some universal UI components, including conversations, chats, relationship chains, groups, audio/video calls, and other features. With these UI components, you can quickly build your own in-app chat. While implementing UI features, the components in TUIKit will call the corresponding interfaces of the Chat SDK to implement Chat-related logic and data processing. Therefore, developers only need to focus on their own business or personalized expansion when using TUIKit.

    TUIKit Components

    TUIKit is mainly divided into several UI sub-components: TUIChat, TUIConversation, TUIGroup, TUIContact, and TUISearch.
    Each UI component is responsible for displaying different content.
    
    
    

    

    Environment Requirements

    Vue (Fully compatible with both Vue2 & Vue3. While incorporating below, please select the Vue version guide that matches your needs)
    TypeScript (Should your project be based on JavaScript, please proceed to JS project integrate to set up a progressive support for TypeScript)
    Sass (sass-loader ≤ 10.1.1)
    node(node.js ≥ 16.0.0)
    npm (use a version that matches the Node version in use)

    Integration of TUIKit (Web & H5)

    Step 1. Create a project

    TUIKit supports creating a project structure using webpack or vite, configured with Vue3 / Vue2 + TypeScript + sass. Below are a few examples of how to construct your project:
    vue-cli
    vite
    Please Note:
    Please make sure you have @vue/cli version 5.0.0 or above . The following sample code can be used to upgrade your @vue/cli version to v5.0.8.
    Establish a project using Vue CLI, with configuration set to Vue2/Vue3 + TypeScript + Sass/SCSS. If Vue CLI is not yet installed, or the version is below 5.0.0, you can use the following method for installation via Terminal or CMD:
    npm install -g @vue/cli@5.0.8 sass sass-loader@10.1.1
    Create a project through Vue CLI and select the configuration items depicted below.
    vue create chat-example
    Please make sure to select according to the following configuration:
    
    After creation, switch to the directory where the project is located:
    cd chat-example
    If you are a vue2 project, please make the following corresponding environment configurations based on the Vue version you are using.
    IIf you are a vue2 project, please ignore.
    vue2.7
    Vue 2.6 and below
    npm i vue@2.7.9 vue-template-compiler@2.7.9
    npm i @vue/composition-api unplugin-vue2-script-setup vue@2.6.14 vue-template-compiler@2.6.14
    Please Note:
    Vite requires Node.js versions 18+, 20+. Pay attention to upgrade your Node version when your package manager issues a warning, for more details refer to Vite official website.
    Create a project using Vite, configure Vue + TypeScript according to the options in the picture below.
    npm create vite@latest
    
    Then, switch to the project directory, and install the project dependencies:
    cd chat-example
    npm install
    Install the sass environment dependency required for TUIKit:
    npm i -D sass sass-loader
    

    Step 2. Download the TUIKit component

    Download the TUIKit component through npm. To facilitate your subsequent expansion, it is recommended that you copy the TUIKit component to the src directory of your project:
    macOS
    Windows
    npm i @tencentcloud/chat-uikit-vue
    mkdir -p ./src/TUIKit && rsync -av --exclude={'node_modules','package.json','excluded-list.txt'} ./node_modules/@tencentcloud/chat-uikit-vue/ ./src/TUIKit
    npm i @tencentcloud/chat-uikit-vue
    xcopy .\\node_modules\\@tencentcloud\\chat-uikit-vue .\\src\\TUIKit /i /e /exclude:.\\node_modules\\@tencentcloud\\chat-uikit-vue\\excluded-list.txt

    Step 3. Import TUIKit component

    On the page where you want to display it, simply import the TUIKit component to use it.
    For example, implementing the following code on the App.vue page allows for a quick setup of the chat interface (the following example code supports both Web and H5):
    Note:
    The example code below uses the setup syntax. If your project does not use the setup syntax, please register components according to the standard methods of Vue3/Vue2.
    vue3
    vue2.7
    vue2.6 and below
    <template>
    <div id="app">
    <TUIKit :SDKAppID="0" userID="xxx" userSig="xxx" />
    <TUICallKit class="callkit-container" :allowedMinimized="true" :allowedFullScreen="false" />
    </div>
    </template>
    <script lang="ts" setup>
    import { TUIKit } from './TUIKit';
    import { TUICallKit } from '@tencentcloud/call-uikit-vue';
    </script>
    <style lang="scss">
    </style>
    <template>
    <div id="app">
    <TUIKit :SDKAppID="0" userID="xxx" userSig="xxx" />
    <TUICallKit class="callkit-container" :allowedMinimized="true" :allowedFullScreen="false" />
    </div>
    </template>
    <script lang="ts" setup>
    import { TUIKit } from './TUIKit';
    import { TUICallKit } from '@tencentcloud/call-uikit-vue2';
    </script>
    <style lang="scss">
    </style>
    <template>
    <div id="app">
    <TUIKit :SDKAppID="0" userID="xxx" userSig="xxx" />
    <TUICallKit class="callkit-container" :allowedMinimized="true" :allowedFullScreen="false" />
    </div>
    </template>
    <script lang="ts" setup>
    import { TUIKit } from './TUIKit';
    import { TUICallKit } from '@tencentcloud/call-uikit-vue2.6';
    </script>
    <style lang="scss">
    </style>
    1. Install dependencies supporting composition-api and script setup, as well as dependencies related to vue2.6.
    npm i @vue/composition-api unplugin-vue2-script-setup vue@2.6.14 vue-template-compiler@2.6.14
    2. Import VueCompositionAPI in main.ts/main.js.
    import VueCompositionAPI from "@vue/composition-api";
    Vue.use(VueCompositionAPI);
    3. Add the following in vue.config.js . If the file does not exist, please create it.
    const ScriptSetup = require("unplugin-vue2-script-setup/webpack").default;
    module.exports = {
    parallel: false, // disable thread-loader, which is not compactible with this plugin
    configureWebpack: {
    plugins: [
    ScriptSetup({
    /* options */
    }),
    ],
    },
    chainWebpack(config) {
    // disable type check and let `vue-tsc` handles it
    config.plugins.delete("fork-ts-checker");
    },
    };
    4. At the end of the src/TUIKit/adapter-vue.ts file, replace the export source:
    // Initial notation
    export * from "vue";
    // Replace with
    export * from "@vue/composition-api";

    Step 4: Secure SDKAppID, secretKey, and userID

    Set the relevant parameters SDKAppID, secretKey, and userID in the example code of the main.ts / main.js file:
    SDKAppID and SecretKey can be accessed by the Chat Console:
    
    UserID can be accessed by theChat Console > Account Management. Switch to the target application account to create an account and get the userID.
    

    Step 5. Launch the project

    vue-cli
    vite
    npm run serve
    npm run dev

    Additional item: Switching languages

    The Vue TUIKit comes with default Simplified Chinese, English language packages that serve as the interface display language.
    You may switch languages through the following methods, for more methods please see Internationalization.
    import { TUITranslateService } from "@tencentcloud/chat-uikit-engine";
    // change language to chinese
    TUITranslateService.changeLanguage("zh");
    // change language to english
    TUITranslateService.changeLanguage("en");

    Step 6. Send your first message

    
    

    Step 7: Make your first phone call

    

    FAQs

    Product Service FAQs

    1. The Audio/Video Call Capability package is not activated? Failure to initiate the Audio/Video Call?

    Please click Audio/Video Call > Frequently Asked Questions to view the solutions.

    2. What is UserSig? How is UserSig generated?

    A UserSig is a password with which you can log in to use IM service. It is the ciphertext generated by encrypting information such as userID.
    The issuance of UserSig is achieved by integrating the calculation code for UserSig into your server-side, whilst providing an interface designed for your project. Whenever UserSig is required, your project could request the operational server for a dynamic UserSig. For further information, please refer to Generating UserSig on the server-side.
    Caution
    The method to obtain UserSig demonstrated in this document utilizes the configuration of a SECRETKEY within the client-side code. Within this procedure, the SECRETKEY is notably vulnerable to decompilation and reverse-engineering. Should your SECRETKEY be leaked, malefactors could potentially exploit your Tencent Cloud traffic. Therefore, this technique is only appropriate for local operation and functional debugging. For the correct method of issuing UserSig, please refer to the earlier text.

    Connection Errors FAQs

    1. Runtime error: "TypeError: Cannot read properties of undefined (reading "getFriendList")"

    If the following errors occur during runtime after connecting as per the steps outlined above, it is imperative that you delete the node_modules directory under the TUIKit folder to ensure the uniqueness of TUIKit's dependencies, preventing issues caused by multiple copies of dependencies.
    259937368-f7c85dfe-b4bd-4c73-88d9-3a9f0d7797f2.png (1186×550)
    

    2. How does a JS project integrate the TUIKit component?

    TUIKit exclusively supports the TS environment for operation. You can enable the coexistence of existing JS code in your project with the TS code in TUIKit through progressive configuration of TypeScript.
    vue-cli
    vite
    Please execute the following in the root directory of your engineering project created by the Vue CLI scaffold:
    vue add typescript
    Subsequently, please make selections in accordance with the following configuration options. To assure that we can support both the existing js code and the ts code within TUIKit, it is imperative that you strictly adhere to the five options presented below.
    260706614-5e2fc00b-ace5-4843-bef6-c0e234225b5d.png (1514×360)
    
    Once these steps are completed, please rerun the project!
    Please execute the following command in your project's root directory created with vite:
    npm install -D typescript

    3. Runtime error reported: /chat-example/src/TUIKit/components/TUIChat/message-input/message-input-editor.vue .ts(8,23)TS1005: expected.

    
    The above error message appears because your installed @vue/cli version is too low. You must ensure that your @vue/cli version is 5.0.0 or higher. The upgrade method is as follows:
    npm install -g @vue/cli@5.0.8

    4. Runtime error: Failed to resolve loader: sass-loader

    260897345-1ba994d8-da51-4820-94e7-a7145b34750b.png (690×160)
    
    The above error message appears because the sass environment is not installed on your machine, please run the following command to install the sass environment:
    npm i -D sass sass-loader@10.1.1

    5. Other ESLint errors?

    If copying chat-uikit-vue to the src directory results in error due to inconsistency with your local project code style, you may ignore this component directory. This can be achieved by adding .eslintignore file to the project root directory:
    # .eslintignore
    src/TUIKit

    6. How to disable the full screen overlay error message prompt of webpack in dev mode in vue/cli?

    You can disable it in the vue.config.js file at the root directory of your project:
    webpack4
    webpack3
    module.exports = defineConfig({
    ...
    devServer: {
    client: {
    overlay: false,
    },
    },
    });
    module.exports = {
    ...
    devServer: {
    overlay: false,
    },
    };

    7. What to do when encountering 'Component name "XXXX" should always be multi-word'?

    The version of ESLint utilized in IM TUIKit web is v6.7.2, which does not rigidly verify the camelCase format for module names.
    Should you encounter this dilemma, you may configure as follows in the .eslintrc.js file:
    module.exports = {
    ...
    rules: {
    ...
    'vue/multi-word-component-names': 'warn',
    },
    };

    8. What should I do if I encounter ERESOLVE unable to resolve dependency tree?

    If ERESOLVE unable to resolve dependency tree appears when npm install is run, it indicates a conflict in dependency installation. The following method can be adopted for installation:
    npm install --legacy-peer-deps

    9. How might one address the error message, 'vue packages version mismatch' occurring during execution?

    // If you are using a vue2.7 project, please execute in your project root directory
    npm i vue@2.7.9 vue-template-compiler@2.7.9
    // If you have a Vue2.6 project, please execute in your project's root directory
    npm i vue@2.6.14 vue-template-compiler@2.6.14

    10. Why does TypeScript report an error after npm run build in a Vite project?

    
    Reason: It's led by the vue-tsc command in "build": "vue-tsc && vite build" under package.json script.
    
    Solution: Simply remove vue-tsc. "build": "vite build"
    

    Contact Us

    Join the Telegram technical discussion group or WhatsApp discussion group, enjoy the support of professional engineers, and solve your difficulties.

    Documentation

    Related to Vue2 & Vue3 UIKit:

    Vue2 & Vue3 UIKit logic layer: engine

    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support