WidgetsViewApi

interface

Controls the floating surfaces your mod declared with `widget(...)`. Widgets are declared once and shown on demand. This is the show and hide side of that; the declaration decides what renders.

interface WidgetsViewApi

Import

import { WidgetsViewApi } from '@modular/sdk';

Members3

dispose: (widgetId: string) => Promise<void>
Destroys the widget and its webview. The next `show` builds a new one.
hide: (widgetId: string) => Promise<void>
Takes it off screen. The webview survives, so `show` resumes it.
show: (widgetId: string, options?: WebviewWidgetShowOptions) => Promise<void>
Opens the widget, or lays out an open one.

Notes

category: Context