Skip to content

Frontend overview ​

The frontend is optional: frontend/index.ts, widgets, and Vue code in the browser. Backend is optional too (frontend-only plugins are valid).

Two doc tracks ​

TrackWhat it covers
How to useRequired wiring: index.ts, usePluginApi, i18n, generated-config, themes
Golden PathFile layout: widget contract, *Widget.vue as entry, shared components/ / composables/

Backend-generated generated-config.ts connects HTTP to $data when you have a backed side β€” see How to use β€” generated-config.

Minimal tree ​

frontend/
β”œβ”€β”€ index.ts
└── widgets/MyThing/MyThingWidget.vue

Where to go next ​

  1. How to use β€” Plugin index
  2. How to use β€” usePluginApi
  3. Golden Path β€” Widgets
  4. Frontend reference (full map)