User List Widget

The GoInstant User List widget provides a real-time connected list of users inside a room of your application.

Sign up and build a GoInstant application today. You can learn more in our guides, and documentation.

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

Packaging

For your convenience, we've packaged the User List 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 User List widget in your build process.

Bower

We've packaged the User List widget as a bower component.

bower install goinstant-user-list

Component

We've packaged the User List widget as a component.

component install goinstant-user-list

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/user-list.git
cd user-list
npm install

Building User List for Development

The User List 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 User List 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

© 2013 GoInstant Inc., a salesforce.com company

Licensed under the BSD 3-clause license.