Skip to content

PLUGINS.md

Latest commit

 

History

History
26 lines (17 loc) · 1.61 KB

PLUGINS.md

File metadata and controls

26 lines (17 loc) · 1.61 KB
Raw

Trakli UI plugins

Set TRAKLI_UI_LAYERS to a comma-separated list of installed Nuxt layer paths before development or build. Paths are relative to the web UI checkout, or absolute.

TRAKLI_UI_LAYERS=/path/to/plugin/ui npm run dev
TRAKLI_UI_LAYERS=/path/to/plugin/ui npm run build
TRAKLI_UI_LAYERS=/path/to/plugin/ui npm run test:run
TRAKLI_UI_LAYERS=/path/to/plugin/ui npm run check:plugins

Without this setting, the app loads no optional plugin layers. A layer supplies its pages, translations and optional components. Keep the matching backend plugin enabled. Installing or removing a layer requires restarting development or rebuilding the app.

Backend integration descriptors insert links into the existing sidebar and settings slots. Links to local routes are hidden when the route is absent. Custom controls can still register through useExtensionSlots().registerComponent().

A plugin adds its own Settings tab by listing settings.tabs in its descriptor slots and describing the tab:

'tab' => ['key' => 'banks', 'title' => 'Bank connections', 'component' => 'plaid.settings', 'order' => 20],

The layer registers the tab body under the same component key from a Nuxt plugin. The tab appears once both exist, at /settings?tab=<key>. Lower order values come first.

Layer pages use the host's authentication middleware, layouts, components and API client. Keep provider return URLs on the same browser hostname as the UI to preserve login cookies.

Plugin tests live under the layer's tests directory. The host test runner includes tests from the configured layers and supplies its aliases and dependencies.