@richardmcquiston01/dashboard-widgets-toolkit 0.9.0 → 0.10.0

package/dist/{scale-CrXxawQn.d.cts → scale-N69bo7wo.d.cts}

@@ -573,6 +573,12 @@ interface WidgetDefinition {
      * are not locked.
      */
     readonly locked?: boolean | WidgetLock;
+    /**
+     * The widget's home page in a paged dashboard: a page key or title. A
+     * widget no page lists yet (and a widget locked against moving) shows here;
+     * without it, on the first page. Ignored when the layout has no pages.
+     */
+    readonly page?: string;
 }
 /** What a viewer may not do to a locked widget. */
 interface WidgetLock {
@@ -616,6 +622,8 @@ interface LayoutItem {
     readonly sortOrder?: number;
     /** See `WidgetDefinition.locked`. Pinned widgets hold their slot. */
     readonly locked?: boolean | WidgetLock;
+    /** See `WidgetDefinition.page`: the widget's home page. */
+    readonly page?: string;
 }
 interface DashboardLayout {
     /** Widget keys in display order. Keys not listed follow, by sortOrder. */
@@ -624,7 +632,34 @@ interface DashboardLayout {
     readonly hidden: readonly string[];
     /** Widget keys collapsed to their header. */
     readonly minimized: readonly string[];
+    /**
+     * Pages of widgets. Absent, the lists above are the one and only page. With
+     * pages, each page owns its own lists and the top-level lists are left
+     * empty. See `pages.ts`.
+     */
+    readonly pages?: readonly LayoutPage[];
+}
+/** One page of a paged layout: the same lists as a layout, plus a name. */
+interface LayoutPage {
+    /** Unique within the layout and stable when the page is renamed or moved. */
+    readonly key: string;
+    /** Shown in the page bar. At most `MAX_PAGE_TITLE_LENGTH` characters. */
+    readonly title: string;
+    readonly order: readonly string[];
+    readonly hidden: readonly string[];
+    readonly minimized: readonly string[];
+    /** Rows this page holds, overriding the dashboard's default. */
+    readonly maxRows?: number;
 }
+/** Longest page title; longer saved titles are cut. */
+declare const MAX_PAGE_TITLE_LENGTH = 30;
+/**
+ * Most pages `parseLayout` keeps: a safety ceiling against malformed or
+ * hostile JSON, not a product limit.
+ */
+declare const MAX_PARSED_PAGES = 50;
+/** Most rows a page may be given with `maxRows`. */
+declare const MAX_PAGE_ROWS = 20;
 declare const EMPTY_LAYOUT: DashboardLayout;
 /**
  * Reads a saved layout: a JSON string or an already-parsed object. Missing,
@@ -720,4 +755,4 @@ declare function niceDomain(values: readonly number[], tickCount?: number): Nice
  */
 declare function labelStride(count: number, maxLabels?: number): number;
 
-export { type LoadingWidget as $, type AlertListWidgetData as A, type BarListWidgetData as B, type CachedPayload as C, type DashboardWidget as D, type DetailMode as E, type DetailPage as F, type GraphWidgetData as G, type DetailProvider as H, type DetailProviders as I, type DetailSort as J, type KpiWidgetData as K, type Locale as L, EMPTY_LAYOUT as M, type NiceDomain as N, type EmptyWidget as O, type EnforceLocksOptions as P, type Err as Q, type ResolvedTableControls as R, type ErrorWidget as S, type TableWidgetData as T, type FormatOptions as U, type GraphPoint as V, type WidgetSize as W, type GraphSeries as X, type KpiDelta as Y, type KpiDeltaOptions as Z, type LayoutItem as _, type WidgetFill as a, resolveWidget as a$, MAX_DETAIL_PAGE_SIZE as a0, MAX_GRAPH_SERIES as a1, type Ok as a2, type OkWidget as a3, type ProviderOptions as a4, type ResolvedDetailOptions as a5, type ResolvedWidget as a6, type ResolvedWidgetLock as a7, type SortDirection as a8, type TableCell as a9, formatValue as aA, hiddenWidgets as aB, hideWidget as aC, isHidden as aD, isMinimized as aE, isWidgetEmptyState as aF, isWidgetKind as aG, isWidgetVisibleTo as aH, kpiDelta as aI, labelStride as aJ, loadingWidgets as aK, minimizeWidget as aL, moveWidget as aM, moveWidgetBy as aN, moveWidgetDown as aO, moveWidgetUp as aP, niceDomain as aQ, niceStep as aR, ok as aS, parseDetailQuery as aT, parseLayout as aU, percentChange as aV, pruneLayout as aW, queryRows as aX, resolveDetailOptions as aY, resolvePayload as aZ, resolveTableControls as a_, type TableColumn as aa, VALUE_FORMATS as ab, type ValueFormat as ac, WIDGET_FILLS as ad, WIDGET_KINDS as ae, WIDGET_SIZES as af, type WidgetCache as ag, type WidgetDataOf as ah, type WidgetDetailOptions as ai, type WidgetEmptyState as aj, type WidgetLock as ak, type WidgetProvider as al, type WidgetStatus as am, type WidgetTableControls as an, cacheKeyFor as ao, defaultDetailQuery as ap, defineWidget as aq, deriveDetailData as ar, describeUnknownError as as, emptyTextFor as at, emptyWidget as au, enforceLocks as av, err as aw, failedWidget as ax, formatCount as ay, formatPercentChange as az, type WidgetDefinition as b, resolveWidgetLock as b0, resolveWidgets as b1, restoreWidget as b2, serializeDetailQuery as b3, serializeLayout as b4, shareOf as b5, showWidget as b6, sortDefinitions as b7, tableDetailData as b8, toggleHidden as b9, toggleMinimized as ba, validateDetailData as bb, visibleWidgets as bc, widgetsFor as bd, type DetailProviderOptions as c, type DetailData as d, type DetailQuery as e, type DashboardLayout as f, type GaugeWidgetData as g, type TextWidgetData as h, type WidgetData as i, type ResolveOptions as j, type WidgetContext as k, type WidgetProviders as l, type WidgetKind as m, type Result as n, type WidgetPayload as o, type AlertListItem as p, type BarListItem as q, DEFAULT_COMPARISON_LABEL as r, DEFAULT_CURRENCY as s, DEFAULT_DETAIL_PAGE_SIZE as t, DEFAULT_EMPTY_TEXT as u, DETAIL_MODES as v, type DeltaDirection as w, type DeltaSentiment as x, type DetailCell as y, type DetailColumn as z };
+export { type KpiDeltaOptions as $, type AlertListWidgetData as A, type BarListWidgetData as B, type CachedPayload as C, type DashboardWidget as D, type DetailCell as E, type DetailColumn as F, type GraphWidgetData as G, type DetailMode as H, type DetailPage as I, type DetailProvider as J, type KpiWidgetData as K, type Locale as L, type DetailProviders as M, type NiceDomain as N, type DetailSort as O, EMPTY_LAYOUT as P, type EmptyWidget as Q, type ResolvedTableControls as R, type EnforceLocksOptions as S, type TableWidgetData as T, type Err as U, type ErrorWidget as V, type WidgetSize as W, type FormatOptions as X, type GraphPoint as Y, type GraphSeries as Z, type KpiDelta as _, type WidgetFill as a, queryRows as a$, type LoadingWidget as a0, MAX_DETAIL_PAGE_SIZE as a1, MAX_GRAPH_SERIES as a2, MAX_PAGE_ROWS as a3, MAX_PAGE_TITLE_LENGTH as a4, MAX_PARSED_PAGES as a5, type Ok as a6, type OkWidget as a7, type ProviderOptions as a8, type ResolvedDetailOptions as a9, err as aA, failedWidget as aB, formatCount as aC, formatPercentChange as aD, formatValue as aE, hiddenWidgets as aF, hideWidget as aG, isHidden as aH, isMinimized as aI, isWidgetEmptyState as aJ, isWidgetKind as aK, isWidgetVisibleTo as aL, kpiDelta as aM, labelStride as aN, loadingWidgets as aO, minimizeWidget as aP, moveWidget as aQ, moveWidgetBy as aR, moveWidgetDown as aS, moveWidgetUp as aT, niceDomain as aU, niceStep as aV, ok as aW, parseDetailQuery as aX, parseLayout as aY, percentChange as aZ, pruneLayout as a_, type ResolvedWidget as aa, type ResolvedWidgetLock as ab, type SortDirection as ac, type TableCell as ad, type TableColumn as ae, VALUE_FORMATS as af, type ValueFormat as ag, WIDGET_FILLS as ah, WIDGET_KINDS as ai, WIDGET_SIZES as aj, type WidgetCache as ak, type WidgetDataOf as al, type WidgetDetailOptions as am, type WidgetEmptyState as an, type WidgetLock as ao, type WidgetProvider as ap, type WidgetStatus as aq, type WidgetTableControls as ar, cacheKeyFor as as, defaultDetailQuery as at, defineWidget as au, deriveDetailData as av, describeUnknownError as aw, emptyTextFor as ax, emptyWidget as ay, enforceLocks as az, type WidgetDefinition as b, resolveDetailOptions as b0, resolvePayload as b1, resolveTableControls as b2, resolveWidget as b3, resolveWidgetLock as b4, resolveWidgets as b5, restoreWidget as b6, serializeDetailQuery as b7, serializeLayout as b8, shareOf as b9, showWidget as ba, sortDefinitions as bb, tableDetailData as bc, toggleHidden as bd, toggleMinimized as be, validateDetailData as bf, visibleWidgets as bg, widgetsFor as bh, type DetailProviderOptions as c, type DetailData as d, type DetailQuery as e, type DashboardLayout as f, type GaugeWidgetData as g, type TextWidgetData as h, type WidgetData as i, type ResolveOptions as j, type WidgetContext as k, type WidgetProviders as l, type LayoutItem as m, type Result as n, type LayoutPage as o, type WidgetKind as p, type WidgetPayload as q, type AlertListItem as r, type BarListItem as s, DEFAULT_COMPARISON_LABEL as t, DEFAULT_CURRENCY as u, DEFAULT_DETAIL_PAGE_SIZE as v, DEFAULT_EMPTY_TEXT as w, DETAIL_MODES as x, type DeltaDirection as y, type DeltaSentiment as z };

package/dist/{scale-CrXxawQn.d.ts → scale-N69bo7wo.d.ts}

@@ -573,6 +573,12 @@ interface WidgetDefinition {
      * are not locked.
      */
     readonly locked?: boolean | WidgetLock;
+    /**
+     * The widget's home page in a paged dashboard: a page key or title. A
+     * widget no page lists yet (and a widget locked against moving) shows here;
+     * without it, on the first page. Ignored when the layout has no pages.
+     */
+    readonly page?: string;
 }
 /** What a viewer may not do to a locked widget. */
 interface WidgetLock {
@@ -616,6 +622,8 @@ interface LayoutItem {
     readonly sortOrder?: number;
     /** See `WidgetDefinition.locked`. Pinned widgets hold their slot. */
     readonly locked?: boolean | WidgetLock;
+    /** See `WidgetDefinition.page`: the widget's home page. */
+    readonly page?: string;
 }
 interface DashboardLayout {
     /** Widget keys in display order. Keys not listed follow, by sortOrder. */
@@ -624,7 +632,34 @@ interface DashboardLayout {
     readonly hidden: readonly string[];
     /** Widget keys collapsed to their header. */
     readonly minimized: readonly string[];
+    /**
+     * Pages of widgets. Absent, the lists above are the one and only page. With
+     * pages, each page owns its own lists and the top-level lists are left
+     * empty. See `pages.ts`.
+     */
+    readonly pages?: readonly LayoutPage[];
+}
+/** One page of a paged layout: the same lists as a layout, plus a name. */
+interface LayoutPage {
+    /** Unique within the layout and stable when the page is renamed or moved. */
+    readonly key: string;
+    /** Shown in the page bar. At most `MAX_PAGE_TITLE_LENGTH` characters. */
+    readonly title: string;
+    readonly order: readonly string[];
+    readonly hidden: readonly string[];
+    readonly minimized: readonly string[];
+    /** Rows this page holds, overriding the dashboard's default. */
+    readonly maxRows?: number;
 }
+/** Longest page title; longer saved titles are cut. */
+declare const MAX_PAGE_TITLE_LENGTH = 30;
+/**
+ * Most pages `parseLayout` keeps: a safety ceiling against malformed or
+ * hostile JSON, not a product limit.
+ */
+declare const MAX_PARSED_PAGES = 50;
+/** Most rows a page may be given with `maxRows`. */
+declare const MAX_PAGE_ROWS = 20;
 declare const EMPTY_LAYOUT: DashboardLayout;
 /**
  * Reads a saved layout: a JSON string or an already-parsed object. Missing,
@@ -720,4 +755,4 @@ declare function niceDomain(values: readonly number[], tickCount?: number): Nice
  */
 declare function labelStride(count: number, maxLabels?: number): number;
 
-export { type LoadingWidget as $, type AlertListWidgetData as A, type BarListWidgetData as B, type CachedPayload as C, type DashboardWidget as D, type DetailMode as E, type DetailPage as F, type GraphWidgetData as G, type DetailProvider as H, type DetailProviders as I, type DetailSort as J, type KpiWidgetData as K, type Locale as L, EMPTY_LAYOUT as M, type NiceDomain as N, type EmptyWidget as O, type EnforceLocksOptions as P, type Err as Q, type ResolvedTableControls as R, type ErrorWidget as S, type TableWidgetData as T, type FormatOptions as U, type GraphPoint as V, type WidgetSize as W, type GraphSeries as X, type KpiDelta as Y, type KpiDeltaOptions as Z, type LayoutItem as _, type WidgetFill as a, resolveWidget as a$, MAX_DETAIL_PAGE_SIZE as a0, MAX_GRAPH_SERIES as a1, type Ok as a2, type OkWidget as a3, type ProviderOptions as a4, type ResolvedDetailOptions as a5, type ResolvedWidget as a6, type ResolvedWidgetLock as a7, type SortDirection as a8, type TableCell as a9, formatValue as aA, hiddenWidgets as aB, hideWidget as aC, isHidden as aD, isMinimized as aE, isWidgetEmptyState as aF, isWidgetKind as aG, isWidgetVisibleTo as aH, kpiDelta as aI, labelStride as aJ, loadingWidgets as aK, minimizeWidget as aL, moveWidget as aM, moveWidgetBy as aN, moveWidgetDown as aO, moveWidgetUp as aP, niceDomain as aQ, niceStep as aR, ok as aS, parseDetailQuery as aT, parseLayout as aU, percentChange as aV, pruneLayout as aW, queryRows as aX, resolveDetailOptions as aY, resolvePayload as aZ, resolveTableControls as a_, type TableColumn as aa, VALUE_FORMATS as ab, type ValueFormat as ac, WIDGET_FILLS as ad, WIDGET_KINDS as ae, WIDGET_SIZES as af, type WidgetCache as ag, type WidgetDataOf as ah, type WidgetDetailOptions as ai, type WidgetEmptyState as aj, type WidgetLock as ak, type WidgetProvider as al, type WidgetStatus as am, type WidgetTableControls as an, cacheKeyFor as ao, defaultDetailQuery as ap, defineWidget as aq, deriveDetailData as ar, describeUnknownError as as, emptyTextFor as at, emptyWidget as au, enforceLocks as av, err as aw, failedWidget as ax, formatCount as ay, formatPercentChange as az, type WidgetDefinition as b, resolveWidgetLock as b0, resolveWidgets as b1, restoreWidget as b2, serializeDetailQuery as b3, serializeLayout as b4, shareOf as b5, showWidget as b6, sortDefinitions as b7, tableDetailData as b8, toggleHidden as b9, toggleMinimized as ba, validateDetailData as bb, visibleWidgets as bc, widgetsFor as bd, type DetailProviderOptions as c, type DetailData as d, type DetailQuery as e, type DashboardLayout as f, type GaugeWidgetData as g, type TextWidgetData as h, type WidgetData as i, type ResolveOptions as j, type WidgetContext as k, type WidgetProviders as l, type WidgetKind as m, type Result as n, type WidgetPayload as o, type AlertListItem as p, type BarListItem as q, DEFAULT_COMPARISON_LABEL as r, DEFAULT_CURRENCY as s, DEFAULT_DETAIL_PAGE_SIZE as t, DEFAULT_EMPTY_TEXT as u, DETAIL_MODES as v, type DeltaDirection as w, type DeltaSentiment as x, type DetailCell as y, type DetailColumn as z };
+export { type KpiDeltaOptions as $, type AlertListWidgetData as A, type BarListWidgetData as B, type CachedPayload as C, type DashboardWidget as D, type DetailCell as E, type DetailColumn as F, type GraphWidgetData as G, type DetailMode as H, type DetailPage as I, type DetailProvider as J, type KpiWidgetData as K, type Locale as L, type DetailProviders as M, type NiceDomain as N, type DetailSort as O, EMPTY_LAYOUT as P, type EmptyWidget as Q, type ResolvedTableControls as R, type EnforceLocksOptions as S, type TableWidgetData as T, type Err as U, type ErrorWidget as V, type WidgetSize as W, type FormatOptions as X, type GraphPoint as Y, type GraphSeries as Z, type KpiDelta as _, type WidgetFill as a, queryRows as a$, type LoadingWidget as a0, MAX_DETAIL_PAGE_SIZE as a1, MAX_GRAPH_SERIES as a2, MAX_PAGE_ROWS as a3, MAX_PAGE_TITLE_LENGTH as a4, MAX_PARSED_PAGES as a5, type Ok as a6, type OkWidget as a7, type ProviderOptions as a8, type ResolvedDetailOptions as a9, err as aA, failedWidget as aB, formatCount as aC, formatPercentChange as aD, formatValue as aE, hiddenWidgets as aF, hideWidget as aG, isHidden as aH, isMinimized as aI, isWidgetEmptyState as aJ, isWidgetKind as aK, isWidgetVisibleTo as aL, kpiDelta as aM, labelStride as aN, loadingWidgets as aO, minimizeWidget as aP, moveWidget as aQ, moveWidgetBy as aR, moveWidgetDown as aS, moveWidgetUp as aT, niceDomain as aU, niceStep as aV, ok as aW, parseDetailQuery as aX, parseLayout as aY, percentChange as aZ, pruneLayout as a_, type ResolvedWidget as aa, type ResolvedWidgetLock as ab, type SortDirection as ac, type TableCell as ad, type TableColumn as ae, VALUE_FORMATS as af, type ValueFormat as ag, WIDGET_FILLS as ah, WIDGET_KINDS as ai, WIDGET_SIZES as aj, type WidgetCache as ak, type WidgetDataOf as al, type WidgetDetailOptions as am, type WidgetEmptyState as an, type WidgetLock as ao, type WidgetProvider as ap, type WidgetStatus as aq, type WidgetTableControls as ar, cacheKeyFor as as, defaultDetailQuery as at, defineWidget as au, deriveDetailData as av, describeUnknownError as aw, emptyTextFor as ax, emptyWidget as ay, enforceLocks as az, type WidgetDefinition as b, resolveDetailOptions as b0, resolvePayload as b1, resolveTableControls as b2, resolveWidget as b3, resolveWidgetLock as b4, resolveWidgets as b5, restoreWidget as b6, serializeDetailQuery as b7, serializeLayout as b8, shareOf as b9, showWidget as ba, sortDefinitions as bb, tableDetailData as bc, toggleHidden as bd, toggleMinimized as be, validateDetailData as bf, visibleWidgets as bg, widgetsFor as bh, type DetailProviderOptions as c, type DetailData as d, type DetailQuery as e, type DashboardLayout as f, type GaugeWidgetData as g, type TextWidgetData as h, type WidgetData as i, type ResolveOptions as j, type WidgetContext as k, type WidgetProviders as l, type LayoutItem as m, type Result as n, type LayoutPage as o, type WidgetKind as p, type WidgetPayload as q, type AlertListItem as r, type BarListItem as s, DEFAULT_COMPARISON_LABEL as t, DEFAULT_CURRENCY as u, DEFAULT_DETAIL_PAGE_SIZE as v, DEFAULT_EMPTY_TEXT as w, DETAIL_MODES as x, type DeltaDirection as y, type DeltaSentiment as z };

package/dist/styles.css

@@ -179,6 +179,132 @@
   font-size: 0.875rem;
 }
 
+:where(.dwt-pages) {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  margin-bottom: 12px;
+}
+
+:where(.dwt-page-tabs) {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 4px;
+  min-width: 0;
+}
+
+:where(.dwt-page-tab) {
+  box-sizing: border-box;
+  min-height: 32px;
+  padding: 4px 12px;
+  font: inherit;
+  font-size: 0.875rem;
+  color: var(--dwt-text-secondary);
+  background: transparent;
+  border: 0;
+  border-bottom: 2px solid transparent;
+  cursor: pointer;
+}
+
+:where(.dwt-page-tab[aria-selected='true']) {
+  color: var(--dwt-text);
+  font-weight: 600;
+  border-bottom-color: var(--dwt-text);
+}
+
+:where(.dwt-page-tab:focus-visible) {
+  outline: 2px solid var(--dwt-focus);
+  outline-offset: 2px;
+}
+
+:where(.dwt-page-dot) {
+  display: none;
+  box-sizing: border-box;
+  width: 12px;
+  height: 12px;
+  border: 2px solid var(--dwt-text-secondary);
+  border-radius: 50%;
+  background: transparent;
+}
+
+:where(.dwt-page-tab[aria-selected='true'] .dwt-page-dot) {
+  border-color: var(--dwt-text);
+  background: var(--dwt-text);
+}
+
+@media (max-width: 640px) {
+  :where(.dwt-pages) {
+    justify-content: center;
+  }
+
+  :where(.dwt-page-tab) {
+    min-width: 24px;
+    min-height: 24px;
+    padding: 6px;
+    border-bottom: 0;
+  }
+
+  :where(.dwt-page-tab-title) {
+    position: absolute;
+    width: 1px;
+    height: 1px;
+    overflow: hidden;
+    clip-path: inset(50%);
+    white-space: nowrap;
+  }
+
+  :where(.dwt-page-dot) {
+    display: block;
+  }
+}
+
+:where(.dwt-page-manage) {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
+  gap: 8px;
+  margin-bottom: 12px;
+  font-size: 0.875rem;
+}
+
+:where(.dwt-page-rename) {
+  display: inline-flex;
+  align-items: center;
+  gap: 6px;
+}
+
+:where(.dwt-page-title-input) {
+  box-sizing: border-box;
+  height: 28px;
+  padding: 0 8px;
+  font: inherit;
+  color: var(--dwt-text);
+  background: var(--dwt-surface, transparent);
+  border: 1px solid var(--dwt-border);
+  border-radius: 6px;
+}
+
+:where(.dwt-page-error) {
+  color: var(--dwt-text);
+  font-weight: 600;
+}
+
+:where(.dwt-move-select) {
+  box-sizing: border-box;
+  max-width: 9rem;
+  height: 28px;
+  font: inherit;
+  font-size: 0.8125rem;
+  color: var(--dwt-text);
+  background: var(--dwt-surface, transparent);
+  border: 1px solid var(--dwt-border);
+  border-radius: 6px;
+}
+
+:where(.dwt-page-panel) {
+  min-width: 0;
+}
+
 :where(.dwt-confirm) {
   display: inline-flex;
   align-items: center;
@@ -751,3 +877,15 @@
   border-radius: 6px;
   padding: 4px 8px;
 }
+
+/* The previous and next buttons only help when the tabs collapse to dots.
+   After .dwt-icon-button so this display wins. */
+:where(.dwt-page-nav) {
+  display: none;
+}
+
+@media (max-width: 640px) {
+  :where(.dwt-page-nav) {
+    display: inline-flex;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@richardmcquiston01/dashboard-widgets-toolkit",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Framework-agnostic dashboard widget toolkit: typed widget definitions and data payloads (KPI, gauge, table, bar list, alert list, chart), user layout (order, hide, minimise), and React renderers. Bring your own data providers.",
   "keywords": [
     "dashboard",