Skip to content

wieden-kennedy/composite-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

composite-client

Client-side library for connecting to Composite backend service

Installing

Download or clone the /build/min/composite.min.js into your site. It’s possible to use RequireJS or Browserify as well (see below). Include the file like any other script <script src=”{directory}/composite.min.js”></script>.

Using

The composite file exposes a Composite constructor that you’ll use to connect, send messages, and listen for events on. A simple example would be:

// Instantiate the library, connect, and listen for a response
var composite = new Composite();
composite.on(‘init’, function(response) {
    console.log(response);
});

composite.connect(‘http://yourUrlHere/composite’);

Documentation

For complete documentation, view:

About

Client companion to Composite framework

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published