chat-engine-typing-indicator

0.0.10 • Public • Published

Typing Indicator Plugin for ChatEngine

Adds the ability to show a typing indicator on a ChatEngine Chat

Quick Start

  1. Have a ChatEngine server running already, instantiate a client and connect it
const ChatEngine = ChatEngineCore.create({
    publishKey: 'pub-key-here',
    subscribeKey: 'sub-key-here'
});
 
ChatEngine.connect('Username');
ChatEngine.on('$ready', () = { ... });
  1. Attach this plugin to the channel you want, in this case global
ChatEngine.global.plugin(ChatEngineCore.plugin['chat-engine-typing-indicator']());
  1. The plugin needs to be notified when the user is considered typing or not typing
// emits the $typingIndicator.startTyping event
ChatEngine.global.typingIndicator.startTyping();
// emits the $typingIndicator.stopTyping even - default state
ChatEngine.global.typingIndicator.stopTyping();
  1. Listen for the events
ChatEngine.global.on('$typingIndicator.startTyping', (payload) => {
    console.log(payload.user + "is typing...");
});
ChatEngine.global.on('$typingIndicator.stopTyping', (payload) => {
    console.log(payload.user + "is not typing.");
});

Support

  • If you need help, have a general question a feature request or to file a bug, contact support@pubnub.com

Readme

Keywords

none

Package Sidebar

Install

npm i chat-engine-typing-indicator

Weekly Downloads

7

Version

0.0.10

License

none

Unpacked Size

382 kB

Total Files

11

Last publish

Collaborators

  • client-engineering-bot
  • stephenlb
  • pubnub-admin
  • ianjennings
  • raimondi1337
  • ajb413
  • madisonsmith
  • crgbaumgart