PluginUI
The editor’s own messages and frames, in its style and language. Plugin
DOM picks up the theme through its CSS custom properties (–wbe-*), and
the wbe-btn and wbe-input classes.
Methods
Section titled “Methods”confirm()
Section titled “confirm()”confirm(options): Promise<boolean>;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options |
{ body: PluginText; confirmLabel: PluginText; title: PluginText; } |
options.body |
PluginText |
options.confirmLabel |
PluginText |
options.title |
PluginText |
Returns
Section titled “Returns”Promise<boolean>
dialog()
Section titled “dialog()”dialog(options): Promise<string | null>;A dialog in the editor’s frame, with its focus handling. Resolves with the action chosen, or null when it is closed.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options |
PluginDialog |
Returns
Section titled “Returns”Promise<string | null>
registerPanel()
Section titled “registerPanel()”registerPanel(panel): () => void;A side panel beside Issues, Changes and the report, with a button to show it. Returns a function that removes it.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
panel |
PluginPanel |
Returns
Section titled “Returns”() => void
toast()
Section titled “toast()”toast(kind, text): void;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
kind |
"error" | "info" |
text |
PluginText |
Returns
Section titled “Returns”void