goinstant / chat Goto Github PK

The GoInstant Chat widget provides real-time chat to users inside a room of your application.. This repo will no longer be updated. GoInstant will be discontinued as of August 31, 2014. Read our blog for more details.

Home Page: https://goinstant.com

License: BSD 3-Clause "New" or "Revised" License

JavaScript 98.30% CSS 1.70%

chat's Introduction

Chat Widget

The GoInstant Chat widget provides real-time messaging inside a room of your application.

Have questions? Contact us using this form or chat with us on IRC. #goinstant on Freenode.

Packaging

For your convenience, we've packaged the Chat widget in several ways.

Using our CDN

We host a copy on our CDN. Have a look at the docs to see how to reference those files, as well as how to initialize the component.

How do I build the script myself?

You may have your own build process. We've tried to make it easy to include the Chat widget in your build process.

Bower

We've packaged the Chat widget as a bower component.

bower install goinstant-chat

Component

We've packaged the Chat widget as a component.

component install goinstant/chat

Contributing

Development Dependencies

node.js >= 0.8.0
grunt-cli installed globally
- npm install -g grunt-cli

Set-Up

The following assumes that you have already installed the dependencies above.

git clone https://github.com/goinstant/chat.git
cd chat
npm install

Building Chat for Development

The Chat widget is built as a component. Feel free to manually install dependencies and build using the component command line tool.

For convenience, we've included a simple grunt command for installing component dependencies and building:

grunt build

If this command runs succesfully you'll now have components and build directories in your Git repo root.

Running Tests

Tests are written in mocha. They're run in an HTML file.

Just open the test/index.html file to run the tests.

On Mac OS, you can just run this command to open the HTML Runner in your default browser:

open test/index.html

Running Examples

This will open up an example of Chat at work, using your local build.

You should have run grunt build already.

1. Copy the example config.

cp config/config.example.js config/config.js

2. Replace the connectUrl with your GoInstant application's connectUrl.

If you haven't signed up for GoInstant yet, you can sign up and create an application here.

After you have an application's connectUrl, set inside of config.js:

config.js

window.config = {
  connectUrl: 'https://goinstant.net/YOUR_ACCOUNT/YOUR_APP',
  room: 'goinstant-widget-examples'
};

3. Open the example index and click an example.

open examples/index.html

Widgets are built on top of GoInstant

GoInstant is an API for integrating realtime, multi-user functionality into your app. You can check it out and sign up for free.

License

Licensed under the BSD 3-clause license.

chat's People

Contributors

Stargazers

Watchers

Forkers

krprasadreddy minahan alisheikh hecharles johnhenry ngertrudiz xcopyco leduong paragjawale abhijeetd01

chat's Issues

Open source chat widget

Put in a todo list for this please.

Add ability to change username from chat widget

I'll leave the UX + UI suggestions up to @ntassone

tests: sinon error: key#on

sinon error: TypeError: argument at index 2 is not a function: undefined

culprite:

on: sinon.stub().callsArg(2)

Move collapse class to wrapper

Currently the collapse button toggles a class .collapsed on a few individual elements, it should be applied to .gi-chat with the class name .gi-collapsed to keep consistent with the other widgets (user-list specifically).

Limit amount messages displayed and add ability to "load more"

For performance reasons we should limit the amount of messages that will appear in the chat widget, if you scroll to the top you should be able to "load more" messages.

The maximum number of messages to display could be an option.

Add chat examples

Make sure quotes and other symbols work

In chat things like " should work.

Store message in progress

If I am typing a message and navigate to another page with the chat widget, it would be nice if my chat message I was in the middle of typing was there on the next page. Currently, when you leave the current page, you lose everything in your text box.

EDIT: This will help if someone navigates during a collaboration bundle session, and the people they're in the session with are typing at the time.

{
  windowBlink: true,
  chatBlink: true,
  blinkText: 'New Message',
  sound: true,
  soundURL: 'https://cdn.goinstant.net/widgets/chat/latest/chat/sounds/ding.mp3'
}

windowBlink: If window is not focused, blink the page title with "New Message" until window gets focused.
chatBlink: If chat is collapsed, blink the chat header with "New Message" until chat gets expanded.
sound: If window is not focused or chat is collapsed play sound once.