@richardmcquiston01/dashboard-widgets-toolkit 0.15.0 → 0.17.0

package/dist/react.d.cts

@@ -1,5 +1,5 @@
 import { ReactNode, ReactElement, 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, O as OptionValues, L as Locale, f as DashboardLayout, g as WidgetViewerSettings, h as WidgetSettingsPatch, A as AlertListWidgetData, B as BarListWidgetData, i as GaugeWidgetData, K as KpiWidgetData, T as TableWidgetData, R as ResolvedTableControls, j as DetailSort, k as TextWidgetData, l as WidgetData, m as LayoutPersistence, S as StoreScope, P as PageItem, n as NormalizeOptions, o as ResolveOptions, p as WidgetContext, q as WidgetProviders } from './storage-DwJ-vGJg.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, O as OptionValues, L as Locale, f as DashboardLayout, g as WidgetViewerSettings, h as WidgetSettingsPatch, A as AlertListWidgetData, B as BarListWidgetData, i as GaugeWidgetData, K as KpiWidgetData, T as TableWidgetData, R as ResolvedTableControls, j as DetailSort, k as TextWidgetData, l as WidgetData, m as LayoutPersistence, S as StoreScope, P as PageItem, n as NormalizeOptions, o as ResolveOptions, p as WidgetContext, q as WidgetProviders } from './storage-CRBfjiVZ.cjs';
 
 interface WidgetCardProps {
     readonly title: string;
@@ -216,6 +216,18 @@ interface DashboardLabels {
     readonly menuHide: string;
     /** The card menu's item that opens the Options dialog. */
     readonly menuOptions: string;
+    /** Arrange menu item that makes a clone of the widget. */
+    readonly menuDuplicate: string;
+    readonly duplicate: (title: string) => string;
+    /** Accessible name of Duplicate when the page has no room; `reason` says why. */
+    readonly duplicateBlocked: (title: string, reason: string) => string;
+    readonly duplicated: (title: string) => string;
+    /** Options dialog button that deletes a clone. */
+    readonly optionsDelete: string;
+    readonly confirmDelete: string;
+    readonly deleted: (title: string) => string;
+    /** The title suggested for a clone shown with another view. */
+    readonly suggestedViewTitle: (title: string, viewLabel: string) => string;
     /** The Options dialog: heading, fields and buttons. */
     readonly optionsFor: (title: string) => string;
     readonly optionsTitleField: string;
@@ -393,11 +405,18 @@ interface WidgetOptionsDialogProps {
     };
     /** Whether another widget already shows this title; the dialog refuses it. */
     readonly isTitleInUse?: (title: string) => boolean;
+    /**
+     * For a clone: its original's title, so choosing another view can suggest
+     * a title like "Recent Orders Line Chart".
+     */
+    readonly sourceTitle?: string;
+    /** For a clone: shows "Delete this widget"; called after the viewer confirms. */
+    readonly onDelete?: () => void;
     /** Called after the viewer confirms Apply, Reset or Revert. */
     readonly onApply: (patch: WidgetSettingsPatch) => void;
     readonly onClose: () => void;
 }
-declare function WidgetOptionsDialog({ definition, settings, baseline, isTitleInUse, onApply, onClose, }: WidgetOptionsDialogProps): ReactElement;
+declare function WidgetOptionsDialog({ definition, settings, baseline, isTitleInUse, sourceTitle, onDelete, onApply, onClose, }: WidgetOptionsDialogProps): ReactElement;
 
 /**
  * Default colors, used as `var(--dwt-*, fallback)` so charts read correctly
@@ -547,6 +566,13 @@ interface UseWidgetsOptions extends ResolveOptions {
      * fresh object each render.
      */
     readonly optionValues?: Readonly<Record<string, Readonly<Record<string, unknown>> | undefined>>;
+    /**
+     * The view each widget shows, by widget key (see `viewValuesFromLayout`).
+     * Only views the provider supplies matter: choosing one loads it (the
+     * provider is called with `options.view`), and the card shows loading until
+     * it arrives. It may be a fresh object each render.
+     */
+    readonly viewValues?: Readonly<Record<string, string | undefined>>;
 }
 interface UseWidgetsResult {
     /** Pass to `Dashboard` or `WidgetGrid`: placeholders first, then results. */
@@ -555,6 +581,8 @@ interface UseWidgetsResult {
     readonly refresh: (key?: string) => void;
     /** Choose option values for one widget; same effect as `optionValues`. */
     readonly setOptions: (key: string, chosen: Readonly<Record<string, unknown>>) => void;
+    /** Choose a widget's view; same effect as `viewValues`. */
+    readonly setView: (key: string, view: string | undefined) => void;
     /**
      * For `loadWhen: 'visible'`: attach to any element that contains the cards,
      * for example a wrapper `<div ref={gridRef}>` around `Dashboard`.

package/dist/react.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode, ReactElement, 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, O as OptionValues, L as Locale, f as DashboardLayout, g as WidgetViewerSettings, h as WidgetSettingsPatch, A as AlertListWidgetData, B as BarListWidgetData, i as GaugeWidgetData, K as KpiWidgetData, T as TableWidgetData, R as ResolvedTableControls, j as DetailSort, k as TextWidgetData, l as WidgetData, m as LayoutPersistence, S as StoreScope, P as PageItem, n as NormalizeOptions, o as ResolveOptions, p as WidgetContext, q as WidgetProviders } from './storage-DwJ-vGJg.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, O as OptionValues, L as Locale, f as DashboardLayout, g as WidgetViewerSettings, h as WidgetSettingsPatch, A as AlertListWidgetData, B as BarListWidgetData, i as GaugeWidgetData, K as KpiWidgetData, T as TableWidgetData, R as ResolvedTableControls, j as DetailSort, k as TextWidgetData, l as WidgetData, m as LayoutPersistence, S as StoreScope, P as PageItem, n as NormalizeOptions, o as ResolveOptions, p as WidgetContext, q as WidgetProviders } from './storage-CRBfjiVZ.js';
 
 interface WidgetCardProps {
     readonly title: string;
@@ -216,6 +216,18 @@ interface DashboardLabels {
     readonly menuHide: string;
     /** The card menu's item that opens the Options dialog. */
     readonly menuOptions: string;
+    /** Arrange menu item that makes a clone of the widget. */
+    readonly menuDuplicate: string;
+    readonly duplicate: (title: string) => string;
+    /** Accessible name of Duplicate when the page has no room; `reason` says why. */
+    readonly duplicateBlocked: (title: string, reason: string) => string;
+    readonly duplicated: (title: string) => string;
+    /** Options dialog button that deletes a clone. */
+    readonly optionsDelete: string;
+    readonly confirmDelete: string;
+    readonly deleted: (title: string) => string;
+    /** The title suggested for a clone shown with another view. */
+    readonly suggestedViewTitle: (title: string, viewLabel: string) => string;
     /** The Options dialog: heading, fields and buttons. */
     readonly optionsFor: (title: string) => string;
     readonly optionsTitleField: string;
@@ -393,11 +405,18 @@ interface WidgetOptionsDialogProps {
     };
     /** Whether another widget already shows this title; the dialog refuses it. */
     readonly isTitleInUse?: (title: string) => boolean;
+    /**
+     * For a clone: its original's title, so choosing another view can suggest
+     * a title like "Recent Orders Line Chart".
+     */
+    readonly sourceTitle?: string;
+    /** For a clone: shows "Delete this widget"; called after the viewer confirms. */
+    readonly onDelete?: () => void;
     /** Called after the viewer confirms Apply, Reset or Revert. */
     readonly onApply: (patch: WidgetSettingsPatch) => void;
     readonly onClose: () => void;
 }
-declare function WidgetOptionsDialog({ definition, settings, baseline, isTitleInUse, onApply, onClose, }: WidgetOptionsDialogProps): ReactElement;
+declare function WidgetOptionsDialog({ definition, settings, baseline, isTitleInUse, sourceTitle, onDelete, onApply, onClose, }: WidgetOptionsDialogProps): ReactElement;
 
 /**
  * Default colors, used as `var(--dwt-*, fallback)` so charts read correctly
@@ -547,6 +566,13 @@ interface UseWidgetsOptions extends ResolveOptions {
      * fresh object each render.
      */
     readonly optionValues?: Readonly<Record<string, Readonly<Record<string, unknown>> | undefined>>;
+    /**
+     * The view each widget shows, by widget key (see `viewValuesFromLayout`).
+     * Only views the provider supplies matter: choosing one loads it (the
+     * provider is called with `options.view`), and the card shows loading until
+     * it arrives. It may be a fresh object each render.
+     */
+    readonly viewValues?: Readonly<Record<string, string | undefined>>;
 }
 interface UseWidgetsResult {
     /** Pass to `Dashboard` or `WidgetGrid`: placeholders first, then results. */
@@ -555,6 +581,8 @@ interface UseWidgetsResult {
     readonly refresh: (key?: string) => void;
     /** Choose option values for one widget; same effect as `optionValues`. */
     readonly setOptions: (key: string, chosen: Readonly<Record<string, unknown>>) => void;
+    /** Choose a widget's view; same effect as `viewValues`. */
+    readonly setView: (key: string, view: string | undefined) => void;
     /**
      * For `loadWhen: 'visible'`: attach to any element that contains the cards,
      * for example a wrapper `<div ref={gridRef}>` around `Dashboard`.