Widgets
| Widget | ID | API | For |
|---|---|---|---|
| Chat | chat | Documented | Messages, files, voice and video messages between participants. |
| Whiteboard | whiteboard | — | A shared drawing surface over your page. |
| Notes | notes | — | Meeting notes grouped by day and meeting. |
| Voting | voting | Documented | Polls with live results. |
| Planning poker | planning-poker | — | Estimate tasks with Fibonacci or T-shirt cards. |
| Retrospective board | retro-board | — | Retrospectives in writing, voting and discussion phases. |
| Approval and decision cards | approval-cards | Documented | Collect approvals and decisions from participants. |
| Reactions | reactions | Documented | Emoji reactions that float over the page for everyone. |
| Raise hand | raise-hand | Documented | A queue of raised hands. |
| Recording Demos | recording-demos | Documented | Record and replay demos, capture issues, report your app's events. |
| Distributed Neural Training | distributed-training | Documented | Train a neural network together in participants' browsers. |
| Transcription | transcription | — | Live speech-to-text in the browser. |
| Shared document preview | shared-document-preview | — | Review a PDF, image or text file together. |
| AI assistant | ai | — | An AI chat inside your page. |
| Parallel computing | parallel-computing | — | A demonstration of splitting a computation between participants. |
| Connection diagnostics | ping, peer-time, topology, rtc-debug | — | Ping, clock offset, network map and connection logs. |
Every widget is described on its own page. Widgets marked — have no API: they are opened and used from the control panel or with widgetsApi.
widgetsApi
interface WeeiWidgetsApi {
enable(widgetId: string): void | Promise<void>;
disable(widgetId: string): void;
toggle(widgetId: string): void | Promise<void>;
get<TApi extends object>(widgetId: string): TApi | undefined;
}| Method | Behavior |
|---|---|
enable(id) | Opens the widget. It may load the widget first, so await it. |
disable(id) | Closes the widget. Mandatory widgets cannot be closed. |
toggle(id) | Opens or closes the widget. |
get(id) | Returns the widget's API, or undefined if the widget is unavailable or has no API. Some APIs work only while the widget is open; each widget page says when its API is available. |
These methods do not grant access: a widget not enabled for your site stays unavailable. Always handle undefined from get(), and look the API up again each time you use it — reopening a widget replaces it.
const weei = await window.weeiReady;
await weei.widgetsApi.enable('reactions');
const reactions = weei.widgetsApi.get('reactions');
if (reactions) reactions.send('👍');
else console.warn('Reactions are not enabled for this site.');