Component page template
Use this outline when documenting a dashboard widget. Create two pages when the same React component is used in both generations but contracts differ: one under dashboard-components/legacy/, one under dashboard-components/next/.
1. Summary
What the component shows and typical use cases.
2. Dashboard generation
| Legacy (v1) | Next (v2) | |
|---|---|---|
| Runner node | dashboard | dashboard-v2 |
| Frontend | ui/legacy | ui/dashboard |
3. Layout mount identifier (Legacy only)
Exact string for layoutConfiguration.cols[].component. Case-sensitive. See Legacy mount registry.
4. Data payload key(s) (Legacy only)
Top-level key(s) in the dashboard node output JSON (often different from the mount id).
5. Layout / panel wiring
Legacy: row/col array. Next: components.rows entry with configuration.
6. Configuration
Table of parameters, types, defaults, and when to use them.
7. Data contract
Field-by-field JSON shape.
8. Examples
Minimal and advanced payloads (layout + data).
9. Behaviour notes
Playback, limitations, edge cases.
10. Related
Links to sibling page, runners, source files.