0.1.30 • Published 11 months ago

@ss2d22/chinese-react-chat-engine-advanced v0.1.30

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

一个叉的 'react-chat-engine-advanced' 文本已翻译成中文

存储库链接:https://github.com/ss2d22/chinese-react-chat-engine-advanced

原始存储库链接:https://github.com/chatengine-io/react-chat-engine-advanced

如何使用

使用“npm package”

1) 安装软件包

npm i @ss2d22/chinese-react-chat-engine-advanced

2) 替换进口

import {
  useMultiChatLogic,
  MultiChatSocket,
  MultiChatWindow,
} from "@ss2d22/chinese-react-chat-engine-advanced";

用法与“react-chat-engine-advanced”相同

手动安装 (可以自定义更多)

您还可以使用它来修改 welcome.gif 文本,因为自定义呈现不起作用,或者只将所有文本修改为 diff 语言/you can also use this to modify the welcome.gif text as the custom render does not work or to just modify all the text to a diff language

除了最上面的两句英语之外,整个 readMe 都是中文的/This entire readMe is in chinese other than these two sentences at the top in english and you only need to do the steps below once when you share your project repository to anyone the patch is auto applied when they 'npm intstall' or when you 'npm install' again after deleting 'node_modules' as long as you do not delete the automatically generated 'patche' folder

当您将项目存储库共享给任何人时,您只需要执行以下步骤一次,只要不删除自动生成的“patche”文件夹,当他们使用“npm intstall”或删除“node_modules”后再次使用“npm install”时,补丁就会自动应用

1) 克隆存储库

git clone https://github.com/ss2d22/chinese-react-chat-engine-advanced.git

cd chinese-react-chat-engine-advanced

2) 为 npm 添加镜像(如果你在中国):

在项目的根目录下创建一个.npmrc 文件,并粘贴以下内容:

+ registry=https://registry.npm.taobao.org/
+ disturl=https://npm.taobao.org/dist
+ chromedriver_cdnurl=http://cdn.npm.taobao.org/dist/chromedriver
+ operadriver_cdnurl=http://cdn.npm.taobao.org/dist/operadriver
+ phantomjs_cdnurl=http://cdn.npm.taobao.org/dist/phantomjs
+ sass_binary_site=http://cdn.npm.taobao.org/dist/node-sass
+ electron_mirror=http://cdn.npm.taobao.org/dist/electron/
+ selenium_cdnurl=http://npm.taobao.org/mirrors/selenium
+ node_inspector_cdnurl=https://npm.taobao.org/mirrors/node-inspector

要复制和粘贴:

registry=https://registry.npm.taobao.org/
disturl=https://npm.taobao.org/dist
chromedriver_cdnurl=http://cdn.npm.taobao.org/dist/chromedriver
operadriver_cdnurl=http://cdn.npm.taobao.org/dist/operadriver
phantomjs_cdnurl=http://cdn.npm.taobao.org/dist/phantomjs
sass_binary_site=http://cdn.npm.taobao.org/dist/node-sass
electron_mirror=http://cdn.npm.taobao.org/dist/electron/
selenium_cdnurl=http://npm.taobao.org/mirrors/selenium
node_inspector_cdnurl=https://npm.taobao.org/mirrors/node-inspector

3) 安装依赖项

npm i

4) 构建项目

npm run build

如果不起作用,请删除 dist 文件夹,然后重试

5) 转到要在其中使用此功能的项目的文件夹

cd /路径/到/你的/项目
npm install react-chat-engine-advanced --save

例子:

cd /Users/sriram/developer/medai/medai
npm install react-chat-engine-advanced --save

在这里进入你自己的项目,你的道路会有所不同

6) 安装"patch-package”包裹

npm i patch-package

在 package.json 中 :

 "scripts": {
+  "postinstall": "patch-package"
 }

要复制和粘贴:

"postinstall": "patch-package"

7) cd 放入模块文件夹

cd node_modules/react-chat-engine-advanced

8) 更新此文件夹中的文件

rm -rf dist src

cp -R /路径/到/chinese-react-chat-engine-advanced/dist ./

cp -R /路径/到/chinese-react-chat-engine-advanced/src ./

例子:

rm -rf dist src

cp -R /Users/sriram/developer/chinese-react-chat-engine-advanced/dist ./

cp -R /Users/sriram/developer/chinese-react-chat-engine-advanced/src ./

9) 应用并保存补丁

cd ../../

npx patch-package react-chat-engine-advanced

不要删除自动生成的“patches”文件夹

10) 清除缓存并重新启动项目

根据您使用的 react 框架,您可能需要再次删除node_modules文件夹和npm install

无论框架如何,最简单的方法是:

rm -rf node_modules

npm install

11) 重新启动“dev server”

例子:

npm run dev

原始存储库中的自述文件翻译成中文如下:

聊天引擎

聊天引擎是一个开发者友好的聊天 UI 工具包.

在以下网址设置免费计划 chatengine.io

特征

  • Typescript (从 2.0.0 开始)
  • 注册/身份验证
  • 设置聊天
  • 发送消息
  • 发送文件和照片
  • 通过 Sockets 订阅聊天
  • 邀请/删除聊天成员
  • 无尽的聊天滚动
  • 无尽的消息滚动

安装

  • 使用 npm: npm install react-chat-engine-advanced --save
  • 使用 Yarn: yarn add react-chat-engine-advanced

快速入门

在 3 分钟内将无服务器聊天添加到您的 React 应用程序中。

  1. 注册后,在以下网址创建projectuserchatengine.io

  2. 收集 Project ID / username / User Secret

  3. 安装 yarn add react-chat-engine-advanced

  4. 进口 MultiChatWindow, MultiChatSocket, 和 useMultiChatLogic

  5. 声明 const props = useMultiChatLogic(projectId, username, secret); 并通过返回 props 对象进入 MultiChatWindowMultiChatSocket.

  6. 瞧!你完了

示例实现 ⬇️

import React from 'react';

import {
  ChatEngine,
  MultiChatSocket,
  useMultiChatLogic,
} from 'react-chat-engine-advanced';

export function App() {
  const chatProps = useMultiChatLogic(
    'b75e5bd5-cd84-404c-b820-06feff8c98c0',
    '贝贝',
    '1234'
  );
  return (
    <>
      <MultiChatWindow {...chatProps} />
      <MultiChatSocket {...chatProps} />
    </>
  );
}

Props

  • projectId (String 必修的) - chatengine.io 项目的公共 API 密钥
  • username (String 必修的) - 此项目中人员的用户名
  • secret (String 必修的) - 为此人设置一个秘密并使用它进行身份验证。
  • onConnect (Function) - 连接/身份验证完成时回调
  • onFailAuth (Function) - 连接/身份验证失败时回调
  • onGetChats (Function) 当该人获取他们的聊天数组时进行回调
  • onNewChat (Function) - 当该人创建新聊天时回调
  • onEditChat (Function) - 当用户编辑聊天标题时回调
  • onDeleteChat (Function) - 当该人删除他们的一个聊天记录时进行回调(必须是聊天记录的管理员)
  • onAddPerson (Function) - 当一个人被添加到聊天时回调
  • onRemovePerson (Function) - 当某人从聊天中删除/删除时进行回调
  • onGetMessages (Function) - 当对方收到聊天消息时进行回拨
  • onNewMessage (Function) - 当一个人在聊天中发布新消息时进行回调
  • onEditMessage (Function) - 当一个人在聊天中编辑新消息时进行回调
  • onDeleteMessage (Function) - 当一个人删除其中一个聊天中的新消息时进行回调
  • hideUI (Boolean) - 隐藏自定义实现的所有 UI 组件(警告:高级)

警告

react-chat-engine-advanced 不适用于 react StrictMode。请从您的项目中删除 <React.StrictMode>