Event listener registration for the specific app. Only recieves events that belong to the app.

weavy.space("myspace").app("myapp").on("open", function(e) { ... })

One time event listener registration for the specific app. Is only triggered once and only recieves events that belong to the app.

weavy.space("myspace").app("myapp").one("open", function(e) { ... })

Event listener unregistration for the specific app.

weavy.space("myspace").app("myapp").off("open", function(e) { ... })

Triggers events on the specific app. The events will also bubble up to the space and then the weavy instance.

weavy.space("myspace").app("myapp").triggerEvent("myevent", [eventData])

Triggered when the app panel is opened.

Triggered when the app panel is toggled. Is always followed by either open event or close event.

Triggered when the app panel is closed.

Triggered when the app receives a postMessage sent from the panel frame.

Configure the app with options or data. If the app has data it will also be built. Currently existing options are extended with new options. Data will resolve whenLoaded promise.

Sets options and fetches (or creates) the app on the server. Options will replace existing options. When data is fetched, the whenLoaded promise is resolved.

Builds the app. Creates a shadow root and a panel. Is executed on the build event.

Removes the app in the client and the DOM. The app will not be removed on the server and can be added and fetched at any point again.

Check if another app or an object is matching this app. It checks for a match of the id property or the key property.

Options for defining the app. Key and type is required.

space.app({
  key: "mykey",
  name: "Posts",
  type: "posts",
  container: "#myappcontainer",
  open: false,
  controls: true
});

Opens the app panel and optionally loads a destination url after waiting for whenBuilt. If the space is tabbed it also closes the other apps in the space.

Closes the app panel.

Toggles the app panel open or closed. It optionally loads a destination url on toggle open. If the space is tabbed it also closes the other apps in the space.

Sends postMessage to the app panel frame. Returns a promise that is resolved when the message has been delivered and rejected if the message fails or has timed out.

Promise that resolves when the app is loaded.

Promise that resolves when the app is built.

The container passed in from options.

The root object for the container of the app.

The Panel displaying the app.

The url of the app, received from app data.

The server id of the app, received from app data.

The name of the app, defined in options or received from app data.

The key of the app, defined in options or recieved from app data.

The guid of the app type. May also be used to define the app type in options.

The short readable type of the app, such as "files" .

The full type name of the app, such as "Weavy.Core.Models.Files".

Will the app open automatically when loaded? Defaults to true.

The Weavy instance the app belongs to.

The WeavySpace the app belongs to.

The server data for the app.

{
  id: 2136,
  guid: "523edd88-4bbf-4547-b60f-2859a6d2ddc1",
  key: "files",
  name: "Files",
  url: "/e/apps/2136",
  typeName: "Weavy.Core.Models.Files",
  options: {
    key: "files",
    type: "files"
  }
}

Is the app currently open? Returns the open status of the app panel.

Has the app loaded?

Is the app built?