matrix-widget-api

import { WidgetApi, MatrixCapabilities, WidgetApiToWidgetAction } from 'matrix-widget-api'; // In a widget: const widgetId = null; // Supply widget ID if known, otherwise null const api = new WidgetApi(widgetId); // Request necessary capabilities early api.requestCapability(MatrixCapabilities.Screenshots); api.requestCapabilities([MatrixCapabilities.Stickerpicker, MatrixCapabilities.SendEvent]); // Add custom action handlers if your widget needs to respond to specific events api.on(`action:${WidgetApiToWidgetAction.UpdateVisibility}`, (ev) => { ev.preventDefault(); // Indicate that this widget is handling the event console.log("Visibility updated:", ev.detail); // Custom handling logic here api.transport.reply(ev.detail, {}); // Acknowledge receipt }); api.on("action:com.example.my_custom_action", (ev) => { ev.preventDefault(); console.log("Received custom action:", ev.detail); api.transport.reply(ev.detail, { status: "received", processed: true }); }); // Start the communication messaging api.start(); // If your widget doesn't need to wait for an iframe load event, inform the client it's ready // (Important for widgets that initialize quickly) api.sendContentLoaded(); // Later, send messages or update widget state api.setAlwaysOnScreen(true); // Example: request the client to keep the widget always visible api.transport.send("com.example.another_action", { data: "hello from widget" }); console.log("Widget API initialized and started.");