@coinbase/cds-web-visualization 3.4.0-beta.5 → 3.4.0-beta.7

package/dts/chart/point/Point.d.ts

@@ -0,0 +1,201 @@
+import React, { type SVGProps } from 'react';
+import type { SharedProps } from '@coinbase/cds-common/types';
+import { type Transition } from 'framer-motion';
+import type { ChartTextChildren, ChartTextProps } from '../text/ChartText';
+import { type PointLabelPosition } from '../utils';
+export type PointBaseProps = SharedProps & {
+  /**
+   * X coordinate in data space (not pixel coordinates).
+   */
+  dataX: number;
+  /**
+   * Y coordinate in data space (not pixel coordinates).
+   */
+  dataY: number;
+  /**
+   * The fill color of the point.
+   * @default 'var(--color-fgPrimary)'
+   */
+  fill?: string;
+  /**
+   * Optional Y-axis id to specify which axis to plot along.
+   * @default first y-axis defined in chart props.
+   */
+  yAxisId?: string;
+  /**
+   * Radius of the point.
+   * @default 5
+   */
+  radius?: number;
+  /**
+   * Opacity of the point.
+   */
+  opacity?: number;
+  /**
+   * Color of the outer stroke around the point.
+   * @default 'var(--color-bg)'
+   */
+  stroke?: string;
+  /**
+   * Outer stroke width of the point.
+   * Set to  0 to remove the stroke.
+   * @default 2
+   */
+  strokeWidth?: number;
+  /**
+   * When set, overrides the chart's animation setting for this specific point.
+   */
+  animate?: boolean;
+  /**
+   * Custom component to render the label.
+   * @default DefaultPointLabel
+   */
+  LabelComponent?: PointLabelComponent;
+  /**
+   * Position of the label relative to the point.
+   * @default 'center'
+   */
+  labelPosition?: PointLabelPosition;
+  /**
+   * Distance in pixels to offset the label from the point.
+   * @default 2 * radius
+   */
+  labelOffset?: number;
+  /**
+   * Font style for the label text.
+   */
+  labelFont?: ChartTextProps['font'];
+};
+/**
+ * Props for point label components.
+ */
+export type PointLabelProps = {
+  /**
+   * X coordinate in SVG pixel space.
+   */
+  x: number;
+  /**
+   * Y coordinate in SVG pixel space.
+   */
+  y: number;
+  /**
+   * X coordinate in data space (usually same as index).
+   */
+  dataX: number;
+  /**
+   * Y coordinate in data space (same as value).
+   */
+  dataY: number;
+  /**
+   * Fill color for the point.
+   */
+  fill: string;
+  /**
+   * Position of the label relative to the point.
+   * @default 'center'
+   */
+  position?: PointLabelPosition;
+  /**
+   * Distance in pixels to offset the label from the point.
+   */
+  offset?: number;
+  /**
+   * Content to display in the label.
+   */
+  children: ChartTextChildren;
+};
+export type PointLabelComponent = React.FC<PointLabelProps>;
+export type PointProps = PointBaseProps &
+  Omit<
+    SVGProps<SVGCircleElement>,
+    | 'onClick'
+    | 'onAnimationStart'
+    | 'onAnimationEnd'
+    | 'onAnimationIteration'
+    | 'onAnimationStartCapture'
+    | 'onAnimationEndCapture'
+    | 'onAnimationIterationCapture'
+    | 'onDrag'
+    | 'onDragEnd'
+    | 'onDragStart'
+    | 'onDragCapture'
+    | 'onDragEndCapture'
+    | 'onDragStartCapture'
+    | 'cx'
+    | 'cy'
+    | 'r'
+    | 'fill'
+    | 'stroke'
+    | 'strokeWidth'
+    | 'opacity'
+    | 'className'
+    | 'style'
+    | 'aria-label'
+    | 'role'
+    | 'tabIndex'
+    | 'onKeyDown'
+  > & {
+    /**
+     * Simple text label to display at the point position.
+     * If provided, a label component will be automatically rendered.
+     */
+    label?: ChartTextChildren;
+    /**
+     * Handler for when the point is clicked.
+     */
+    onClick?: (
+      event: React.MouseEvent,
+      point: {
+        x: number;
+        y: number;
+        dataX: number;
+        dataY: number;
+      },
+    ) => void;
+    /**
+     * Custom class name for the point.
+     */
+    className?: string;
+    /**
+     * Custom styles for the point.
+     */
+    style?: React.CSSProperties;
+    /**
+     * Custom class names for the component.
+     */
+    classNames?: {
+      /**
+       * Custom class name for the point root element.
+       */
+      root?: string;
+      /**
+       * Custom class name for the inner circle element.
+       */
+      point?: string;
+    };
+    /**
+     * Custom styles for the component.
+     */
+    styles?: {
+      /**
+       * Custom styles for the point root element.
+       */
+      root?: React.CSSProperties;
+      /**
+       * Custom styles for the inner circle element.
+       */
+      point?: React.CSSProperties;
+    };
+    /**
+     * Accessibility label for screen readers to describe the point.
+     * If not provided, a default label will be generated using the data coordinates.
+     */
+    accessibilityLabel?: string;
+    /**
+     * Transition configuration for animation.
+     * @default defaultTransition
+     */
+    transition?: Transition;
+  };
+export declare const Point: React.NamedExoticComponent<PointProps>;
+//# sourceMappingURL=Point.d.ts.map

package/dts/chart/point/Point.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Point.d.ts","sourceRoot":"","sources":["../../../src/chart/point/Point.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAQ,KAAK,QAAQ,EAAW,MAAM,OAAO,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAG9D,OAAO,EAAe,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAG7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,EAAE,KAAK,kBAAkB,EAAgB,MAAM,UAAU,CAAC;AAsBjE,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC;;;OAGG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;AAE5D,MAAM,MAAM,UAAU,GAAG,cAAc,GACrC,IAAI,CACF,QAAQ,CAAC,gBAAgB,CAAC,EACxB,SAAS,GACT,kBAAkB,GAClB,gBAAgB,GAChB,sBAAsB,GACtB,yBAAyB,GACzB,uBAAuB,GACvB,6BAA6B,GAC7B,QAAQ,GACR,WAAW,GACX,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,oBAAoB,GACpB,IAAI,GACJ,IAAI,GACJ,GAAG,GACH,MAAM,GACN,QAAQ,GACR,aAAa,GACb,SAAS,GACT,WAAW,GACX,OAAO,GACP,YAAY,GACZ,MAAM,GACN,UAAU,GACV,WAAW,CACd,GAAG;IACF;;;OAGG;IACH,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,KAAK,CAAC,UAAU,EACvB,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KAC1D,IAAI,CAAC;IACV;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC3B;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;KAC7B,CAAC;IACF;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,CAAC;AAEJ,eAAO,MAAM,KAAK,wCAsMjB,CAAC"}

package/dts/chart/point/index.d.ts

@@ -0,0 +1,3 @@
+export * from './DefaultPointLabel';
+export * from './Point';
+//# sourceMappingURL=index.d.ts.map

package/dts/chart/point/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/chart/point/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC"}

package/dts/chart/scrubber/DefaultScrubberBeacon.d.ts

@@ -0,0 +1,24 @@
+import { type Transition } from 'framer-motion';
+import type { ScrubberBeaconProps, ScrubberBeaconRef } from './Scrubber';
+export type DefaultScrubberBeaconProps = ScrubberBeaconProps;
+export declare const DefaultScrubberBeacon: import('react').MemoExoticComponent<
+  import('react').ForwardRefExoticComponent<
+    import('@coinbase/cds-common').SharedProps & {
+      seriesId: import('..').Series['id'];
+      color?: string;
+      dataX: number;
+      dataY: number;
+      isIdle?: boolean;
+      idlePulse?: boolean;
+      transitions?: {
+        update?: Transition;
+        pulse?: Transition;
+        pulseRepeatDelay?: number;
+      };
+      opacity?: number;
+      className?: string;
+      style?: React.CSSProperties;
+    } & import('react').RefAttributes<ScrubberBeaconRef>
+  >
+>;
+//# sourceMappingURL=DefaultScrubberBeacon.d.ts.map

package/dts/chart/scrubber/DefaultScrubberBeacon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultScrubberBeacon.d.ts","sourceRoot":"","sources":["../../../src/chart/scrubber/DefaultScrubberBeacon.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,UAAU,EAGhB,MAAM,eAAe,CAAC;AAKvB,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAiBzE,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC;AAE7D,eAAO,MAAM,qBAAqB;;;;;;;;cAwCT,CAAC;aAKI,CAAA;wBAMZ,CAAC;;;;;sDA4GlB,CAAC"}

package/dts/chart/scrubber/DefaultScrubberBeaconLabel.d.ts

@@ -0,0 +1,12 @@
+import { type ChartTextProps } from '../text';
+import type { ScrubberBeaconLabelProps } from './Scrubber';
+export type DefaultScrubberBeaconLabelProps = ScrubberBeaconLabelProps &
+  Pick<
+    ChartTextProps,
+    'background' | 'elevated' | 'borderRadius' | 'font' | 'verticalAlignment' | 'inset' | 'opacity'
+  >;
+/**
+ * DefaultScrubberBeaconLabel is a special instance of ChartText used to label a series' scrubber beacon (i.e. a point on the series pinned to the scrubber position).
+ */
+export declare const DefaultScrubberBeaconLabel: import('react').NamedExoticComponent<DefaultScrubberBeaconLabelProps>;
+//# sourceMappingURL=DefaultScrubberBeaconLabel.d.ts.map

package/dts/chart/scrubber/DefaultScrubberBeaconLabel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultScrubberBeaconLabel.d.ts","sourceRoot":"","sources":["../../../src/chart/scrubber/DefaultScrubberBeaconLabel.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAa,KAAK,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAK3D,MAAM,MAAM,+BAA+B,GAAG,wBAAwB,GACpE,IAAI,CACF,cAAc,EACd,YAAY,GAAG,UAAU,GAAG,cAAc,GAAG,MAAM,GAAG,mBAAmB,GAAG,OAAO,GAAG,SAAS,CAChG,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,0BAA0B,uEAiCtC,CAAC"}

package/dts/chart/scrubber/DefaultScrubberLabel.d.ts

@@ -0,0 +1,10 @@
+import type { ScrubberLabelProps } from './Scrubber';
+export type DefaultScrubberLabelProps = ScrubberLabelProps;
+/**
+ * DefaultScrubberLabel is the default label component for the scrubber line.
+ * It will center the label vertically with the top available area.
+ */
+export declare const DefaultScrubberLabel: import('react').NamedExoticComponent<
+  import('..').ReferenceLineLabelComponentProps
+>;
+//# sourceMappingURL=DefaultScrubberLabel.d.ts.map

package/dts/chart/scrubber/DefaultScrubberLabel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultScrubberLabel.d.ts","sourceRoot":"","sources":["../../../src/chart/scrubber/DefaultScrubberLabel.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD,MAAM,MAAM,yBAAyB,GAAG,kBAAkB,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,qFAYhC,CAAC"}

package/dts/chart/scrubber/Scrubber.d.ts

@@ -1,27 +1,124 @@
 import React from 'react';
 import type { SharedProps } from '@coinbase/cds-common/types';
-import { type ReferenceLineProps } from '../line';
-import { type ScrubberBeaconProps, type ScrubberBeaconRef } from './ScrubberBeacon';
-import { type ScrubberBeaconLabelProps } from './ScrubberBeaconLabel';
-export type ScrubberRef = ScrubberBeaconRef;
-/**
- * Configuration for scrubber functionality across chart components.
- * Provides consistent API with smart defaults and component customization.
- */
-export type ScrubberProps = SharedProps &
-  Pick<ScrubberBeaconProps, 'idlePulse'> & {
+import { type Transition } from 'framer-motion';
+import { type ReferenceLineBaseProps, type ReferenceLineLabelComponentProps } from '../line';
+import type { ChartTextProps } from '../text';
+import { type ChartInset, type Series } from '../utils';
+import {
+  type ScrubberBeaconGroupBaseProps,
+  type ScrubberBeaconGroupProps,
+  type ScrubberBeaconGroupRef,
+} from './ScrubberBeaconGroup';
+import {
+  type ScrubberBeaconLabelGroupBaseProps,
+  type ScrubberBeaconLabelGroupProps,
+} from './ScrubberBeaconLabelGroup';
+export type ScrubberBeaconRef = {
+  /**
+   * Triggers a single pulse animation.
+   * Only works when the beacon is in idle state (not actively scrubbing).
+   */
+  pulse: () => void;
+};
+export type ScrubberBeaconProps = SharedProps & {
+  /**
+   * Id of the series.
+   */
+  seriesId: Series['id'];
+  /**
+   * Color of the series.
+   */
+  color?: string;
+  /**
+   * X coordinate in data space.
+   */
+  dataX: number;
+  /**
+   * Y coordinate in data space.
+   */
+  dataY: number;
+  /**
+   * Whether the beacon is in idle state (not actively scrubbing).
+   */
+  isIdle?: boolean;
+  /**
+   * Pulse the beacon while it is at rest.
+   */
+  idlePulse?: boolean;
+  /**
+   * Transition configuration for beacon animations.
+   */
+  transitions?: {
+    /**
+     * Transition used for beacon position updates.
+     * @default defaultTransition
+     */
+    update?: Transition;
+    /**
+     * Transition used for the pulse animation.
+     * @default { duration: 1.6, ease: 'easeInOut' }
+     */
+    pulse?: Transition;
+    /**
+     * Delay, in seconds between pulse transitions
+     * when `idlePulse` is enabled.
+     * @default 0.4
+     */
+    pulseRepeatDelay?: number;
+  };
+  /**
+   * Opacity of the beacon.
+   * @default 1
+   */
+  opacity?: number;
+  /**
+   * Custom className for styling.
+   */
+  className?: string;
+  /**
+   * Custom inline styles.
+   */
+  style?: React.CSSProperties;
+};
+export type ScrubberBeaconComponent = React.FC<
+  ScrubberBeaconProps & {
+    ref?: React.Ref<ScrubberBeaconRef>;
+  }
+>;
+export type ScrubberBeaconLabelProps = Pick<Series, 'color'> &
+  Pick<
+    ChartTextProps,
+    'x' | 'y' | 'dx' | 'horizontalAlignment' | 'onDimensionsChange' | 'opacity' | 'font'
+  > & {
     /**
-     * An array of series IDs that will receive visual emphasis as the user scrubs through the chart.
-     * Use this prop to restrict the scrubbing visual behavior to specific series.
-     * By default, all series will be highlighted by the Scrubber.
+     * Label for the series.
+     */
+    label: string;
+    /**
+     * Id of the series.
+     */
+    seriesId: Series['id'];
+  };
+export type ScrubberBeaconLabelComponent = React.FC<ScrubberBeaconLabelProps>;
+export type ScrubberLabelProps = ReferenceLineLabelComponentProps;
+export type ScrubberLabelComponent = React.FC<ScrubberLabelProps>;
+export type ScrubberBaseProps = SharedProps &
+  Pick<ScrubberBeaconGroupBaseProps, 'idlePulse'> &
+  Pick<ReferenceLineBaseProps, 'LineComponent' | 'LabelComponent' | 'labelElevated'> &
+  Pick<ScrubberBeaconGroupProps, 'BeaconComponent'> &
+  Pick<ScrubberBeaconLabelGroupProps, 'BeaconLabelComponent'> & {
+    /**
+     * Array of series IDs to highlight when scrubbing with scrubber beacons.
+     * By default, all series will be highlighted.
      */
     seriesIds?: string[];
     /**
-     * Hides the scrubber line
+     * Hides the scrubber line.
+     * @note This hides Scrubber's ReferenceLine including the label.
      */
     hideLine?: boolean;
     /**
-     * Whether to hide the overlay rect which obscures future data.
+     * Hides the overlay rect which obscures data beyond the scrubber position.
      */
     hideOverlay?: boolean;
     /**
@@ -31,68 +128,92 @@ export type ScrubberProps = SharedProps &
      */
     overlayOffset?: number;
     /**
-     * Label text displayed above the scrubber line.
+     * Minimum gap between beacon labels to prevent overlap.
+     * Measured in pixels.
      */
-    label?: ReferenceLineProps['label'] | ((dataIndex: number) => ReferenceLineProps['label']);
+    beaconLabelMinGap?: ScrubberBeaconLabelGroupBaseProps['labelMinGap'];
     /**
-     * Props passed to the scrubber line's label.
+     * Horizontal offset for beacon labels from their beacon position.
+     * Measured in pixels.
      */
-    labelProps?: ReferenceLineProps['labelProps'];
+    beaconLabelHorizontalOffset?: ScrubberBeaconLabelGroupBaseProps['labelHorizontalOffset'];
     /**
-     * Stroke color for the scrubber line.
+     * Label text displayed above the scrubber line.
+     * Can be a static string or a function that receives the current dataIndex.
      */
-    lineStroke?: ReferenceLineProps['stroke'];
+    label?:
+      | ReferenceLineBaseProps['label']
+      | ((dataIndex: number) => ReferenceLineBaseProps['label']);
     /**
-     * Custom styles for scrubber elements.
+     * Font style for the scrubber line label.
      */
-    styles?: {
-      overlay?: React.CSSProperties;
-      beacon?: React.CSSProperties;
-      line?: React.CSSProperties;
-      beaconLabel?: React.CSSProperties;
-    };
+    labelFont?: ChartTextProps['font'];
     /**
-     * Custom class names for scrubber elements.
+     * Bounds inset for the scrubber line label to prevent cutoff at chart edges.
+     * @default { top: 4, bottom: 20, left: 12, right: 12 } when labelElevated is true, otherwise none
      */
-    classNames?: {
-      overlay?: string;
-      beacon?: string;
-      line?: string;
-      beaconLabel?: string;
-    };
+    labelBoundsInset?: number | ChartInset;
     /**
-     * Custom component for the scrubber beacon.
+     * Font style for the beacon labels.
      */
-    BeaconComponent?: React.ComponentType<ScrubberBeaconProps>;
+    beaconLabelFont?: ChartTextProps['font'];
     /**
-     * Custom component for the scrubber beacon label.
+     * Stroke color for the scrubber line.
      */
-    BeaconLabelComponent?: React.ComponentType<ScrubberBeaconLabelProps>;
+    lineStroke?: ReferenceLineBaseProps['stroke'];
     /**
-     * Custom component for the scrubber line.
+     * Transition configuration for the scrubber beacon.
      */
-    LineComponent?: React.ComponentType<ReferenceLineProps>;
+    beaconTransitions?: ScrubberBeaconProps['transitions'];
+  };
+export type ScrubberProps = ScrubberBaseProps & {
+  /**
+   * Accessibility label for the scrubber. Can be a static string or a function that receives the current dataIndex.
+   * If not provided, label will be used if it resolves to a string.
+   */
+  accessibilityLabel?: string | ((dataIndex: number) => string);
+  /**
+   * Custom styles for scrubber elements.
+   */
+  styles?: {
+    overlay?: React.CSSProperties;
+    beacon?: React.CSSProperties;
+    line?: React.CSSProperties;
+    beaconLabel?: React.CSSProperties;
   };
+  /**
+   * Custom class names for scrubber elements.
+   */
+  classNames?: {
+    overlay?: string;
+    beacon?: string;
+    line?: string;
+    beaconLabel?: string;
+  };
+};
+export type ScrubberRef = ScrubberBeaconGroupRef;
 /**
- * Unified component that manages all scrubber elements (beacons, line, labels)
- * with intelligent collision detection and consistent positioning.
+ * Unified component that manages all scrubber elements (beacons, line, labels).
  */
 export declare const Scrubber: React.MemoExoticComponent<
   React.ForwardRefExoticComponent<
     SharedProps &
-      Pick<ScrubberBeaconProps, 'idlePulse'> & {
+      Pick<ScrubberBeaconGroupBaseProps, 'idlePulse'> &
+      Pick<ReferenceLineBaseProps, 'LabelComponent' | 'LineComponent' | 'labelElevated'> &
+      Pick<ScrubberBeaconGroupProps, 'BeaconComponent'> &
+      Pick<ScrubberBeaconLabelGroupProps, 'BeaconLabelComponent'> & {
         /**
-         * An array of series IDs that will receive visual emphasis as the user scrubs through the chart.
-         * Use this prop to restrict the scrubbing visual behavior to specific series.
-         * By default, all series will be highlighted by the Scrubber.
+         * Array of series IDs to highlight when scrubbing with scrubber beacons.
+         * By default, all series will be highlighted.
          */
         seriesIds?: string[];
         /**
-         * Hides the scrubber line
+         * Hides the scrubber line.
+         * @note This hides Scrubber's ReferenceLine including the label.
          */
         hideLine?: boolean;
         /**
-         * Whether to hide the overlay rect which obscures future data.
+         * Hides the overlay rect which obscures data beyond the scrubber position.
          */
         hideOverlay?: boolean;
         /**
@@ -101,18 +222,50 @@ export declare const Scrubber: React.MemoExoticComponent<
          * @default 2
          */
         overlayOffset?: number;
+        /**
+         * Minimum gap between beacon labels to prevent overlap.
+         * Measured in pixels.
+         */
+        beaconLabelMinGap?: ScrubberBeaconLabelGroupBaseProps['labelMinGap'];
+        /**
+         * Horizontal offset for beacon labels from their beacon position.
+         * Measured in pixels.
+         */
+        beaconLabelHorizontalOffset?: ScrubberBeaconLabelGroupBaseProps['labelHorizontalOffset'];
         /**
          * Label text displayed above the scrubber line.
+         * Can be a static string or a function that receives the current dataIndex.
          */
-        label?: ReferenceLineProps['label'] | ((dataIndex: number) => ReferenceLineProps['label']);
+        label?:
+          | ReferenceLineBaseProps['label']
+          | ((dataIndex: number) => ReferenceLineBaseProps['label']);
         /**
-         * Props passed to the scrubber line's label.
+         * Font style for the scrubber line label.
          */
-        labelProps?: ReferenceLineProps['labelProps'];
+        labelFont?: ChartTextProps['font'];
+        /**
+         * Bounds inset for the scrubber line label to prevent cutoff at chart edges.
+         * @default { top: 4, bottom: 20, left: 12, right: 12 } when labelElevated is true, otherwise none
+         */
+        labelBoundsInset?: number | ChartInset;
+        /**
+         * Font style for the beacon labels.
+         */
+        beaconLabelFont?: ChartTextProps['font'];
         /**
          * Stroke color for the scrubber line.
          */
-        lineStroke?: ReferenceLineProps['stroke'];
+        lineStroke?: ReferenceLineBaseProps['stroke'];
+        /**
+         * Transition configuration for the scrubber beacon.
+         */
+        beaconTransitions?: ScrubberBeaconProps['transitions'];
+      } & {
+        /**
+         * Accessibility label for the scrubber. Can be a static string or a function that receives the current dataIndex.
+         * If not provided, label will be used if it resolves to a string.
+         */
+        accessibilityLabel?: string | ((dataIndex: number) => string);
         /**
          * Custom styles for scrubber elements.
          */
@@ -131,19 +284,7 @@ export declare const Scrubber: React.MemoExoticComponent<
           line?: string;
           beaconLabel?: string;
         };
-        /**
-         * Custom component for the scrubber beacon.
-         */
-        BeaconComponent?: React.ComponentType<ScrubberBeaconProps>;
-        /**
-         * Custom component for the scrubber beacon label.
-         */
-        BeaconLabelComponent?: React.ComponentType<ScrubberBeaconLabelProps>;
-        /**
-         * Custom component for the scrubber line.
-         */
-        LineComponent?: React.ComponentType<ReferenceLineProps>;
-      } & React.RefAttributes<ScrubberBeaconRef>
+      } & React.RefAttributes<ScrubberBeaconGroupRef>
   >
 >;
 //# sourceMappingURL=Scrubber.d.ts.map

package/dts/chart/scrubber/Scrubber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Scrubber.d.ts","sourceRoot":"","sources":["../../../src/chart/scrubber/Scrubber.tsx"],"names":[],"mappings":"AAAA,OAAO,KASN,MAAM,OAAO,CAAC;AAEf,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAK9D,OAAO,EAAiB,KAAK,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAGjE,OAAO,EAAkB,KAAK,mBAAmB,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACpG,OAAO,EAAuB,KAAK,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAI3F,MAAM,MAAM,WAAW,GAAG,iBAAiB,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GACrC,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC,GAAG;IACvC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;IAE3F;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC9B,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC7B,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC3B,WAAW,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;KACnC,CAAC;IAEF;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAC3D;;OAEG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC;IACrE;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;CACzD,CAAC;AAUJ;;;GAGG;AACH,eAAO,MAAM,QAAQ;IAlFjB;;;;OAIG;gBACS,MAAM,EAAE;IACpB;;OAEG;eACQ,OAAO;IAClB;;OAEG;kBACW,OAAO;IAErB;;;;OAIG;oBACa,MAAM;IAEtB;;OAEG;YACK,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAE1F;;OAEG;iBACU,kBAAkB,CAAC,YAAY,CAAC;IAC7C;;OAEG;iBACU,kBAAkB,CAAC,QAAQ,CAAC;IAEzC;;OAEG;aACM;QACP,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC9B,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC7B,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC3B,WAAW,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;KACnC;IAED;;OAEG;iBACU;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED;;OAEG;sBACe,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC;IAC1D;;OAEG;2BACoB,KAAK,CAAC,aAAa,CAAC,wBAAwB,CAAC;IACpE;;OAEG;oBACa,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC;4CAsjB1D,CAAC"}
+{"version":3,"file":"Scrubber.d.ts","sourceRoot":"","sources":["../../../src/chart/scrubber/Scrubber.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAyD,MAAM,OAAO,CAAC;AAC9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAe,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAG7D,OAAO,EAEL,KAAK,sBAAsB,EAC3B,KAAK,gCAAgC,EACtC,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAGL,KAAK,UAAU,EAGf,KAAK,MAAM,EAEZ,MAAM,UAAU,CAAC;AAIlB,OAAO,EAEL,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,KAAK,iCAAiC,EACtC,KAAK,6BAA6B,EACnC,MAAM,4BAA4B,CAAC;AAEpC,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG;IAC9C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;;WAGG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB;;;WAGG;QACH,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,EAAE,CAC5C,mBAAmB,GAAG;IAAE,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;CAAE,CAC7D,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1D,IAAI,CACF,cAAc,EACd,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,qBAAqB,GAAG,oBAAoB,GAAG,SAAS,GAAG,MAAM,CACrF,GAAG;IACF;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AACJ,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAC;AAE9E,MAAM,MAAM,kBAAkB,GAAG,gCAAgC,CAAC;AAClE,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;AAElE,MAAM,MAAM,iBAAiB,GAAG,WAAW,GACzC,IAAI,CAAC,4BAA4B,EAAE,WAAW,CAAC,GAC/C,IAAI,CAAC,sBAAsB,EAAE,eAAe,GAAG,gBAAgB,GAAG,eAAe,CAAC,GAClF,IAAI,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,GACjD,IAAI,CAAC,6BAA6B,EAAE,sBAAsB,CAAC,GAAG;IAC5D;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,iCAAiC,CAAC,aAAa,CAAC,CAAC;IACrE;;;OAGG;IACH,2BAA2B,CAAC,EAAE,iCAAiC,CAAC,uBAAuB,CAAC,CAAC;IACzF;;;OAGG;IACH,KAAK,CAAC,EACF,sBAAsB,CAAC,OAAO,CAAC,GAC/B,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7D;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IACvC;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACzC;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC;CACxD,CAAC;AAEJ,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG;IAC9C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IAC9D;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC9B,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC7B,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC3B,WAAW,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;KACnC,CAAC;IACF;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,sBAAsB,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,QAAQ;IA3FjB;;;OAGG;gBACS,MAAM,EAAE;IACpB;;;OAGG;eACQ,OAAO;IAClB;;OAEG;kBACW,OAAO;IACrB;;;;OAIG;oBACa,MAAM;IACtB;;;OAGG;wBACiB,iCAAiC,CAAC,aAAa,CAAC;IACpE;;;OAGG;kCAC2B,iCAAiC,CAAC,uBAAuB,CAAC;IACxF;;;OAGG;YAEC,sBAAsB,CAAC,OAAO,CAAC,GAC/B,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAC5D;;OAEG;gBACS,cAAc,CAAC,MAAM,CAAC;IAClC;;;OAGG;uBACgB,MAAM,GAAG,UAAU;IACtC;;OAEG;sBACe,cAAc,CAAC,MAAM,CAAC;IACxC;;OAEG;iBACU,sBAAsB,CAAC,QAAQ,CAAC;IAC7C;;OAEG;wBACiB,mBAAmB,CAAC,aAAa,CAAC;;IAIxD;;;OAGG;yBACkB,MAAM,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7D;;OAEG;aACM;QACP,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC9B,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC7B,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAC3B,WAAW,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;KACnC;IACD;;OAEG;iBACU;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;iDAuLF,CAAC"}