Client SDK

The Weavy Client SDK is a javascript library that you add to your existing app or website. The library enables you to quickly embed collaboration features such as messaging, document collaboration, and more.

To get a better understanding of the client SDK there are some important concepts that you should be aware of.

Weavy instance

The Weavy instance is the main entry point used when embedding Weavy. It sets up a connection to a Weavy server and handles realtime communication, event distribution, panel management and more.

Embedding Weavy into an application starts with adding a reference to the Weavy javascript file and initializing a new Weavy instance:

<script src="weavy.js"></script>
<script>var weavy = new Weavy();</script>

Panels

The basic building blocks you will use when embedding Weavy are called panels. A panel is essentialy an iframe enriched with communication features and managed by a Weavy instance. Each Weavy instance can manage one or more panels. Typically a panel is used to display a Weavy component such as an app, a space or the messenger, but it can be configured to show any desired page.

Plugins

The Client API is composed of plugins that each provides their own functionality and settings such as panel management, authentication etc. It is also possible to extend the client by creating and adding your own plugins.

Core and extended

The client is available in two packages. The core package contains everything you need to work with panels. The extended package also contains additional plugins to build up the full Drop-In UI known as the Dock.

The Dock

The Dock is a component that handles panels dynamically, much like handling apps on your phone or handling tabs or webpages in your browser. The Dock is only available when you use the extended client package.