Interface: FrontendPluginApi

Defined in: packages/plugin-sdk/src/frontend.ts:194

The API object handed to a plugin's activate().

Properties

events

readonly events: PluginEventBus

Defined in: packages/plugin-sdk/src/frontend.ts:196

---

i18n

readonly i18n: PluginI18nApi

Defined in: packages/plugin-sdk/src/frontend.ts:197

---

interceptors

readonly interceptors: Registrar<PromptInterceptorDef>

Defined in: packages/plugin-sdk/src/frontend.ts:212

---

pluginId

readonly pluginId: string

Defined in: packages/plugin-sdk/src/frontend.ts:195

---

slash

readonly slash: Registrar<SlashCommandDef>

Defined in: packages/plugin-sdk/src/frontend.ts:211

---

ui

readonly ui: object

Defined in: packages/plugin-sdk/src/frontend.ts:198

characterTabs

characterTabs: Registrar<CharacterTabDef>

commands

commands: Registrar<CommandPaletteDef>

contextMenuItems

contextMenuItems: Registrar<ContextMenuItemDef>

dialogs

dialogs: Registrar<DialogDef>

hotkeys

hotkeys: Registrar<HotkeyDef>

messageActions

messageActions: Registrar<MessageActionDef>

messageRenderers

messageRenderers: Registrar<MessageRendererDef>

pages

pages: Registrar<PageDef>

settingsPanels

settingsPanels: Registrar<SettingsPanelDef>

sidebarPanels

sidebarPanels: Registrar<SidebarPanelDef>

toolbarActions

toolbarActions: Registrar<ToolbarActionDef>

Methods

notify()

notify(notification): Unregister

Defined in: packages/plugin-sdk/src/frontend.ts:214

Show a notification; returns a function to dismiss it early.

Parameters

notification

NotificationDef

Returns

Unregister