chat-engine-typing-indicator
v0.0.10
Published
Adds the ability to show a typing indicator on a ChatEngine Chat
Downloads
25
Maintainers
Keywords
Readme
Typing Indicator Plugin for ChatEngine
Adds the ability to show a typing indicator on a ChatEngine Chat
Quick Start
- 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', () = { ... });
- Attach this plugin to the channel you want, in this case global
ChatEngine.global.plugin(ChatEngineCore.plugin['chat-engine-typing-indicator']());
- 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();
- 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 [email protected]