pwfe-im
pwfe-im
npm i pwfe-im
pwfe-im

pwfe-im

palmg React instant messaging component

by palmg

1.0.16 (see all)License:MITTypeScript:Not Found
npm i pwfe-im
Readme

用React实现的轻便及时通讯工具,用于web端。支持浏览器源生websocketsocket.io的方式。 工程已经把样式组件单独抽离出来,可以自己实现前后端交互层。

安装

npm install pwfe-im

使用

通过React组件的方式使用:

import React from 'react'
import {render} from 'react-dom'
import IM from 'pwfe-im'
const user = {
        avatar: 'http://myPicture'
        name:'myName'
    },
    url='ws://domian:8080/path',
    handleClose = ()=>{}
render(<IM user={user} url={url} onClose={handleClose}/>)

直接使用样式组件:

import React from 'react'
import {render} from 'react-dom'
import Chat from 'pwfe-im/chat'
const user = {//聊天对象信息
        avatar: 'http://myPicture'
        name:'myName'
    },
    list = [{//聊天列表
        type: 'receive',
        msg: '接受到的消息',
        timestamp: new Date().getTime()
    }, {
        type: 'send',
        msg: '发送的消息',
        timestamp: new Date().getTime() + 100000
    }]
render(<Chat user={user} chatList={list}/>)

参数说明

Im工具(pwfe-im)

接口说明
user聊天对象信息,2个参数avatarname
avatar:头像,应该是一个网络地址或base64编码。
name:名称。
url发送到服务器建立链接的url参数。
onClose当用户点击关闭或者发送其他关闭事件时(无法连接服务器、服务器关闭等)会调用这个方法。聊天窗口是否显示由使用者控制。
typewebsocket的模式,目前支持'standard''socketIo'。默认值为'standard'。
standard :按照w3c规范实现,使用浏览器底层接口。只能在可支持的浏览器上使用。
socketIo:使用https://socket.io/实现,对浏览器又更好的兼容性。但是需要后台服务器也是要对应的方案。
channel链接频道,socket.io用于标记链接频道。需要根据服务器配置。
middleware用于处理收发消息的中间件。可以在收到会发送消息的时候对消息本身进行处理。结构为{onSend:()=>{//},onMsg:(msg)=>{//}}
onSend:是用于处理发送消息的中间件。当用户触发发送消息事件时,会经过这个中间件进行一次处理。返回true表示使用原数据,返回false表示该数据不提交服务器,返回一个新的字符串会将该字符串发送给服务器。
onMsg:是用于处理接受消息的中间件。用组件接收到服务器发送过来的消息时会经过这个中间件进行一次处理。返回true表示使用原数据,返回false表示该数据不显示在聊天窗口,返回一个新的字符串会将该字符串显示在聊天窗口。
默认值都是返回原始数据。
style设定最外层
的样式。例如<Im style={{letf:'20rem'}}>
className设定最外层
的css。<Im className="myCss">

Im样式组件(pwfe-im/chat)

接口说明
user聊天对象信息,2个参数avatarname
avatar:头像,应该是一个网络地址或base64编码。
name:名称。
chatList聊天列表,用于在窗口创建只时候就显示聊天内容。结构为[{type:'',msg:'',timestamp: 时间搓}]
type: 取值receive或send。receive表示接受到的消息,send表示本地发送出去的消息。
msg:发送或接收的消息。
timestamp:消息发生的时间搓。
error错误信息,当这个值存在时,聊天窗口会出现遮罩层并显示设定的错误信息。
send发送消息的处理器。当用于触发发送消息事件时,这个方法会被调用。(msg, timestamp)=>{}
setOnMsg用于设置一个接收消息的处理器,当外部设置这个参数后。Chat组件会调用这个方法设置一个消息触发器给使用着。Chat内部会执行setOnMsg((msg, timestamp)=>{//更新数据到聊天窗口})而使用着,直接使用这个方法即可更新聊天信息。
onClose关闭按钮被点击。

例子使用说明

在example中提供了测试的代码。

  • 首先npm install 安装package中的依赖。
  • example中已经简单实现了一个websocket服务 example/server/index.js。运行npm run server命令即可启动。
  • 服务器启动之后,用webpack运行客户端的demo:npm run demo
  • 浏览器输入 http://localhost:8080/ 可以看到效果。
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate