@kubex/zinc 1.1.185 → 2.0.0

package/docs/pages/components/report-table.md

@@ -0,0 +1,202 @@
+---
+meta:
+  title: Report Table
+  description: A grouped report that fetches its own rows, with group headings, gain and loss colouring and a total row.
+layout: component
+fullWidth: true
+---
+
+```html:preview
+<zn-report-table caption="Day Compare" data-uri="/data/report-table.json" method="GET" locale="en-US"
+                 from="2026-10-19" to="2026-10-20" group-by="affiliateFid"
+                 types='[{"value":"compare","label":"Day Compare"},{"value":"summary","label":"Summary"}]'
+                 group-bys='[
+                   {"value":"affiliateFid","label":"Publisher","category":"Publisher"},
+                   {"value":"publisherType","label":"Publisher Type","category":"Publisher"},
+                   {"value":"subId1","label":"Sub ID 1","category":"Publisher"},
+                   {"value":"campaignFid","label":"Campaign","category":"Campaign"},
+                   {"value":"brand","label":"Brand","category":"Campaign"},
+                   {"value":"media","label":"Media","category":"Campaign"},
+                   {"value":"country","label":"Country","category":"Location"},
+                   {"value":"city","label":"City","category":"Location"},
+                   {"value":"device","label":"Device","category":"Location"}
+                 ]'
+                 filter-fields='[
+                   {"id":"country","name":"Country","options":{"GB":"United Kingdom","US":"United States","DE":"Germany"}},
+                   {"id":"device","name":"Device","options":{"desktop":"Desktop","mobile":"Mobile","tablet":"Tablet"}},
+                   {"id":"campaign","name":"Campaign","operators":["eq","contains"]}
+                 ]'></zn-report-table>
+```
+
+`zn-report-table` shows a report: one row per value of a dimension (a publisher, a country, a campaign) over a date range, read column by column. Use it for reporting. For lists of records with paging, selection and row actions, use [Data Table](/components/data-table).
+
+The table fetches its own data from `data-uri`, and fetches again whenever the report type, group by, date range or filter changes. The columns come back in the response, so the server decides what a report contains.
+
+## Examples
+
+### Groups and Columns
+
+The response's `groups` give the heading row. Each group lists its `columns`, and a faint line marks the first column of each group. When a group has one column with the same label as the group, the column's own heading is left blank.
+
+Each column has a `key`, a `label` and a `format`, and gets its value in one of three ways:
+
+- `value`: a dotted path into the row's `values`, such as `d1.i.unique`.
+- `formula`: arithmetic over `{dotted.path}` placeholders (see [Formulas and Totals](#formulas-and-totals)).
+- Neither: the column's `key` is used as the path.
+
+| Field | Values | Default | Meaning |
+|---|---|---|---|
+| `format` | `number`, `decimal`, `percent`, `currency`, `financial`, `text` | `number` | How the value is displayed. |
+| `decimals` | integer | 0 for `number`, 2 otherwise | Decimal places. |
+| `style` | `none`, `breakeven`, `ibreakeven`, `bold` | `none` | Colouring. |
+| `threshold` | number | 0 | The breakeven point. |
+| `summable` | bool | `true`, `false` for `text` | Whether the column gets a computed total. `false` shows `–`. |
+| `currency` | ISO code | response `currency`, then the `currency` attribute, then `USD` | |
+
+The formats:
+
+- `number` and `decimal` use the locale's grouping.
+- `percent` multiplies by 100 and adds `%`, since ratios are sent as fractions.
+- `currency` shows negatives in brackets, such as `($1,396.73)`.
+- `financial` is the same as `currency`, without the symbol.
+- `text` shows the row's value as it is, for cells the server has already formatted.
+
+With `breakeven`, a value above `threshold` is green and one below it is red. `ibreakeven` reverses that. Columns with no style are never coloured.
+
+Each row has an `id`, a `label` for the first column and its `values`. A `uri` (and an optional `target`) turns the label into a link, which is how drill-down reports are linked. A row's `links` maps column keys to `{uri, target?}` and links those cells, for example a count to the records behind it. A `target` is rendered as `data-target`, so the console opens the link in that space, such as `slide`.
+
+### Formulas and Totals
+
+A `formula` uses `+ - * /`, parentheses, numbers and unary minus over `{dotted.path}` placeholders, such as `{d2.total.revenue} - {d1.total.revenue}`. A leading `=` is ignored. Dividing by zero, a missing path or a value that isn't a number gives `0`. Formulas are parsed, never run as script.
+
+The total row works the same way for every column. First, every numeric value is added up across the rows shown. Then each column's formula is read from those sums. That way a ratio such as Click / Acquisition is recalculated from the summed counts, not averaged.
+
+When the response has `totals`, those are shown instead. Columns missing from `totals` show `–`. While the search box narrows the rows, the table goes back to computing totals from the rows on screen, so the total always matches what is shown.
+
+### Search and Sorting
+
+The search box is a [Data Table Search](/components/data-table-search). It filters rows by their first column in the browser, a moment after typing stops, and its clear button shows every row again. The row count next to the caption reads `2 of 6 rows` while a search narrows the rows. The placeholder defaults to `Search` followed by the dimension's label, and `search-placeholder` replaces it.
+
+Click a column heading to sort by it. The first click sorts descending, the second ascending, and the third goes back to the server's order. The first column sorts by text, and numbers inside it sort naturally, so `Sub ID 9` comes before `Sub ID 10`. The total row never moves. Search and sort are never sent to the server.
+
+### Report Type, Group By and Dates
+
+- `types` is a JSON array of `{value, label}`. With two or more types, they show as tabs under the header, and `type` defaults to the first.
+- `group-bys` is a JSON array of `{value, label, category?}` for the Group by menu. Options with a `category` are listed under its heading in a three-column grid. Without categories, the options are one list.
+- `from` and `to` are ISO dates for the date range. `max-date` is the latest day that can be picked, and defaults to today. `presets` replaces the quick ranges, as on [Date Range](/components/date-range). `date-note` adds a short line under the calendar, such as "Day Compare sets the first day against the last."
+- `filter-fields` gives the funnel its fields, in the same shape as Data Table's `filter-fields`. The funnel is a [Data Table Filter](/components/data-table-filter), and the rules that apply show as chips under the header. The funnel is hidden when there are no fields. The applied rules are sent as `filter`.
+
+The response can send its own `groupBys` and `filterFields`, for a type whose options differ, and they replace the attributes. When the response's `groupBy` differs from the one requested, the table adopts it.
+
+Each change sets the matching attribute and emits `zn-report-change` with `{type, groupBy, from, to, filter}`, then the table fetches again.
+
+```html:preview
+<zn-report-table class="report-events" caption="Day Compare" data-uri="/data/report-table.json" method="GET"
+                 locale="en-US" from="2026-10-19" to="2026-10-20" group-by="affiliateFid"
+                 group-bys='[
+                   {"value":"affiliateFid","label":"Publisher"},
+                   {"value":"campaignFid","label":"Campaign"},
+                   {"value":"country","label":"Country"},
+                   {"value":"device","label":"Device"}
+                 ]'></zn-report-table>
+<pre class="report-events__log">Change the group by or dates to see zn-report-change.</pre>
+
+<script type="module">
+  const table = document.querySelector('.report-events');
+  const log = document.querySelector('.report-events__log');
+  table.addEventListener('zn-report-change', event => {
+    log.textContent = JSON.stringify(event.detail, null, 2);
+  });
+</script>
+```
+
+### Wide Reports
+
+A report wider than its panel scrolls sideways. The first column stays in place and the other columns pass behind it, so each row's label stays in view. This Day Compare has a group per day, each with its own counts, ratios and spend.
+
+```html:preview
+<zn-report-table caption="Day Compare" data-uri="/data/report-table-day-compare.json" method="GET" locale="en-US"
+                 from="2026-10-19" to="2026-10-20" group-by="affiliateFid"
+                 types='[{"value":"compare","label":"Day Compare"},{"value":"summary","label":"Summary"}]'
+                 group-bys='[
+                   {"value":"affiliateFid","label":"Publisher"},
+                   {"value":"campaignFid","label":"Campaign"},
+                   {"value":"country","label":"Country"}
+                 ]'
+                 filter-fields='[{"id":"country","name":"Country","options":{"GB":"United Kingdom","US":"United States"}}]'></zn-report-table>
+```
+
+### Sharable
+
+Add `sharable` to keep the report's state in the URL's query string, so the view can be bookmarked or shared. The table writes `type`, `groupBy`, `from`, `to`, `filter` and `search` when they differ from the attributes it started with, and reads them back on load. Other query parameters are left alone.
+
+```html
+<zn-report-table sharable data-uri="/reports/compare" caption="Day Compare"
+                 from="2026-10-19" to="2026-10-20"></zn-report-table>
+```
+
+A link such as `?type=summary&groupBy=country&from=2026-10-01&to=2026-10-07` opens the Summary type grouped by Country for that week.
+
+### Inputs and Empty State
+
+Inputs in the `inputs` slot are sent with every request, which is useful for csrf tokens. Content in the `empty-state` slot replaces the default empty state, which is shown inside the panel when there are no rows.
+
+```html
+<zn-report-table data-uri="/reports/compare">
+  <input slot="inputs" type="hidden" name="csrf" value="token">
+  <zn-empty-state slot="empty-state" caption="No traffic" icon="bar_chart"
+                  description="Nothing ran in this range."></zn-empty-state>
+</zn-report-table>
+```
+
+## Request and Response
+
+The table sends JSON to `data-uri` with a `POST`, or a `GET` without a body when `method="GET"`. It sends the header `x-kx-fetch-style: zn-report-table`.
+
+```json
+{
+  "type": "compare",
+  "groupBy": "affiliateFid",
+  "from": "2026-10-19",
+  "to": "2026-10-20",
+  "filter": "W3sia2V5IjoiY291bnRyeSIsImNvbXBhcmF0b3IiOiJlcSIsInZhbHVlIjoiR0IifV0="
+}
+```
+
+`filter` is `btoa(JSON.stringify(rules))` of `{key, comparator, value}` rules, as Data Table sends it, or `''` when no rules apply. The server decides what `from` and `to` mean for each type. A Day Compare compares the two days, and other types treat them as a span.
+
+The response:
+
+```json
+{
+  "dimension": {"label": "Publisher"},
+  "groups": [
+    {
+      "label": "Difference between 2026-10-19 and 2026-10-20",
+      "columns": [
+        {"key": "revenue", "label": "Revenue", "format": "currency", "style": "breakeven",
+         "formula": "{d2.total.revenue} - {d1.total.revenue}"}
+      ]
+    },
+    {
+      "label": "2026-10-19",
+      "columns": [{"key": "d1In", "label": "Inbound Actions", "format": "number", "value": "d1.i.unique"}]
+    }
+  ],
+  "rows": [
+    {"id": "AFF-1", "label": "NovaBeyond - Push/Display - Jake", "uri": "/reports/compare/campaignFid",
+     "values": {"d1": {"total": {"revenue": 2097.41}, "i": {"unique": 1298}}, "d2": {"total": {"revenue": 700.68}}}}
+  ],
+  "totals": {"revenue": -25736.81},
+  "currency": "USD",
+  "groupBy": "affiliateFid",
+  "groupBys": [{"value": "affiliateFid", "label": "Publisher", "category": "Publisher"}],
+  "filterFields": [{"id": "country", "name": "Country"}],
+  "error": {"text": "Results are limited to 1,000 rows", "level": "warning"}
+}
+```
+
+- `groups` and `rows` are required. `null` is read as an empty list.
+- `totals` is optional. Without it, the table computes the totals.
+- `groupBy`, `groupBys` and `filterFields` are optional and replace the attributes.
+- `error` shows an alert inside the panel, above the table.

package/docs/pages/components/stat.md

@@ -158,6 +158,36 @@ Use `delta-format="points"` with `show-delta` to show the difference between `am
 </zn-cols>
 ```
 
+### Tile
+
+Use `layout="tile"` for a self-contained stat card: the caption, the amount, a footer with the delta and `description`, and an optional sparkline from comma-separated `spark` values. Colour the sparkline with `spark-color` (a tone such as `success` or `danger`, or any CSS colour). Set `invert-delta` where a rise is bad news.
+
+```html:preview
+<zn-cols layout="1,1,1">
+  <zn-stat layout="tile" caption="Pending commission" amount="$2,941" show-delta previous="$2,875"
+           description="vs. 1,875" spark="4,6,5,8,7,10,9,13,12,15"></zn-stat>
+  <zn-stat layout="tile" caption="Unpaid paychecks" amount="$841" show-delta previous="$851"
+           description="vs. 902" spark="12,11,13,10,9,10,8,9,7,6" spark-color="danger"></zn-stat>
+  <zn-stat layout="tile" caption="Declined" amount="148" show-delta previous="140" invert-delta
+           description="3.4% of orders" spark="6,5,7,4,6,5,5,4,6,5,4,5,4,5,4" spark-color="danger"></zn-stat>
+</zn-cols>
+```
+
+### Selectable Tiles
+
+Add `selectable` to make a tile a toggle button, for tiles that filter the content below them, and `tone` for a coloured dot before the caption. `selected` sets the pressed state.
+
+```html:preview
+<zn-cols layout="1,1,1">
+  <zn-stat layout="tile" selectable tone="info" caption="Capturing payment" amount="28"
+           description="Oldest 11 h" spark="0,0,1,0,2,1,0,3,2,4,3,5,8,12,28" spark-color="info"></zn-stat>
+  <zn-stat layout="tile" selectable selected tone="warning" caption="Awaiting approval" amount="203"
+           description="Oldest 29 days" spark="9,7,8,11,9,6,8,10,7,9,12,8,9,10,11" spark-color="warning"></zn-stat>
+  <zn-stat layout="tile" selectable tone="success" caption="Complete" amount="3,481" show-delta previous="3,513"
+           description="80% of orders" spark="120,128,119,124,118,131,127,122,126,130" spark-color="success"></zn-stat>
+</zn-cols>
+```
+
 ### Icon
 
 Use `icon` to show an icon beside the amount. It takes the amount's color unless you set `icon-color`.

package/docs/pages/components/tile.md

@@ -105,6 +105,17 @@ Use the `image` slot to add an image or icon to the left side of the tile. This
 </zn-tile>
 ```
 
+### Tile with Icon
+
+Set `icon` to show an icon in a tinted square before the caption. `icon-color` picks the tint: `success`, `warning`,
+`danger`, `info`, `ai` or `neutral` (the default).
+
+```html:preview
+<zn-tile caption="Second chance" description="Offer · Default template" icon="tag@lu" icon-color="success"></zn-tile>
+<zn-tile caption="Before you go" description="Message · Retention copy" icon="message-square@lu" icon-color="ai"></zn-tile>
+<zn-tile caption="Archive" description="Kept for 90 days" icon="archive@lu"></zn-tile>
+```
+
 ### Clickable Tiles
 
 Add the `href` attribute to make a tile clickable. The tile will render as an anchor tag and display hover effects.

package/docs/pages/components/tooltip.md

@@ -581,7 +581,7 @@ Customize the tooltip appearance with CSS custom properties.
   <zn-tooltip
     content="Error tooltip"
     style="
-      --zn-tooltip-background-color: var(--zn-color-error-600);
+      --zn-tooltip-background-color: var(--zn-color-danger-600);
       --zn-tooltip-color: white;
     ">
     <zn-button color="error">Error Style</zn-button>

package/docs/pages/components/translation-grid.md

@@ -0,0 +1,86 @@
+---
+meta:
+  title: Translation Grid
+  description: Shows how far each language's translation has got, with a column per language to choose and enable it.
+layout: component
+---
+
+Each language gets a column: its code links to that language's translation, the Enable row holds the control that
+turns it on, and the Translation row shows its status. Pass the languages as a JSON array of
+`{code, label, status, href}`, where `status` is `source`, `translated`, `outdated` or `missing`, and put each
+language's Enable control in the `enable-{code}` slot.
+
+```html:preview
+<zn-translation-grid
+  selected="es"
+  languages='[
+    {"code":"en","label":"English","status":"source"},
+    {"code":"fr","label":"French","status":"translated","href":"#fr"},
+    {"code":"de","label":"German","status":"outdated","href":"#de"},
+    {"code":"es","label":"Spanish","status":"missing","href":"#es"},
+    {"code":"it","label":"Italian","status":"missing","href":"#it"}
+  ]'>
+  <zn-checkbox slot="enable-en" checked disabled aria-label="English is always on"></zn-checkbox>
+  <zn-checkbox slot="enable-fr" checked aria-label="Enable French"></zn-checkbox>
+  <zn-checkbox slot="enable-de" aria-label="Enable German"></zn-checkbox>
+  <zn-checkbox slot="enable-es" disabled aria-label="Enable Spanish"></zn-checkbox>
+  <zn-checkbox slot="enable-it" disabled aria-label="Enable Italian"></zn-checkbox>
+</zn-translation-grid>
+```
+
+## Examples
+
+### Enabling From A Form
+
+Each Enable control can post on its own: put it in a form in the language's slot and give it `submit-on-click`, with
+an `unchecked-value` so unticking posts too.
+
+```html:preview
+<zn-translation-grid
+  selected="fr"
+  languages='[
+    {"code":"en","label":"English","status":"source"},
+    {"code":"fr","label":"French","status":"translated","href":"#fr"}
+  ]'>
+  <zn-checkbox slot="enable-en" checked disabled aria-label="English is always on"></zn-checkbox>
+  <form slot="enable-fr" method="post" action="/translations/fr/enable">
+    <zn-checkbox name="enabled" value="1" unchecked-value="0" submit-on-click aria-label="Enable French"></zn-checkbox>
+  </form>
+</zn-translation-grid>
+```
+
+### Naming The Source
+
+The legend calls an out-of-date translation "English changed". Set `source-label` when the source is another language.
+
+```html:preview
+<zn-translation-grid
+  source-label="German"
+  languages='[
+    {"code":"de","label":"German","status":"source"},
+    {"code":"en","label":"English","status":"outdated","href":"#en"}
+  ]'>
+</zn-translation-grid>
+```
+
+### A Row Per Field
+
+When a record has several translated fields, pass them as `fields`, a JSON array of `{key, label, cells}` where
+`cells` holds each language's `{status, href}` keyed by its code. Each field gets its own row, and `selected-field`
+with `selected` rings the cell being edited. Leave out the `enable-{code}` slots to drop the Enable row.
+
+```html:preview
+<zn-translation-grid
+  selected="de"
+  selected-field="content"
+  languages='[
+    {"code":"en","label":"English"},
+    {"code":"fr","label":"French","href":"#fr"},
+    {"code":"de","label":"German","href":"#de"}
+  ]'
+  fields='[
+    {"key":"name","label":"Display name","cells":{"en":{"status":"source"},"fr":{"status":"translated","href":"#name-fr"},"de":{"status":"missing","href":"#name-de"}}},
+    {"key":"content","label":"Content","cells":{"en":{"status":"source"},"fr":{"status":"outdated","href":"#content-fr"},"de":{"status":"missing","href":"#content-de"}}}
+  ]'>
+</zn-translation-grid>
+```