Client API Browser

Welcome to the Client API Browser - your one stop shop for Client API documentation.

Client Core



The core class for Weavy.


alert Weavy.plugins.alert

Plugin for displaying alert messages.

attach Weavy.plugins.attach

Filepicker plugin for attaching from Google, O365, Dropbox etc. It listens to request:origin messages from frames and responds to the source with a origin message containing the window.location.origin.

This plugin has no exposed properties or options.

authentication Weavy.plugins.authentication

Plugin for signing in and out

panels Weavy.plugins.panels

Creating and handling panels that has frames for app pages. Panels are mostly automatically managed and preloaded when needed.

preview Weavy.plugins.preview

Displaying photoswipe and pdfs in the full browser window.

sso Weavy.plugins.sso

Single sign on authentication. Configure weavy for single sign on then provide your external:jwt via this plugin to sign in automatically. The weavy.load event waits for sso to complete before it is fired.

theme Weavy.plugins.theme

Inject additional styles into the sealed weavy shadow dom. You may define styles by either setting weavy plugin options or by injecting them via theme#addStyles

Client Extended


badge Weavy.plugins.badge

Plugin for displaying badges/dots

bubbles Weavy.plugins.bubbles

State machine for bubbles.

context Weavy.plugins.context

Handles location changes and context features. Adds connect and disconnect buttons to bubble icons in the dock.

dock Weavy.plugins.dock

The main dock containing bubble buttons and panel managment.

fallback Weavy.plugins.fallback

Displaying panels in a popup window when frames are blocked. It handles when weavy.isBlocked is true. If a weavy browser extenstion is active it will try to use it for managing the popup window.

messenger Weavy.plugins.messenger

Plugin for handling the Weavy Messenger. It also adds the messenger to the dock and displays unread conversations.

notifications Weavy.plugins.notifications

Displays notifications in the context window. The notifications are placed in the weavy.nodes.overlay.

personal Weavy.plugins.personal

Personal panel with user propfile, notifications, stars and drafts.

position Weavy.plugins.position

Collapsing dock and drag'n'drop positioning

start Weavy.plugins.start

The Weavy start page, which serves as Open/Search/Home/People/Spaces.

upgrade Weavy.plugins.upgrade

Checks if weavy needs to be upgraded on Weavy#event:options event.