@cascivo/charts 0.5.1 → 0.6.0

package/dist/index.d.ts

@@ -1513,19 +1513,32 @@ declare function ScatterChart({
   visualMap,
   toolbox
 }: ScatterChartProps): import("react").JSX.Element;
-interface SparklineProps {
+interface SparklineBaseProps {
   data: readonly number[];
   width?: number;
   height?: number;
-  label: string;
   color?: string;
   endDot?: boolean;
 }
+/**
+ * Exactly one of `label` / `ariaLabel` is required — a chart with no accessible name is a
+ * bug, so this stays enforced by the type. `ariaLabel` is the catalog's convention for an
+ * invisible accessible name (here, the SVG `<title>`); `Sparkline` predates it and shipped
+ * `label`, so both work and neither is deprecated.
+ */
+type SparklineProps = SparklineBaseProps & ({
+  label: string;
+  ariaLabel?: never;
+} | {
+  ariaLabel: string;
+  label?: never;
+});
 declare function Sparkline({
   data,
   width,
   height,
   label,
+  ariaLabel,
   color,
   endDot
 }: SparklineProps): import("react").JSX.Element;
@@ -1556,7 +1569,19 @@ declare function Meter({
 interface KpiProps {
   value: string | number;
   label: string;
+  /**
+   * The change to show beside the value, as a **number** — `Kpi` owns the formatting
+   * (sign, arrow, colour, unit). Its sibling `Stat` takes a pre-formatted `string` and
+   * leaves formatting to you; that is the whole difference between the two tiles.
+   */
   delta?: number;
+  /**
+   * How to render `delta`. `'number'` (default) is locale-formatted with a sign.
+   * `'percent'` treats `delta` as already being in percentage points and appends `%`
+   * (`25.6` → `+25.6%`) — it does NOT multiply by 100. Pass a function for anything else;
+   * it receives the raw number and owns the entire string, sign included.
+   */
+  deltaFormat?: 'number' | 'percent' | ((delta: number) => string);
   deltaLabel?: string;
   icon?: ReactNode;
   sparkline?: readonly number[];
@@ -1566,6 +1591,7 @@ declare function Kpi({
   value,
   label,
   delta,
+  deltaFormat,
   deltaLabel,
   icon,
   sparkline,