@richardmcquiston01/dashboard-widgets-toolkit 0.9.0 → 0.10.0

package/dist/react.d.cts

@@ -1,5 +1,5 @@
 import { ReactNode, RefObject } from 'react';
-import { D as DashboardWidget, W as WidgetSize, a as WidgetFill, G as GraphWidgetData, N as NiceDomain, b as WidgetDefinition, c as DetailProviderOptions, d as DetailData, e as DetailQuery, L as Locale, f as DashboardLayout, A as AlertListWidgetData, B as BarListWidgetData, g as GaugeWidgetData, K as KpiWidgetData, T as TableWidgetData, R as ResolvedTableControls, h as TextWidgetData, i as WidgetData, j as ResolveOptions, k as WidgetContext, l as WidgetProviders } from './scale-CrXxawQn.cjs';
+import { D as DashboardWidget, W as WidgetSize, a as WidgetFill, G as GraphWidgetData, N as NiceDomain, b as WidgetDefinition, c as DetailProviderOptions, d as DetailData, e as DetailQuery, L as Locale, f as DashboardLayout, A as AlertListWidgetData, B as BarListWidgetData, g as GaugeWidgetData, K as KpiWidgetData, T as TableWidgetData, R as ResolvedTableControls, h as TextWidgetData, i as WidgetData, j as ResolveOptions, k as WidgetContext, l as WidgetProviders } from './scale-N69bo7wo.cjs';
 
 interface WidgetCardProps {
     readonly title: string;
@@ -152,7 +152,7 @@ declare function useDetailData(definition: WidgetDefinition, load: DetailLoader
 };
 
 /** Every element that carries a stable `dwt-*` class, for `classNames`. */
-type DashboardClassSlot = 'dashboard' | 'hiddenBar' | 'toolbar' | 'grid' | 'card' | 'cardHeader' | 'cardTitle' | 'cardDescription' | 'cardActions' | 'cardBody' | 'cardFooter' | 'button' | 'status' | 'empty' | 'error' | 'text' | 'kpi' | 'gauge' | 'table' | 'barList' | 'alertList' | 'chart' | 'legend' | 'tooltip' | 'tableTwin' | 'detail';
+type DashboardClassSlot = 'dashboard' | 'hiddenBar' | 'toolbar' | 'pageBar' | 'grid' | 'card' | 'cardHeader' | 'cardTitle' | 'cardDescription' | 'cardActions' | 'cardBody' | 'cardFooter' | 'button' | 'status' | 'empty' | 'error' | 'text' | 'kpi' | 'gauge' | 'table' | 'barList' | 'alertList' | 'chart' | 'legend' | 'tooltip' | 'tableTwin' | 'detail';
 /**
  * Extra classes per slot, appended to the `dwt-*` class (never replacing
  * it), e.g. `{ card: 'rounded-lg shadow-sm' }` for Tailwind.
@@ -190,6 +190,30 @@ interface DashboardLabels {
     readonly locked: (title: string) => string;
     /** The lock icon on a card shown to an administrator (`overrideLocks`). */
     readonly lockedForViewers: (title: string) => string;
+    /** Pages: names the tab list, and each tab ("Page 2 of 3: Sales"). */
+    readonly pageBar: string;
+    readonly pageTabName: (index: number, count: number, title: string) => string;
+    readonly previousPageButton: string;
+    readonly nextPageButton: string;
+    /** Page management while editing. */
+    readonly managePages: string;
+    readonly addPage: string;
+    readonly renamePage: (title: string) => string;
+    readonly pageTitle: string;
+    readonly savePageTitle: string;
+    readonly cancelPageTitle: string;
+    readonly deletePage: (title: string) => string;
+    readonly confirmDeletePage: (title: string) => string;
+    readonly movePageLeft: (title: string) => string;
+    readonly movePageRight: (title: string) => string;
+    /** The select on each card that moves it to another page. */
+    readonly moveToPage: (title: string) => string;
+    readonly moveToPagePlaceholder: string;
+    readonly moveToPageOption: (title: string, rowsFree: number) => string;
+    readonly newPageOption: string;
+    readonly movedToPage: (title: string, pageTitle: string) => string;
+    readonly pageFull: (pageTitle: string, maxRows: number) => string;
+    readonly emptyPage: string;
     /** Added to the accessible name of links that open in a new tab. */
     readonly opensInNewTab: string;
     /** The card's View button, opening the detail view. */
@@ -277,6 +301,19 @@ interface DashboardProps extends WidgetSettings {
     readonly defaultLayout?: DashboardLayout;
     /** Show the built-in Customize/Done/Reset toolbar (toggle mode). Default true. */
     readonly toolbar?: boolean;
+    /**
+     * The page in view (a page key) when the layout has pages. Controlled with
+     * `onActivePageChange`; without it the dashboard keeps its own, starting on
+     * `defaultActivePage` or the first page. Pages never listed fall back to
+     * the first.
+     */
+    readonly activePage?: string;
+    readonly defaultActivePage?: string;
+    readonly onActivePageChange?: (pageKey: string) => void;
+    /** Rows a page holds unless the page says otherwise. Default 4. */
+    readonly maxRows?: number;
+    /** Most pages the viewer can add while editing. Default: no limit. */
+    readonly maxPages?: number;
     readonly onRetry?: (key: string) => void;
     /**
      * Loads the full data for a widget's detail view (widgets whose definition

package/dist/react.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode, RefObject } from 'react';
-import { D as DashboardWidget, W as WidgetSize, a as WidgetFill, G as GraphWidgetData, N as NiceDomain, b as WidgetDefinition, c as DetailProviderOptions, d as DetailData, e as DetailQuery, L as Locale, f as DashboardLayout, A as AlertListWidgetData, B as BarListWidgetData, g as GaugeWidgetData, K as KpiWidgetData, T as TableWidgetData, R as ResolvedTableControls, h as TextWidgetData, i as WidgetData, j as ResolveOptions, k as WidgetContext, l as WidgetProviders } from './scale-CrXxawQn.js';
+import { D as DashboardWidget, W as WidgetSize, a as WidgetFill, G as GraphWidgetData, N as NiceDomain, b as WidgetDefinition, c as DetailProviderOptions, d as DetailData, e as DetailQuery, L as Locale, f as DashboardLayout, A as AlertListWidgetData, B as BarListWidgetData, g as GaugeWidgetData, K as KpiWidgetData, T as TableWidgetData, R as ResolvedTableControls, h as TextWidgetData, i as WidgetData, j as ResolveOptions, k as WidgetContext, l as WidgetProviders } from './scale-N69bo7wo.js';
 
 interface WidgetCardProps {
     readonly title: string;
@@ -152,7 +152,7 @@ declare function useDetailData(definition: WidgetDefinition, load: DetailLoader
 };
 
 /** Every element that carries a stable `dwt-*` class, for `classNames`. */
-type DashboardClassSlot = 'dashboard' | 'hiddenBar' | 'toolbar' | 'grid' | 'card' | 'cardHeader' | 'cardTitle' | 'cardDescription' | 'cardActions' | 'cardBody' | 'cardFooter' | 'button' | 'status' | 'empty' | 'error' | 'text' | 'kpi' | 'gauge' | 'table' | 'barList' | 'alertList' | 'chart' | 'legend' | 'tooltip' | 'tableTwin' | 'detail';
+type DashboardClassSlot = 'dashboard' | 'hiddenBar' | 'toolbar' | 'pageBar' | 'grid' | 'card' | 'cardHeader' | 'cardTitle' | 'cardDescription' | 'cardActions' | 'cardBody' | 'cardFooter' | 'button' | 'status' | 'empty' | 'error' | 'text' | 'kpi' | 'gauge' | 'table' | 'barList' | 'alertList' | 'chart' | 'legend' | 'tooltip' | 'tableTwin' | 'detail';
 /**
  * Extra classes per slot, appended to the `dwt-*` class (never replacing
  * it), e.g. `{ card: 'rounded-lg shadow-sm' }` for Tailwind.
@@ -190,6 +190,30 @@ interface DashboardLabels {
     readonly locked: (title: string) => string;
     /** The lock icon on a card shown to an administrator (`overrideLocks`). */
     readonly lockedForViewers: (title: string) => string;
+    /** Pages: names the tab list, and each tab ("Page 2 of 3: Sales"). */
+    readonly pageBar: string;
+    readonly pageTabName: (index: number, count: number, title: string) => string;
+    readonly previousPageButton: string;
+    readonly nextPageButton: string;
+    /** Page management while editing. */
+    readonly managePages: string;
+    readonly addPage: string;
+    readonly renamePage: (title: string) => string;
+    readonly pageTitle: string;
+    readonly savePageTitle: string;
+    readonly cancelPageTitle: string;
+    readonly deletePage: (title: string) => string;
+    readonly confirmDeletePage: (title: string) => string;
+    readonly movePageLeft: (title: string) => string;
+    readonly movePageRight: (title: string) => string;
+    /** The select on each card that moves it to another page. */
+    readonly moveToPage: (title: string) => string;
+    readonly moveToPagePlaceholder: string;
+    readonly moveToPageOption: (title: string, rowsFree: number) => string;
+    readonly newPageOption: string;
+    readonly movedToPage: (title: string, pageTitle: string) => string;
+    readonly pageFull: (pageTitle: string, maxRows: number) => string;
+    readonly emptyPage: string;
     /** Added to the accessible name of links that open in a new tab. */
     readonly opensInNewTab: string;
     /** The card's View button, opening the detail view. */
@@ -277,6 +301,19 @@ interface DashboardProps extends WidgetSettings {
     readonly defaultLayout?: DashboardLayout;
     /** Show the built-in Customize/Done/Reset toolbar (toggle mode). Default true. */
     readonly toolbar?: boolean;
+    /**
+     * The page in view (a page key) when the layout has pages. Controlled with
+     * `onActivePageChange`; without it the dashboard keeps its own, starting on
+     * `defaultActivePage` or the first page. Pages never listed fall back to
+     * the first.
+     */
+    readonly activePage?: string;
+    readonly defaultActivePage?: string;
+    readonly onActivePageChange?: (pageKey: string) => void;
+    /** Rows a page holds unless the page says otherwise. Default 4. */
+    readonly maxRows?: number;
+    /** Most pages the viewer can add while editing. Default: no limit. */
+    readonly maxPages?: number;
     readonly onRetry?: (key: string) => void;
     /**
      * Loads the full data for a widget's detail view (widgets whose definition