@richardmcquiston01/dashboard-widgets-toolkit 0.13.0 → 0.15.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, O as OptionValues, 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 DetailSort, i as TextWidgetData, j as WidgetData, k as LayoutPersistence, S as StoreScope, P as PageItem, l as NormalizeOptions, m as ResolveOptions, n as WidgetContext, o as WidgetProviders } from './storage-DNB7gjvT.cjs';
+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';
 
 interface WidgetCardProps {
     readonly title: string;
@@ -154,7 +154,7 @@ declare function useDetailData(definition: WidgetDefinition, load: DetailLoader
 };
 
 /** Every element that carries a stable `dwt-*` class, for `classNames`. */
-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';
+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' | 'dialog';
 /**
  * Extra classes per slot, appended to the `dwt-*` class (never replacing
  * it), e.g. `{ card: 'rounded-lg shadow-sm' }` for Tailwind.
@@ -214,6 +214,38 @@ interface DashboardLabels {
     readonly menuMoveEarlier: string;
     readonly menuMoveLater: string;
     readonly menuHide: string;
+    /** The card menu's item that opens the Options dialog. */
+    readonly menuOptions: string;
+    /** The Options dialog: heading, fields and buttons. */
+    readonly optionsFor: (title: string) => string;
+    readonly optionsTitleField: string;
+    readonly titleInUse: string;
+    readonly optionsWidthField: string;
+    readonly widthDefault: string;
+    /** e.g. "6 of 12 (1/2)". */
+    readonly widthOption: (width: number, share: string) => string;
+    readonly optionsFlexible: string;
+    /** Label of the View field in the Options dialog. */
+    readonly optionsViewField: string;
+    /** A view's name when it is the one shown until the viewer picks, e.g. "Table (default)". */
+    readonly viewDefault: (viewLabel: string) => string;
+    readonly optionsDeclared: string;
+    readonly apply: string;
+    readonly cancel: string;
+    readonly resetToDefaults: string;
+    readonly revertToBeforeEditing: string;
+    readonly confirmApply: string;
+    readonly confirmDiscard: string;
+    readonly confirmResetOptions: string;
+    readonly confirmRevertOptions: string;
+    /** Announced after Apply, Reset or Revert. */
+    readonly optionsSaved: (title: string) => string;
+    readonly sortDefault: string;
+    readonly sortAscending: string;
+    readonly sortDescending: string;
+    readonly moveColumnUp: (column: string) => string;
+    readonly moveColumnDown: (column: string) => string;
+    readonly customRange: (value: string) => string;
     /** The card menu's heading over the pages a widget can move to. */
     readonly moveToPage: (title: string) => string;
     readonly moveToPagePlaceholder: string;
@@ -346,6 +378,27 @@ interface DashboardProps extends WidgetSettings {
  */
 declare function Dashboard({ locale, linkTarget, classNames, labels, ...props }: DashboardProps): ReactNode;
 
+interface WidgetOptionsDialogProps {
+    /** The author's definition, before the viewer's settings. */
+    readonly definition: WidgetDefinition;
+    /** What the viewer has saved for this widget. */
+    readonly settings: WidgetViewerSettings | undefined;
+    /**
+     * What they had when editing began, for "Revert to before editing". Leave it
+     * out to hide that button. `settings` may be `undefined` inside it, which
+     * means they had chosen nothing.
+     */
+    readonly baseline?: {
+        readonly settings: WidgetViewerSettings | undefined;
+    };
+    /** Whether another widget already shows this title; the dialog refuses it. */
+    readonly isTitleInUse?: (title: string) => boolean;
+    /** 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;
+
 /**
  * Default colors, used as `var(--dwt-*, fallback)` so charts read correctly
  * without the stylesheet. `styles.css` redefines them for dark mode, and an
@@ -520,4 +573,4 @@ interface UseWidgetsResult {
  */
 declare function useWidgets<C extends WidgetContext>(definitions: readonly WidgetDefinition[], providers: WidgetProviders<C>, context: C, options?: UseWidgetsOptions): UseWidgetsResult;
 
-export { AlertListWidget, BarListWidget, DEFAULT_LABELS, DEFAULT_SERIES_COLORS, Dashboard, type DashboardClassNames, type DashboardClassSlot, type DashboardLabels, type DashboardProps, type DetailLoadState, type DetailLoader, GaugeWidget, GraphWidget, KpiWidget, ResolvedWidgetCard, type ResolvedWidgetCardProps, type StoredLayoutConflict, type StoredLayoutStatus, TableWidget, TextWidget, Thumbnail, type UseStoredLayoutOptions, type UseStoredLayoutResult, type UseWidgetsOptions, type UseWidgetsResult, WidgetCard, type WidgetCardProps, WidgetContent, WidgetDetail, WidgetDetailDialog, type WidgetDetailDialogProps, type WidgetDetailProps, WidgetGrid, type WidgetGridProps, WidgetLink, type WidgetSettings, WidgetSettingsProvider, barPath, buildChartModel, describeChart, joinClassNames, seriesColor, useDetailData, useStoredLayout, useWidgetSettings, useWidgets, widgetTitle };
+export { AlertListWidget, BarListWidget, DEFAULT_LABELS, DEFAULT_SERIES_COLORS, Dashboard, type DashboardClassNames, type DashboardClassSlot, type DashboardLabels, type DashboardProps, type DetailLoadState, type DetailLoader, GaugeWidget, GraphWidget, KpiWidget, ResolvedWidgetCard, type ResolvedWidgetCardProps, type StoredLayoutConflict, type StoredLayoutStatus, TableWidget, TextWidget, Thumbnail, type UseStoredLayoutOptions, type UseStoredLayoutResult, type UseWidgetsOptions, type UseWidgetsResult, WidgetCard, type WidgetCardProps, WidgetContent, WidgetDetail, WidgetDetailDialog, type WidgetDetailDialogProps, type WidgetDetailProps, WidgetGrid, type WidgetGridProps, WidgetLink, WidgetOptionsDialog, type WidgetOptionsDialogProps, type WidgetSettings, WidgetSettingsProvider, barPath, buildChartModel, describeChart, joinClassNames, seriesColor, useDetailData, useStoredLayout, useWidgetSettings, useWidgets, widgetTitle };

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, O as OptionValues, 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 DetailSort, i as TextWidgetData, j as WidgetData, k as LayoutPersistence, S as StoreScope, P as PageItem, l as NormalizeOptions, m as ResolveOptions, n as WidgetContext, o as WidgetProviders } from './storage-DNB7gjvT.js';
+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';
 
 interface WidgetCardProps {
     readonly title: string;
@@ -154,7 +154,7 @@ declare function useDetailData(definition: WidgetDefinition, load: DetailLoader
 };
 
 /** Every element that carries a stable `dwt-*` class, for `classNames`. */
-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';
+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' | 'dialog';
 /**
  * Extra classes per slot, appended to the `dwt-*` class (never replacing
  * it), e.g. `{ card: 'rounded-lg shadow-sm' }` for Tailwind.
@@ -214,6 +214,38 @@ interface DashboardLabels {
     readonly menuMoveEarlier: string;
     readonly menuMoveLater: string;
     readonly menuHide: string;
+    /** The card menu's item that opens the Options dialog. */
+    readonly menuOptions: string;
+    /** The Options dialog: heading, fields and buttons. */
+    readonly optionsFor: (title: string) => string;
+    readonly optionsTitleField: string;
+    readonly titleInUse: string;
+    readonly optionsWidthField: string;
+    readonly widthDefault: string;
+    /** e.g. "6 of 12 (1/2)". */
+    readonly widthOption: (width: number, share: string) => string;
+    readonly optionsFlexible: string;
+    /** Label of the View field in the Options dialog. */
+    readonly optionsViewField: string;
+    /** A view's name when it is the one shown until the viewer picks, e.g. "Table (default)". */
+    readonly viewDefault: (viewLabel: string) => string;
+    readonly optionsDeclared: string;
+    readonly apply: string;
+    readonly cancel: string;
+    readonly resetToDefaults: string;
+    readonly revertToBeforeEditing: string;
+    readonly confirmApply: string;
+    readonly confirmDiscard: string;
+    readonly confirmResetOptions: string;
+    readonly confirmRevertOptions: string;
+    /** Announced after Apply, Reset or Revert. */
+    readonly optionsSaved: (title: string) => string;
+    readonly sortDefault: string;
+    readonly sortAscending: string;
+    readonly sortDescending: string;
+    readonly moveColumnUp: (column: string) => string;
+    readonly moveColumnDown: (column: string) => string;
+    readonly customRange: (value: string) => string;
     /** The card menu's heading over the pages a widget can move to. */
     readonly moveToPage: (title: string) => string;
     readonly moveToPagePlaceholder: string;
@@ -346,6 +378,27 @@ interface DashboardProps extends WidgetSettings {
  */
 declare function Dashboard({ locale, linkTarget, classNames, labels, ...props }: DashboardProps): ReactNode;
 
+interface WidgetOptionsDialogProps {
+    /** The author's definition, before the viewer's settings. */
+    readonly definition: WidgetDefinition;
+    /** What the viewer has saved for this widget. */
+    readonly settings: WidgetViewerSettings | undefined;
+    /**
+     * What they had when editing began, for "Revert to before editing". Leave it
+     * out to hide that button. `settings` may be `undefined` inside it, which
+     * means they had chosen nothing.
+     */
+    readonly baseline?: {
+        readonly settings: WidgetViewerSettings | undefined;
+    };
+    /** Whether another widget already shows this title; the dialog refuses it. */
+    readonly isTitleInUse?: (title: string) => boolean;
+    /** 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;
+
 /**
  * Default colors, used as `var(--dwt-*, fallback)` so charts read correctly
  * without the stylesheet. `styles.css` redefines them for dark mode, and an
@@ -520,4 +573,4 @@ interface UseWidgetsResult {
  */
 declare function useWidgets<C extends WidgetContext>(definitions: readonly WidgetDefinition[], providers: WidgetProviders<C>, context: C, options?: UseWidgetsOptions): UseWidgetsResult;
 
-export { AlertListWidget, BarListWidget, DEFAULT_LABELS, DEFAULT_SERIES_COLORS, Dashboard, type DashboardClassNames, type DashboardClassSlot, type DashboardLabels, type DashboardProps, type DetailLoadState, type DetailLoader, GaugeWidget, GraphWidget, KpiWidget, ResolvedWidgetCard, type ResolvedWidgetCardProps, type StoredLayoutConflict, type StoredLayoutStatus, TableWidget, TextWidget, Thumbnail, type UseStoredLayoutOptions, type UseStoredLayoutResult, type UseWidgetsOptions, type UseWidgetsResult, WidgetCard, type WidgetCardProps, WidgetContent, WidgetDetail, WidgetDetailDialog, type WidgetDetailDialogProps, type WidgetDetailProps, WidgetGrid, type WidgetGridProps, WidgetLink, type WidgetSettings, WidgetSettingsProvider, barPath, buildChartModel, describeChart, joinClassNames, seriesColor, useDetailData, useStoredLayout, useWidgetSettings, useWidgets, widgetTitle };
+export { AlertListWidget, BarListWidget, DEFAULT_LABELS, DEFAULT_SERIES_COLORS, Dashboard, type DashboardClassNames, type DashboardClassSlot, type DashboardLabels, type DashboardProps, type DetailLoadState, type DetailLoader, GaugeWidget, GraphWidget, KpiWidget, ResolvedWidgetCard, type ResolvedWidgetCardProps, type StoredLayoutConflict, type StoredLayoutStatus, TableWidget, TextWidget, Thumbnail, type UseStoredLayoutOptions, type UseStoredLayoutResult, type UseWidgetsOptions, type UseWidgetsResult, WidgetCard, type WidgetCardProps, WidgetContent, WidgetDetail, WidgetDetailDialog, type WidgetDetailDialogProps, type WidgetDetailProps, WidgetGrid, type WidgetGridProps, WidgetLink, WidgetOptionsDialog, type WidgetOptionsDialogProps, type WidgetSettings, WidgetSettingsProvider, barPath, buildChartModel, describeChart, joinClassNames, seriesColor, useDetailData, useStoredLayout, useWidgetSettings, useWidgets, widgetTitle };