Frontend Plugin API#

NucleI plugins that add user interface run inside the desktop application and talk to it through a single global object, window.Nuclei. This section documents that object and the React hooks and helper types that come with it, generated from the published TypeScript declarations of @tqt-llc/nuclei-stubs version 1.0.0.

What is documented here#

The stub package's entry point, index.d.ts, re-exports the plugin-facing surface from plugin-exports.d.ts, and that file is what this reference is built from:

PluginAPI — the object exposed as window.Nuclei, grouping the UI components, registries and helpers a plugin may use.
usePluginContext, useSharedPluginState, useFlowAPI — React hooks for plugin state and the flow editor.
registerPluginTranslations, usePluginTranslation — plugin localisation.

Those exports, plus every declaration the exports refer to in their signatures, make up the pages below. Application internals that no exported signature mentions are left out, as are the protobuf message wrappers under nu-rpc, which describe the wire protocol rather than the plugin API.

Getting the types in your editor#

Install the stub package as a development dependency of your plugin:

npm install --save-dev @tqt-llc/nuclei-stubs

import type { PluginAPI } from '@tqt-llc/nuclei-stubs';

declare global {
  interface Window {
    Nuclei: typeof PluginAPI;
  }
}

Reference#

Start at plugin-exports, or browse the full module list.