@dashspec/renderer 0.1.11 → 0.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -1
- package/dist/{chunk-RSIUW5J4.js → chunk-42YQDK6L.js} +18 -4
- package/dist/{chunk-RSIUW5J4.js.map → chunk-42YQDK6L.js.map} +1 -1
- package/dist/{core-DchxX9ku.d.ts → core-C6GFuH_O.d.ts} +1 -1
- package/dist/core.d.ts +1 -1
- package/dist/core.js +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.js +44 -22
- package/dist/index.js.map +1 -1
- package/docs/widgets.md +2 -2
- package/package.json +1 -1
package/docs/widgets.md
CHANGED
|
@@ -67,7 +67,7 @@ Field props such as `x`, `label` or `value` name a field of each data row; dot p
|
|
|
67
67
|
| Kind | What it shows | Main props | Events |
|
|
68
68
|
|---|---|---|---|
|
|
69
69
|
| `Kpi` | A metric card: label, big value, target and an "On track / Action needed" chip | `unit`, `unitStyle` (`small` / `value`), `format`, `decimals`, `target`, `targetLabel`, `goodWhen` (`up` / `down` / `none`), `badge`, `statusLabels`, `compare`, `band`, `progress`, `note`, `emptyText`, `empty` (show `emptyText` even with a value), `sublabel`, `size` (`normal` / `hero`), `tone` | `click`, `hover` (part `value`) |
|
|
70
|
-
| `Tiles` | One tile per row: label, big number, caption | `label`, `value` (required), `caption`, `status`, `statusMap`, `valueTone`, `count`, `format`, `unit`, `columns`, `minTileWidth`, `wrap`, `captionInline` (caption right after the number), `chips`, `mutedWhen`, `highlightWhen`, `highlightTone`, `selectable`, `selected`; `value` may be a template over `row` (`"${row.value ?? row.passed}"`) | `click`, `hover`, `select` (part `tile`) |
|
|
70
|
+
| `Tiles` | One tile per row: label, big number, caption | `label`, `value` (required), `caption`, `status`, `statusMap`, `valueTone`, `count`, `format`, `unit`, `columns`, `minTileWidth`, `wrap`, `captionInline` (caption right after the number), `stretch` (`false`: few tiles keep their column width), `chips`, `mutedWhen`, `highlightWhen`, `highlightTone`, `selectable`, `selected`; `value` may be a template over `row` (`"${row.value ?? row.passed}"`) | `click`, `hover`, `select` (part `tile`) |
|
|
71
71
|
| `Gauge` | A value on an arc or circle with coloured bands | `min` (0), `max` (100), `bands: [{ to, tone }]`, `shape` (`arc` / `circle`), `unit`, `format`, `decimals` | `click` |
|
|
72
72
|
| `Status` | A status badge from a state field, or fixed text | `state` (field, default `"state"`), `stateMap`, `labels`, `label`, `text`, `tone` | `click` |
|
|
73
73
|
|
|
@@ -112,7 +112,7 @@ Field props such as `x`, `label` or `value` name a field of each data row; dot p
|
|
|
112
112
|
| `PieChart` | A pie or donut | `label`, `value` (required), `donut`, `unit`, `format`, `decimals` | `click`, `hover`, `hoverEnd`, `legendClick` (parts `slice`, `legend`) |
|
|
113
113
|
| `Scatter` | Points by two numbers | `x`, `y` (required), `size`, `series`, `xLabel`, `yLabel` | `click`, `hover`, `hoverEnd`, `brush`, `legendClick` |
|
|
114
114
|
| `MatrixChart` | A heatmap of rows × columns | `rows`, `cols`, `value` (required), `unit`, `format` | `click`, `cellClick`, `hover` (part `cell`) |
|
|
115
|
-
| `Breakdown` | Parts of a whole as meters, a segmented bar or a donut | `label`, `value` (
|
|
115
|
+
| `Breakdown` | Parts of a whole as meters, a segmented bar or a donut | `label`, `value` (fields of each data row), `items` (fixed `{ label, value, tone }` instead of rows; values can be templates), `mode` (`meters` / `segmented` / `donut`), `remainder: { label, total }`, `showPercent`, `limit`, `unit`, `format` | `click`, `hover` (part `item`) |
|
|
116
116
|
| `Sparkline` | A tiny line, no axes | `y` (required), `x`, `area` (default `true`) | `hover` |
|
|
117
117
|
|
|
118
118
|
```json
|