basalt-ui 1.14.0 → 1.16.0

package/dist/charts/kinds/Bars.d.ts

@@ -1,7 +1,13 @@
-import type { ReactNode } from 'react';
+import type { ChartMargin } from '../../tokens/index.js';
+import type { AxisConfig, CartesianTooltipConfig } from '../primitives/CartesianChart.js';
 import type { ZoneSpec } from '../primitives/ZoneRects.js';
 import type { ChartLegendConfig } from '../series.js';
-export type BarsBar = {
+/**
+ * `T = unknown` is load-bearing, not a shortcut: it keeps a consumer's existing
+ * `const bars: BarsBar[] = [...]` compiling (and still assignable to `BarsBar<Row>[]`,
+ * contravariantly) even though the type is now generic over the datum.
+ */
+export type BarsBar<T = unknown> = {
     /** Field key — `getValue(d, key)` extracts the number (null = skip this slot, not domain hole). */
     key: string;
     /** Tooltip + legend label. */
@@ -9,21 +15,29 @@ export type BarsBar = {
     /** Fill color (a resolved CSS color / token ref). Per `docs/DESIGN-SPEC.md` §5, the primary bar
      * series should typically resolve to `VX.accent`, a secondary companion to `VX.faint`. */
     color: string;
-    /** Per-series tooltip value formatter — overrides top-level formatValue. */
-    formatValue?: (v: number) => string;
+    /** Per-series tooltip value formatter — overrides the left/right axis's own format. Receives the
+     * hovered datum alongside the value. */
+    formatValue?: (v: number, d: T) => string;
     /** Y axis to plot against. Honored only in grouped layout. Default 'left'. */
     axisSide?: 'left' | 'right';
     /** Relative width within the group (only honored in grouped layout). Default 1 — all bars equal. */
     weight?: number;
+    /** Default true; false = drawn and legended, but never listed as a tooltip row — threads
+     * `SeriesStyle.tooltip` through `Bars`, replacing the removed per-kind `hideBarTooltipRows`. */
+    tooltip?: boolean;
 };
-export type BarsLine = {
+export type BarsLine<T = unknown> = {
     key: string;
     label: string;
     color: string;
     axisSide?: 'left' | 'right';
     strokeWidth?: number;
     dashed?: boolean;
-    formatValue?: (v: number) => string;
+    formatValue?: (v: number, d: T) => string;
+    /** Default true; false = drawn and legended, but never listed as a tooltip row. */
+    tooltip?: boolean;
+    /** Dims the plotted stroke AND the legend swatch, never the tooltip row (`SeriesStyle.strokeOpacity`). */
+    strokeOpacity?: number;
 };
 /** @deprecated Use ZoneSpec from primitives/ZoneRects. Kept as an alias. */
 export type BarsZone = ZoneSpec;
@@ -34,43 +48,33 @@ export type BarsRefLine = {
     dashed?: boolean;
     axisSide?: 'left' | 'right';
 };
-export type BarsAxisConfig = {
-    /** Fixed [min, max] or 'auto' (computed from bars + lines + zones + refLines on this axis). */
-    domain: [number, number] | 'auto';
-    /** Auto-domain padding multiplier. Default 1.1. The lower bound always pads DOWN from
-     * `min(dataMin, autoMinCeil)` (never up, which would clip data) — see {@link padAutoLower}. */
-    autoPad?: number;
-    /** Auto-domain lower bound ceiling — never above this. Default 0. */
-    autoMinCeil?: number;
-    /** Auto-domain upper bound floor — never below this. */
-    autoMaxFloor?: number;
-    /** Tick label formatter (e.g. (v) => `${v}h`). */
-    formatTick?: (v: number) => string;
-    /** Number of ticks. Default 5. */
-    numTicks?: number;
-};
 export type BarsProps<T> = {
     data: T[];
-    /** Fixed height in pixels, forwarded to the internal `ChartFrame`. Default 240. */
+    /** Fixed height in pixels, forwarded to `CartesianChart`. Default 240. */
     height?: number;
     chartId: string;
     getX: (d: T) => string;
     /** Generic value accessor — given a data point and a bar/line key, returns the value or null. */
     getValue: (d: T, key: string) => number | null;
     /** 1+ bar series, stacked when ≥2, plotted above baseline (y >= 0). */
-    positiveBars: BarsBar[];
+    positiveBars: BarsBar<T>[];
     /** Optional bar series stacked below baseline (rendered as flipped negatives). */
-    negativeBars?: BarsBar[];
+    negativeBars?: BarsBar<T>[];
     /** 0–2 line overlays, each on left or right axis. */
-    lines?: BarsLine[];
+    lines?: BarsLine<T>[];
     /** Horizontal value-range overlays (target zones, optimal bands). */
     zones?: BarsZone[];
     /** Dashed/solid horizontal reference lines. */
     refLines?: BarsRefLine[];
-    /** Left axis config (always present — bars live here). */
-    leftAxis: BarsAxisConfig;
-    /** Right axis config — only required when at least one line/zone/refLine uses 'right'. */
-    rightAxis?: BarsAxisConfig;
+    /** Left axis config — bars always live here. In `barLayout: 'stacked'` (the default), `domain`
+     * defaults to the summed per-point stack total (bars + any left-axis lines), not a per-series
+     * max — the same function-domain seam `StackedArea` uses — unless overridden with a fixed tuple
+     * or a custom function. Optional, like every other kind's — omit it for a plain auto domain. */
+    y?: AxisConfig<T>;
+    /** Right axis config. Passing it is what makes the chart dual-axis: it draws the right axis and
+     * widens the right margin by measurement. Line overlays (and grouped-layout bars) opt in with
+     * `axisSide: 'right'`. */
+    y2?: AxisConfig<T>;
     /** Bar width as fraction of slot width. Default 0.6. */
     barWidthRatio?: number;
     /**
@@ -82,30 +86,18 @@ export type BarsProps<T> = {
     barLayout?: 'stacked' | 'grouped';
     /** Per-bar opacity override. Receives the data point + bar key. Default 0.85. */
     barOpacity?: (d: T, key: string) => number;
-    /** Tooltip badge — appears at the right of the tooltip header. */
-    tooltipLabel?: (d: T) => {
-        text: string;
-        color: string;
-    } | null;
-    /** Tooltip rows rendered BEFORE the generated bar/line rows. */
-    renderPrefixTooltipRows?: (d: T) => ReactNode;
-    /** Tooltip rows rendered AFTER the generated bar/line rows. */
-    renderExtraTooltipRows?: (d: T) => ReactNode;
-    /** Skip the auto-generated positive/negative bar rows in the tooltip (chart still renders them). */
-    hideBarTooltipRows?: boolean;
-    /** Default value formatter if a series doesn't define its own. */
-    formatValue?: (v: number) => string;
-    /** X-axis tick count override. */
-    numTicksX?: number;
-    /** Override the left margin (defaults to VX.margin.left = 44). Useful when
-     * y-axis labels are unusually wide (e.g. five-digit step counts). */
-    marginLeft?: number;
-    /** Legend config forwarded to `ChartFrame`; `false` disables the legend (sparkline escape).
+    /** X tick count override. Default: as many as fit. */
+    xTicks?: number;
+    /** `false` disables the tooltip entirely (and with it the crosshair dots). */
+    tooltip?: CartesianTooltipConfig<T> | false;
+    /** Per-side overrides of the measured margins — the escape hatch, applied last. */
+    margin?: Partial<ChartMargin>;
+    /** Legend config forwarded to `CartesianChart`; `false` disables the legend (sparkline escape).
      * Default `{ placement: 'bottom' }`. */
     legend?: ChartLegendConfig | false;
-    /** Accessible text alternative, forwarded to `ChartFrame` as `aria-label` (+ `role="img"`). */
+    /** Accessible text alternative, forwarded as `aria-label` (+ `role="img"`). */
     ariaLabel?: string;
-    /** Forwarded to `ChartFrame` — see `ChartPending`'s JSDoc for the three-state rationale. */
+    /** Forwarded to `CartesianChart` — see `ChartPending`'s JSDoc for the three-state rationale. */
     isPending?: boolean;
 };
 /**
@@ -113,10 +105,9 @@ export type BarsProps<T> = {
  * overlays on left/right axes, horizontal zones, and reference lines. Covers
  * diverging-stack + bar+line + any future stacked-bar preset.
  *
- * Composes `ChartFrame` for measuring + the derived legend — the legend was previously pushed
- * entirely to the consumer; it is now derived from `positiveBars` + `negativeBars` + `lines` and
- * owns its own hover-dim state (the legend-hover wiring that used to require a consumer-supplied
- * `highlightedKey` prop).
+ * Composes `CartesianChart` (`docs/CHARTS-SPEC.md` §2) — margin, scales, grid, axes, the shared
+ * cursor, the crosshair + per-series dots, and the tooltip are ALL the primitive's job. This file
+ * draws only the bar rects, the line overlays, and (for a diverging stack) the zero baseline.
  *
  * X-axis is built from the full `data` array so the calendar is preserved even
  * with per-bar nulls (nulls become visual gaps, not domain holes).

package/dist/charts/kinds/Bars.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Bars.d.ts","sourceRoot":"","sources":["../../../src/charts/kinds/Bars.tsx"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAatC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAGvD,OAAO,KAAK,EAAE,iBAAiB,EAAe,MAAM,WAAW,CAAA;AAK/D,MAAM,MAAM,OAAO,GAAG;IACpB,mGAAmG;IACnG,GAAG,EAAE,MAAM,CAAA;IACX,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb;8FAC0F;IAC1F,KAAK,EAAE,MAAM,CAAA;IACb,4EAA4E;IAC5E,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IACnC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3B,oGAAoG;IACpG,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;CACpC,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAA;AAE/B,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,oDAAoD;IACpD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,+FAA+F;IAC/F,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;IACjC;mGAC+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,qEAAqE;IACrE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,kDAAkD;IAClD,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAClC,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IACzB,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,mFAAmF;IACnF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,CAAA;IACtB,iGAAiG;IACjG,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IAE9C,uEAAuE;IACvE,YAAY,EAAE,OAAO,EAAE,CAAA;IACvB,kFAAkF;IAClF,YAAY,CAAC,EAAE,OAAO,EAAE,CAAA;IAExB,qDAAqD;IACrD,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;IAElB,qEAAqE;IACrE,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;IAClB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IAExB,0DAA0D;IAC1D,QAAQ,EAAE,cAAc,CAAA;IACxB,0FAA0F;IAC1F,SAAS,CAAC,EAAE,cAAc,CAAA;IAE1B,wDAAwD;IACxD,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAEjC,iFAAiF;IACjF,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAA;IAE1C,kEAAkE;IAClE,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAC/D,gEAAgE;IAChE,uBAAuB,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,SAAS,CAAA;IAC7C,+DAA+D;IAC/D,sBAAsB,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,SAAS,CAAA;IAC5C,oGAAoG;IACpG,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,kEAAkE;IAClE,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IACnC,kCAAkC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;yEACqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;4CACwC;IACxC,MAAM,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAA;IAClC,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,4FAA4F;IAC5F,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,iBAAS,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,+BAuExC;AAoZD;;;GAGG;AACH,eAAO,MAAM,IAAI,EAAsB,OAAO,SAAS,CAAA"}
+{"version":3,"file":"Bars.d.ts","sourceRoot":"","sources":["../../../src/charts/kinds/Bars.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE/C,OAAO,KAAK,EAAE,UAAU,EAAE,sBAAsB,EAAe,MAAM,8BAA8B,CAAA;AACnG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAEvD,OAAO,KAAK,EAAE,iBAAiB,EAAe,MAAM,WAAW,CAAA;AAG/D;;;;GAIG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,GAAG,OAAO,IAAI;IACjC,mGAAmG;IACnG,GAAG,EAAE,MAAM,CAAA;IACX,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb;8FAC0F;IAC1F,KAAK,EAAE,MAAM,CAAA;IACb;4CACwC;IACxC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,CAAA;IACzC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3B,oGAAoG;IACpG,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;oGACgG;IAChG,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,QAAQ,CAAC,CAAC,GAAG,OAAO,IAAI;IAClC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,CAAA;IACzC,mFAAmF;IACnF,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,0GAA0G;IAC1G,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAA;AAE/B,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,oDAAoD;IACpD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IACzB,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,0EAA0E;IAC1E,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,CAAA;IACtB,iGAAiG;IACjG,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IAE9C,uEAAuE;IACvE,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;IAC1B,kFAAkF;IAClF,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;IAE3B,qDAAqD;IACrD,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAA;IAErB,qEAAqE;IACrE,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;IAClB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IAExB;;;oGAGgG;IAChG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IACjB;;8BAE0B;IAC1B,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IAElB,wDAAwD;IACxD,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAEjC,iFAAiF;IACjF,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,CAAA;IAE1C,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,8EAA8E;IAC9E,OAAO,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;IAC3C,mFAAmF;IACnF,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAC7B;4CACwC;IACxC,MAAM,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAA;IAClC,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gGAAgG;IAChG,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,iBAAS,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,+BA+JxC;AA6ND;;;GAGG;AACH,eAAO,MAAM,IAAI,EAAsB,OAAO,SAAS,CAAA"}