@bpfdev/oly-ui 1.0.13 → 1.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -445,6 +445,11 @@ type QueueTimeBreakdownCustomization = {
445
445
  elevation?: number;
446
446
  /** Merged into the outer shell `CardContent` (padding, gaps). */
447
447
  cardContentSx?: SxProps$1<Theme$1>;
448
+ /**
449
+ * Merged onto the inner content `Stack` (wraps the columns). Defaults to `{ mb: 4 }` — override
450
+ * (e.g. `{ mb: 0 }`) to remove the bottom margin below the columns.
451
+ */
452
+ contentStackSx?: SxProps$1<Theme$1>;
448
453
  };
449
454
  periodFilter?: TimePeriodFilterTheme;
450
455
  header?: {
@@ -498,6 +503,13 @@ type QueueTimeBreakdownCustomization = {
498
503
  chartHeightPx?: number;
499
504
  };
500
505
  areaChart?: {
506
+ /**
507
+ * Opt-in: fill the available card height instead of the fixed `stackHeightPx`/`chartHeightPx`.
508
+ * Use when the card stretches to match a taller sibling column so the chart grows to fill it
509
+ * (no empty space above/below). Requires the parent `CardContent` to be a flex column.
510
+ * @default false (keeps the fixed-height behaviour — existing consumers are unaffected)
511
+ */
512
+ fillHeight?: boolean;
501
513
  stackHeightPx?: number;
502
514
  chartHeightPx?: number;
503
515
  margin?: {
@@ -540,6 +552,11 @@ type QueueTimeBreakdownDonutProps = {
540
552
  chartFilter: QueueTimeChartFilter;
541
553
  averageData: number[];
542
554
  LabelName: string;
555
+ /**
556
+ * Slice labels aligned by index with `averageData`. Supports any number of buckets — the donut
557
+ * renders one slice per value; values without a matching label fall back to `Bucket N`.
558
+ * Defaults to {@link DEFAULT_LABELS} (four queue-time buckets) when omitted.
559
+ */
543
560
  labels?: readonly string[];
544
561
  renderTooltip?: (context: QueueTimeBreakdownDonutTooltipRenderContext) => ReactNode;
545
562
  };
@@ -605,6 +622,21 @@ type QueueTimeBreakdownProps = {
605
622
  Donut_data: number[];
606
623
  /** Optional second donut; defaults to Donut_data for both sides. */
607
624
  donutYesterdayData?: number[];
625
+ /**
626
+ * Labels for the donut slices, aligned by index with `Donut_data` / `donutYesterdayData`.
627
+ * Required when the donut has more (or fewer) than the legacy four buckets — otherwise extra
628
+ * slices are dropped. Defaults to the donut's built-in labels when omitted.
629
+ */
630
+ donutLabels?: string[];
631
+ /**
632
+ * Real area-chart series (e.g. queue-time trend by bucket). Passing this (**even an empty array**)
633
+ * switches the area chart into real-data mode: it renders your series, or an empty state when there
634
+ * is no data — it never falls back to the built-in sample trend. Leave `undefined` to keep the
635
+ * sample data (demos). Pair with `areaXAxis` for matching category labels.
636
+ */
637
+ areaSeries?: QueueTimeAreaSeriesPoint[];
638
+ /** X-axis category labels for `areaSeries`. In real-data mode an empty/missing axis renders the empty state. */
639
+ areaXAxis?: string[];
608
640
  total_visitor_today?: number;
609
641
  overall_visitor_per_hour?: number;
610
642
  overall_visitor_per_min?: number;
@@ -2606,6 +2638,15 @@ type BillingCounterAnalyticsCustomization = {
2606
2638
  gridStrokeDasharray?: string;
2607
2639
  margin?: BillingCounterChartMargin;
2608
2640
  xAxisTickFill?: string;
2641
+ /**
2642
+ * Rotation angle (degrees) for X-axis tick labels.
2643
+ * `0` = horizontal (default), negative values slant labels (e.g. `-35`).
2644
+ */
2645
+ xAxisTickAngle?: number;
2646
+ /** Inline SVG style for X-axis tick text (typography/spacing). */
2647
+ xAxisTickStyle?: Record<string, string | number>;
2648
+ /** Reserved vertical space for the X-axis (Recharts `XAxis.height`). Default: `40`. */
2649
+ xAxisHeight?: number;
2609
2650
  yAxisTickFill?: string;
2610
2651
  yAxisWidth?: number;
2611
2652
  tooltip?: BillingCounterAnalyticsTooltipTheme;
@@ -2708,7 +2749,7 @@ declare function generateMockPerformanceData(): QueueTimeBreakdownBarRow[];
2708
2749
  /**
2709
2750
  * Queue time breakdown dashboard widget: stacked bars, queue buckets, donut comparison, area chart (Recharts).
2710
2751
  */
2711
- declare function QueueTimeBreakdown({ data, Donut_data, donutYesterdayData, headerImageSrc, headlineTotal, headlineSubtitle, dataComparisonTitle, queueBucketLegend, title, infoPopover, headlineInfoPopover, renderAreaTooltip, renderDonutTooltip, renderStackedBarTooltip, customization, }: QueueTimeBreakdownProps): React$1.ReactElement;
2752
+ declare function QueueTimeBreakdown({ data, Donut_data, donutYesterdayData, donutLabels, areaSeries, areaXAxis, headerImageSrc, headlineTotal, headlineSubtitle, dataComparisonTitle, queueBucketLegend, title, infoPopover, headlineInfoPopover, renderAreaTooltip, renderDonutTooltip, renderStackedBarTooltip, customization, }: QueueTimeBreakdownProps): React$1.ReactElement;
2712
2753
 
2713
2754
  /** Default ordered palette for the 4 stacked buckets (light → dark). */
2714
2755
  declare const STACKED_COMPARISON_DEFAULT_STACK_COLORS: readonly ["#CFE0FB", "#7FB1F0", "#3D7CDF", "#1E2A5E"];
@@ -3310,6 +3351,14 @@ type FootFallHeatMapKpiStripPresentation = {
3310
3351
  trackInsetPx?: number;
3311
3352
  /** Track background behind segments. */
3312
3353
  trackBackgroundColor?: string;
3354
+ /**
3355
+ * When **true**, child rows whose `overallData.count` is `0` are still included in the
3356
+ * ranked bar list (rendered with a 0-width fill so only **`trackBackgroundColor`** shows).
3357
+ * Default **false** keeps the historical "hide rows with no visitors" behavior — consumers
3358
+ * who want zero-visitor child tiles to remain visible (e.g. lifestyle store-performance
3359
+ * heat-maps) opt in by setting this to `true`.
3360
+ */
3361
+ includeZeroValueRows?: boolean;
3313
3362
  /** Merged onto the outer KPI panel (container under the breadcrumb). Applied after built-in layout styles. */
3314
3363
  kpiContainerSx?: SxProps$1<Theme$1>;
3315
3364
  /** Merged onto the summary KPI cards row `Stack` (direction, spacing, wrap). */
package/dist/index.d.ts CHANGED
@@ -445,6 +445,11 @@ type QueueTimeBreakdownCustomization = {
445
445
  elevation?: number;
446
446
  /** Merged into the outer shell `CardContent` (padding, gaps). */
447
447
  cardContentSx?: SxProps$1<Theme$1>;
448
+ /**
449
+ * Merged onto the inner content `Stack` (wraps the columns). Defaults to `{ mb: 4 }` — override
450
+ * (e.g. `{ mb: 0 }`) to remove the bottom margin below the columns.
451
+ */
452
+ contentStackSx?: SxProps$1<Theme$1>;
448
453
  };
449
454
  periodFilter?: TimePeriodFilterTheme;
450
455
  header?: {
@@ -498,6 +503,13 @@ type QueueTimeBreakdownCustomization = {
498
503
  chartHeightPx?: number;
499
504
  };
500
505
  areaChart?: {
506
+ /**
507
+ * Opt-in: fill the available card height instead of the fixed `stackHeightPx`/`chartHeightPx`.
508
+ * Use when the card stretches to match a taller sibling column so the chart grows to fill it
509
+ * (no empty space above/below). Requires the parent `CardContent` to be a flex column.
510
+ * @default false (keeps the fixed-height behaviour — existing consumers are unaffected)
511
+ */
512
+ fillHeight?: boolean;
501
513
  stackHeightPx?: number;
502
514
  chartHeightPx?: number;
503
515
  margin?: {
@@ -540,6 +552,11 @@ type QueueTimeBreakdownDonutProps = {
540
552
  chartFilter: QueueTimeChartFilter;
541
553
  averageData: number[];
542
554
  LabelName: string;
555
+ /**
556
+ * Slice labels aligned by index with `averageData`. Supports any number of buckets — the donut
557
+ * renders one slice per value; values without a matching label fall back to `Bucket N`.
558
+ * Defaults to {@link DEFAULT_LABELS} (four queue-time buckets) when omitted.
559
+ */
543
560
  labels?: readonly string[];
544
561
  renderTooltip?: (context: QueueTimeBreakdownDonutTooltipRenderContext) => ReactNode;
545
562
  };
@@ -605,6 +622,21 @@ type QueueTimeBreakdownProps = {
605
622
  Donut_data: number[];
606
623
  /** Optional second donut; defaults to Donut_data for both sides. */
607
624
  donutYesterdayData?: number[];
625
+ /**
626
+ * Labels for the donut slices, aligned by index with `Donut_data` / `donutYesterdayData`.
627
+ * Required when the donut has more (or fewer) than the legacy four buckets — otherwise extra
628
+ * slices are dropped. Defaults to the donut's built-in labels when omitted.
629
+ */
630
+ donutLabels?: string[];
631
+ /**
632
+ * Real area-chart series (e.g. queue-time trend by bucket). Passing this (**even an empty array**)
633
+ * switches the area chart into real-data mode: it renders your series, or an empty state when there
634
+ * is no data — it never falls back to the built-in sample trend. Leave `undefined` to keep the
635
+ * sample data (demos). Pair with `areaXAxis` for matching category labels.
636
+ */
637
+ areaSeries?: QueueTimeAreaSeriesPoint[];
638
+ /** X-axis category labels for `areaSeries`. In real-data mode an empty/missing axis renders the empty state. */
639
+ areaXAxis?: string[];
608
640
  total_visitor_today?: number;
609
641
  overall_visitor_per_hour?: number;
610
642
  overall_visitor_per_min?: number;
@@ -2606,6 +2638,15 @@ type BillingCounterAnalyticsCustomization = {
2606
2638
  gridStrokeDasharray?: string;
2607
2639
  margin?: BillingCounterChartMargin;
2608
2640
  xAxisTickFill?: string;
2641
+ /**
2642
+ * Rotation angle (degrees) for X-axis tick labels.
2643
+ * `0` = horizontal (default), negative values slant labels (e.g. `-35`).
2644
+ */
2645
+ xAxisTickAngle?: number;
2646
+ /** Inline SVG style for X-axis tick text (typography/spacing). */
2647
+ xAxisTickStyle?: Record<string, string | number>;
2648
+ /** Reserved vertical space for the X-axis (Recharts `XAxis.height`). Default: `40`. */
2649
+ xAxisHeight?: number;
2609
2650
  yAxisTickFill?: string;
2610
2651
  yAxisWidth?: number;
2611
2652
  tooltip?: BillingCounterAnalyticsTooltipTheme;
@@ -2708,7 +2749,7 @@ declare function generateMockPerformanceData(): QueueTimeBreakdownBarRow[];
2708
2749
  /**
2709
2750
  * Queue time breakdown dashboard widget: stacked bars, queue buckets, donut comparison, area chart (Recharts).
2710
2751
  */
2711
- declare function QueueTimeBreakdown({ data, Donut_data, donutYesterdayData, headerImageSrc, headlineTotal, headlineSubtitle, dataComparisonTitle, queueBucketLegend, title, infoPopover, headlineInfoPopover, renderAreaTooltip, renderDonutTooltip, renderStackedBarTooltip, customization, }: QueueTimeBreakdownProps): React$1.ReactElement;
2752
+ declare function QueueTimeBreakdown({ data, Donut_data, donutYesterdayData, donutLabels, areaSeries, areaXAxis, headerImageSrc, headlineTotal, headlineSubtitle, dataComparisonTitle, queueBucketLegend, title, infoPopover, headlineInfoPopover, renderAreaTooltip, renderDonutTooltip, renderStackedBarTooltip, customization, }: QueueTimeBreakdownProps): React$1.ReactElement;
2712
2753
 
2713
2754
  /** Default ordered palette for the 4 stacked buckets (light → dark). */
2714
2755
  declare const STACKED_COMPARISON_DEFAULT_STACK_COLORS: readonly ["#CFE0FB", "#7FB1F0", "#3D7CDF", "#1E2A5E"];
@@ -3310,6 +3351,14 @@ type FootFallHeatMapKpiStripPresentation = {
3310
3351
  trackInsetPx?: number;
3311
3352
  /** Track background behind segments. */
3312
3353
  trackBackgroundColor?: string;
3354
+ /**
3355
+ * When **true**, child rows whose `overallData.count` is `0` are still included in the
3356
+ * ranked bar list (rendered with a 0-width fill so only **`trackBackgroundColor`** shows).
3357
+ * Default **false** keeps the historical "hide rows with no visitors" behavior — consumers
3358
+ * who want zero-visitor child tiles to remain visible (e.g. lifestyle store-performance
3359
+ * heat-maps) opt in by setting this to `true`.
3360
+ */
3361
+ includeZeroValueRows?: boolean;
3313
3362
  /** Merged onto the outer KPI panel (container under the breadcrumb). Applied after built-in layout styles. */
3314
3363
  kpiContainerSx?: SxProps$1<Theme$1>;
3315
3364
  /** Merged onto the summary KPI cards row `Stack` (direction, spacing, wrap). */