Welcome to the Client API Browser - your one stop shop for Client API documentation.
The core class for the Weavy client.
Base class for representation of apps in Weavy.
Class for wrapping native console logging.
Event handling with event propagation and before and after phases.
The event system provides event-chaining with a bubbling mechanism that propagates all the way from the emitting child trigger to the root instance.
NOTE: Each weavy instance has an event handler instance exposed as
weavy.events. So references to
weavyEvents.triggerEvent() in this documentation would translate to
For convenience the
.off() functions are exposed directly on the weavy instance as
They are also exposed as child object functions on spaces and apps as
All events in the client have three phases; before, on and after. Each event phase is a prefix to the event name.
In each phase, the event is propagated to objects in the hierarchy, much like bubbling in the DOM. The event chain always contains at least the triggering object and the root, but may have more objects in between. This means that the root will receive all events regardless of which child-object that was triggering event, but the child objects will only receive the events that they triggered themeselves or any of their child objects triggered.
Cancelling an event by calling
event.stopPropagation() will stop any propagation and cause all the following phases for the event to be cancelled.
Class for handling internal/external navigation
Panel manager for handling for iframes and their communication.
The panel management is split up into a panels container which can contain multiple panels. Each panel is essentialy a wrapped iframe. The panels container provides the possibility to have multiple panels in the same client container and adds the possibility to shift between which panel that is visible in the container as a tab behavior.
Unified promises that can be reset
Base class for representation of spaces in Weavy.
Plugin for displaying alert messages.
Plugin for sign-in panel.
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
This plugin has no exposed properties or options.
Displaying content and attachments in the full browser window.
Inject additional styles into the sealed weavy shadow dom. You may define styles by either setting weavy plugin options or by injecting them via ThemePlugin#addCss