@coinbase/cds-mobile-visualization 0.0.0 → 3.4.0-beta.1

package/esm/chart/text/ChartText.js

@@ -0,0 +1,237 @@
+import React, { memo, useCallback, useEffect, useMemo, useState } from 'react';
+import { G, Rect as SvgRect, Text } from 'react-native-svg';
+import { useTheme } from '@coinbase/cds-mobile/hooks/useTheme';
+import { useCartesianChartContext } from '../ChartProvider';
+import { getChartInset } from '../utils';
+
+/**
+ * The supported content types for ChartText.
+ */
+
+/**
+ * Horizontal alignment options for chart text.
+ */
+
+/**
+ * Vertical alignment options for chart text.
+ */
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * Maps horizontal alignment to SVG textAnchor.
+ * This abstraction allows us to provide a consistent alignment API across web and mobile platforms,
+ * hiding the platform-specific SVG property differences.
+ */
+const getTextAnchor = alignment => {
+  switch (alignment) {
+    case 'left':
+      return 'start';
+    case 'center':
+      return 'middle';
+    case 'right':
+      return 'end';
+  }
+};
+
+/**
+ * Maps vertical alignment to SVG alignmentBaseline.
+ * This abstraction allows us to provide a consistent alignment API across web and mobile platforms,
+ * hiding the platform-specific SVG property differences.
+ */
+const getAlignmentBaseline = alignment => {
+  switch (alignment) {
+    case 'top':
+      return 'hanging';
+    case 'middle':
+      return 'central';
+    case 'bottom':
+      return 'ideographic';
+  }
+};
+const ChartTextVisible = /*#__PURE__*/memo(_ref => {
+  let {
+    children,
+    background,
+    textAnchor,
+    alignmentBaseline,
+    fontSize,
+    fontWeight,
+    fill,
+    borderRadius,
+    inset: insetInput,
+    textDimensions,
+    dx,
+    dy
+  } = _ref;
+  const theme = useTheme();
+  const inset = useMemo(() => getChartInset(insetInput), [insetInput]);
+  const rectHeight = useMemo(() => textDimensions.height + inset.top + inset.bottom, [textDimensions, inset]);
+  const rectWidth = useMemo(() => textDimensions.width + inset.left + inset.right, [textDimensions, inset]);
+  return /*#__PURE__*/_jsxs(G, {
+    children: [background !== 'transparent' && /*#__PURE__*/_jsx(SvgRect, {
+      fill: background,
+      height: rectHeight,
+      rx: borderRadius,
+      ry: borderRadius,
+      width: rectWidth,
+      x: textDimensions.x - inset.left,
+      y: textDimensions.y - inset.top
+    }), /*#__PURE__*/_jsx(Text, {
+      alignmentBaseline: alignmentBaseline,
+      dx: dx,
+      dy: dy,
+      fill: fill != null ? fill : theme.color.fgMuted,
+      fontSize: fontSize,
+      fontWeight: fontWeight,
+      textAnchor: textAnchor,
+      children: children
+    })]
+  });
+});
+export const ChartText = /*#__PURE__*/memo(_ref2 => {
+  let {
+    children,
+    x,
+    y,
+    horizontalAlignment = 'center',
+    verticalAlignment = 'middle',
+    dx,
+    dy,
+    disableRepositioning = false,
+    bounds,
+    testID,
+    fontSize = 12,
+    fontWeight,
+    color,
+    background = 'transparent',
+    borderRadius,
+    inset: insetInput,
+    onDimensionsChange,
+    opacity = 1
+  } = _ref2;
+  const {
+    width: chartWidth,
+    height: chartHeight
+  } = useCartesianChartContext();
+  const textAnchor = useMemo(() => getTextAnchor(horizontalAlignment), [horizontalAlignment]);
+  const alignmentBaseline = useMemo(() => getAlignmentBaseline(verticalAlignment), [verticalAlignment]);
+  const fullChartBounds = useMemo(() => ({
+    x: 0,
+    y: 0,
+    width: chartWidth,
+    height: chartHeight
+  }), [chartWidth, chartHeight]);
+  const [textSize, setTextSize] = useState(null);
+  const textBBox = useMemo(() => {
+    if (!textSize) {
+      return null;
+    }
+    return {
+      x: x + textSize.x,
+      y: y + textSize.y,
+      width: textSize.width,
+      height: textSize.height
+    };
+  }, [x, y, textSize]);
+  const isDimensionsReady = disableRepositioning || textBBox !== null;
+  const backgroundRectDimensions = useMemo(() => {
+    if (!textBBox) {
+      return null;
+    }
+    const inset = getChartInset(insetInput);
+    return {
+      x: textBBox.x - inset.left,
+      y: textBBox.y - inset.top,
+      width: textBBox.width + inset.left + inset.right,
+      height: textBBox.height + inset.top + inset.bottom
+    };
+  }, [textBBox, insetInput]);
+  const overflowAmount = useMemo(() => {
+    if (disableRepositioning) {
+      return {
+        x: 0,
+        y: 0
+      };
+    }
+    const parentBounds = bounds != null ? bounds : fullChartBounds;
+    if (!backgroundRectDimensions || !parentBounds || parentBounds.width <= 0 || parentBounds.height <= 0) {
+      return {
+        x: 0,
+        y: 0
+      };
+    }
+    let x = 0;
+    let y = 0;
+
+    // X-axis overflow
+    if (backgroundRectDimensions.x < parentBounds.x) {
+      x = parentBounds.x - backgroundRectDimensions.x; // positive = shift right
+    } else if (backgroundRectDimensions.x + backgroundRectDimensions.width > parentBounds.x + parentBounds.width) {
+      x = parentBounds.x + parentBounds.width - (backgroundRectDimensions.x + backgroundRectDimensions.width); // negative = shift left
+    }
+
+    // Y-axis overflow
+    if (backgroundRectDimensions.y < parentBounds.y) {
+      y = parentBounds.y - backgroundRectDimensions.y; // positive = shift down
+    } else if (backgroundRectDimensions.y + backgroundRectDimensions.height > parentBounds.y + parentBounds.height) {
+      y = parentBounds.y + parentBounds.height - (backgroundRectDimensions.y + backgroundRectDimensions.height); // negative = shift up
+    }
+    return {
+      x,
+      y
+    };
+  }, [backgroundRectDimensions, fullChartBounds, bounds, disableRepositioning]);
+  const reportedRect = useMemo(() => {
+    if (!backgroundRectDimensions) return null;
+    return {
+      x: backgroundRectDimensions.x + overflowAmount.x,
+      y: backgroundRectDimensions.y + overflowAmount.y,
+      width: backgroundRectDimensions.width,
+      height: backgroundRectDimensions.height
+    };
+  }, [backgroundRectDimensions, overflowAmount.x, overflowAmount.y]);
+  useEffect(() => {
+    if (onDimensionsChange && reportedRect !== null) {
+      onDimensionsChange(reportedRect);
+    }
+  }, [reportedRect, onDimensionsChange]);
+  const onLayout = useCallback(event => {
+    if (event.nativeEvent.layout.width > 0 && event.nativeEvent.layout.height > 0) {
+      setTextSize(event.nativeEvent.layout);
+    }
+  }, []);
+  return /*#__PURE__*/_jsxs(G, {
+    opacity: isDimensionsReady ? opacity : 0,
+    children: [textSize && /*#__PURE__*/_jsx(G, {
+      transform: [{
+        translateX: x + overflowAmount.x
+      }, {
+        translateY: y + overflowAmount.y
+      }],
+      children: /*#__PURE__*/_jsx(ChartTextVisible, {
+        alignmentBaseline: alignmentBaseline,
+        background: background,
+        borderRadius: borderRadius,
+        dx: dx,
+        dy: dy,
+        fill: color,
+        fontSize: fontSize,
+        fontWeight: fontWeight,
+        inset: insetInput,
+        textAnchor: textAnchor,
+        textDimensions: textSize,
+        children: children
+      })
+    }), /*#__PURE__*/_jsx(Text, {
+      alignmentBaseline: alignmentBaseline,
+      dx: dx,
+      dy: dy,
+      fill: "transparent",
+      fontSize: fontSize,
+      fontWeight: fontWeight,
+      onLayout: onLayout,
+      opacity: 0,
+      textAnchor: textAnchor,
+      children: children
+    })]
+  });
+});

package/esm/chart/text/SmartChartTextGroup.js

@@ -0,0 +1,210 @@
+const _excluded = ["onDimensionsChange"];
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+import { memo, useEffect, useMemo, useState } from 'react';
+import { G } from 'react-native-svg';
+import { ChartText } from './ChartText';
+
+/**
+ * Configuration for a single text label in the display list
+ */
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * Overlap check that enforces a minimum pixel gap between two rectangles.
+ * We inflate each rect by gap/2 on all sides so two neighbors must be at
+ * least `gap` pixels apart to be considered non-overlapping.
+ */
+function doRectsOverlapWithGap(a, b, gap) {
+  const g = gap / 2;
+  const overlapX = a.x - g < b.x + b.width + g && a.x + a.width + g > b.x - g;
+  const overlapY = a.y - g < b.y + b.height + g && a.y + a.height + g > b.y - g;
+  return overlapX && overlapY;
+}
+
+// Suppress state churn due to sub-pixel jitter in measurements
+const EPSILON_PX = 0.5;
+
+/**
+ * A smart text display component that prevents label overlap through collision detection.
+ *
+ * This component renders a list of ChartText components and automatically hides overlapping elements
+ * to ensure readability.
+ *
+ * The component focuses solely on overlap prevention logic for better separation of concerns.
+ */
+export const SmartChartTextGroup = /*#__PURE__*/memo(_ref => {
+  let {
+    labels,
+    minGap = 8,
+    prioritizeEndLabels = true,
+    chartTextProps
+  } = _ref;
+  const [boundingBoxes, setBoundingBoxes] = useState(new Map());
+  const _ref2 = chartTextProps != null ? chartTextProps : {},
+    {
+      onDimensionsChange: propsOnDimensionsChange
+    } = _ref2,
+    restChartTextProps = _objectWithoutPropertiesLoose(_ref2, _excluded);
+
+  // Generate a unique key to reference each label with.
+  const labelsWithKeys = useMemo(() => {
+    return labels.map((labelData, index) => _extends({}, labelData, {
+      key: labelData.label + "-" + index
+    }));
+  }, [labels]);
+
+  // Cleans up `boundingBoxes` state so that it only includes entries for the current set of labels
+  useEffect(() => {
+    const allLabelsKeys = new Set(labelsWithKeys.map(l => l.key));
+    setBoundingBoxes(prev => {
+      let changed = false;
+      const next = new Map();
+      for (const [k, v] of prev) {
+        if (allLabelsKeys.has(k)) next.set(k, v);else changed = true;
+      }
+      return changed ? next : prev;
+    });
+  }, [labelsWithKeys]);
+
+  // Build stable per-label measurement callbacks that recreate when labels change
+  const onDimensionsChangeByKey = useMemo(() => {
+    const map = new Map();
+    for (const labelData of labelsWithKeys) {
+      const {
+        key,
+        chartTextProps: labelChartTextProps
+      } = labelData;
+      map.set(key, bounds => {
+        labelChartTextProps == null || labelChartTextProps.onDimensionsChange == null || labelChartTextProps.onDimensionsChange(bounds);
+        propsOnDimensionsChange == null || propsOnDimensionsChange(bounds);
+        // Ignore zero-sized bounds and no-op updates (epsilon compare)
+        if (bounds.width === 0 || bounds.height === 0) return;
+        setBoundingBoxes(prev => {
+          const prevRect = prev.get(key);
+          const nearlyEqual = (a, b) => Math.abs(a - b) <= EPSILON_PX;
+          const isSame = prevRect !== undefined && nearlyEqual(prevRect.x, bounds.x) && nearlyEqual(prevRect.y, bounds.y) && nearlyEqual(prevRect.width, bounds.width) && nearlyEqual(prevRect.height, bounds.height);
+          if (isSame) return prev;
+          const newMap = new Map(prev);
+          newMap.set(key, bounds);
+          return newMap;
+        });
+      });
+    }
+    return map;
+  }, [labelsWithKeys, propsOnDimensionsChange]);
+
+  // Determine readiness: all current labels have measured bounding boxes
+  const isReady = useMemo(() => labelsWithKeys.every(l => boundingBoxes.has(l.key)), [labelsWithKeys, boundingBoxes]);
+
+  // Compute visible keys using stride attempts then greedy fallback
+  const visibleKeySet = useMemo(() => {
+    // Build ordered set of labels with rects for collision detection algorithm
+    const orderedWithRects = labelsWithKeys.map((l, idx) => _extends({}, l, {
+      rect: boundingBoxes.get(l.key)
+    })).filter(x => x.rect !== undefined);
+
+    // 1) Sort by horizontal position so neighbor checks are O(1)
+    //    For ties, sort bottom-to-top (higher y first) to get stable ordering
+    orderedWithRects.sort((a, b) => a.x === b.x ? b.y - a.y : a.x - b.x);
+
+    // 2) Defer selection until all labels have measured to avoid flicker and early hiding
+    if (!isReady) return null;
+    const n = orderedWithRects.length;
+    // 3) Trivial cases
+    if (n === 0) return new Set();
+    if (n === 1) return new Set([orderedWithRects[0].key]);
+
+    // 4) Two-label rule: if overlapping, prefer the first label (original order)
+    if (n === 2) {
+      const a = orderedWithRects[0];
+      const b = orderedWithRects[1];
+      const overlap = doRectsOverlapWithGap(a.rect, b.rect, minGap);
+      if (overlap) {
+        var _labelsWithKeys$;
+        const firstOriginal = (_labelsWithKeys$ = labelsWithKeys[0]) == null ? void 0 : _labelsWithKeys$.key;
+        return new Set([firstOriginal != null ? firstOriginal : a.key]);
+      }
+      return new Set([a.key, b.key]);
+    }
+
+    // 5) Utility: check only adjacent neighbors in x-order for overlap with gap
+    const hasNeighborOverlap = keysOrdered => {
+      for (let i = 0; i < keysOrdered.length - 1; i++) {
+        const ra = boundingBoxes.get(keysOrdered[i]);
+        const rb = boundingBoxes.get(keysOrdered[i + 1]);
+        if (doRectsOverlapWithGap(ra, rb, minGap)) return true;
+      }
+      return false;
+    };
+
+    // 6) Fast path: if every label fits, show them all without reduction
+    const allKeys = orderedWithRects.map(l => l.key);
+    if (!hasNeighborOverlap(allKeys)) {
+      return new Set(allKeys);
+    }
+
+    // 7) Try stride patterns: every 2nd, every 3rd, ... while ensuring ends when prioritized
+    const tryStride = stride => {
+      const selected = [];
+      for (let i = 0; i < n; i += stride) selected.push(orderedWithRects[i].key);
+      if (prioritizeEndLabels) {
+        const firstKey = orderedWithRects[0].key;
+        const lastKey = orderedWithRects[n - 1].key;
+        if (selected[0] !== firstKey) selected.unshift(firstKey);
+        if (selected[selected.length - 1] !== lastKey) selected.push(lastKey);
+      }
+      // Deduplicate while preserving order
+      const unique = Array.from(new Set(selected));
+      return hasNeighborOverlap(unique) ? new Set() : new Set(unique);
+    };
+
+    // 8) Increase stride until something fits or we exhaust options
+    for (let stride = 2; stride <= n; stride++) {
+      const attempt = tryStride(stride);
+      if (attempt.size > 0) return attempt;
+    }
+
+    // 9) Greedy fallback: walk left-to-right and keep a label only if it
+    //    does not overlap the previously accepted label. Optionally ensure last.
+    const greedy = [];
+    const firstKey = orderedWithRects[0].key;
+    const lastKey = orderedWithRects[n - 1].key;
+    greedy.push(firstKey);
+    for (let i = 1; i < n - 1; i++) {
+      const k = orderedWithRects[i].key;
+      const prevKey = greedy[greedy.length - 1];
+      const ra = boundingBoxes.get(prevKey);
+      const rb = boundingBoxes.get(k);
+      if (!doRectsOverlapWithGap(ra, rb, minGap)) {
+        greedy.push(k);
+      }
+    }
+    // Ensure last key when prioritized
+    if (prioritizeEndLabels) {
+      const lastIncluded = greedy[greedy.length - 1];
+      const ra = boundingBoxes.get(lastIncluded);
+      const rb = boundingBoxes.get(lastKey);
+      if (doRectsOverlapWithGap(ra, rb, minGap)) {
+        // Replace the last conflicting with the lastKey
+        greedy[greedy.length - 1] = lastKey;
+      } else if (lastIncluded !== lastKey) {
+        greedy.push(lastKey);
+      }
+    }
+    return new Set(greedy);
+  }, [isReady, boundingBoxes, minGap, prioritizeEndLabels, labelsWithKeys]);
+  return /*#__PURE__*/_jsx(G, {
+    children: labelsWithKeys.map(labelData => {
+      const hasMeasurement = boundingBoxes.has(labelData.key);
+      const isVisible = hasMeasurement && isReady && (visibleKeySet == null ? void 0 : visibleKeySet.has(labelData.key));
+      return /*#__PURE__*/_jsx(ChartText, _extends({
+        opacity: isVisible ? 1 : 0,
+        x: labelData.x,
+        y: labelData.y
+      }, restChartTextProps, labelData.chartTextProps, {
+        onDimensionsChange: onDimensionsChangeByKey.get(labelData.key),
+        children: labelData.label
+      }), labelData.key);
+    })
+  });
+});

package/esm/chart/text/index.js

@@ -0,0 +1,4 @@
+// codegen:start {preset: barrel, include: ./*.tsx, exclude: ./__stories__/*.tsx}
+export * from './ChartText';
+export * from './SmartChartTextGroup';
+// codegen:end