Skip to content

Design: Apps

Pablo Mayrgundter edited this page Feb 8, 2024 · 4 revisions

Share is being developed to host applications from third-party developers.

Share has an App Drawer for hosting an App in an iframe that communicates with Share via Matrix.org's Widget API. The communication is 2-way, and allows customization and driving behavior of the UI, or actions in the UI driving behavior in the App.

Status

This feature is a Work in Progress/DEMO Stage. Please join Discord and discuss your interest/use-cases on #share.

See these PRs for progress:

https://github.com/bldrs-ai/Share/pulls?q=is%3Apr+is%3Aclosed+matrix

Design

Feature Flag

There is a Feature Flag to enable Apps.

API

The App communicates with Share via the URL changes, state tokens and the Matrix Widget API.

Embedded Application Tokens

Embedding via IFrame should register permalink state with Embedded Application Tokens.

Matrix Widget API

The Matrix Widget API wraps the standard browser API window.PostMessage from SendMessage Web API with a custom message format that is designed also for syndication over Matrix.org's social protocol.

See matrix-widget-api.

Clone this wiki locally