Frontend reference (entry)
Where to start
How to use for required APIs, then Golden Path for file layout. This page is a map only.
How to use (required wiring)
| Topic | Page |
|---|---|
frontend/index.ts | Plugin index |
| Runtime API | usePluginApi |
generated-config.ts | Consuming generated-config |
| Translations | i18n |
| App theme | Themes |
Golden Path (structure)
| Topic | Page |
|---|---|
| Overview | Golden Path — Frontend |
| Widget contract | Widgets |
| Vue layout | Vue structure |
Advanced (Plugin Development → Advanced)
| Topic | Page |
|---|---|
| URL read/write, pagination | Routing & URL state |
| Exports & styles | Exporting components & styles |
| Workbench admin UI | Workbench plugin settings |
FAQ detail
| API | FAQ |
|---|---|
| Overview | usePluginApi |
$data | dataApi |
$store | storeApi |
$socket | socketApi |
$eventbus | eventApi |
$i18n | i18n |
$log | logApi |
| Generated file | generatedConfig |
Backend
| Topic | Page |
|---|---|
| Generation | Frontend entity mapping |
| Routes | Backend — Routes |