@coinbase/cds-mobile-visualization 3.4.0-beta.5 → 3.4.0-beta.6

package/esm/chart/CartesianChart.js

@@ -1,40 +1,63 @@
-const _excluded = ["series", "animate", "enableScrubbing", "xAxis", "yAxis", "inset", "onScrubberPositionChange", "children", "width", "height", "style", "allowOverflowGestures"];
+const _excluded = ["series", "children", "animate", "enableScrubbing", "xAxis", "yAxis", "inset", "onScrubberPositionChange", "width", "height", "style", "styles", "allowOverflowGestures", "fontFamilies", "fontProvider", "collapsable"];
 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 React, { forwardRef, memo, useCallback, useMemo } from 'react';
-import { Svg } from 'react-native-svg';
 import { useLayout } from '@coinbase/cds-mobile/hooks/useLayout';
 import { Box } from '@coinbase/cds-mobile/layout';
+import { Canvas, Skia } from '@shopify/react-native-skia';
 import { ScrubberProvider } from './scrubber/ScrubberProvider';
+import { convertToSerializableScale } from './utils/scale';
+import { useChartContextBridge } from './ChartContextBridge';
 import { CartesianChartProvider } from './ChartProvider';
 import { defaultAxisId, defaultChartInset, getAxisConfig, getAxisDomain, getAxisRange, getAxisScale, getChartInset, getStackedSeriesData as calculateStackedSeriesData, useTotalAxisPadding } from './utils';
 import { jsx as _jsx } from "react/jsx-runtime";
-export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, ref) => {
+const ChartCanvas = /*#__PURE__*/memo(_ref => {
+  let {
+    children,
+    style
+  } = _ref;
+  const ContextBridge = useChartContextBridge();
+  return /*#__PURE__*/_jsx(Canvas, {
+    style: [{
+      width: '100%',
+      height: '100%'
+    }, style],
+    children: /*#__PURE__*/_jsx(ContextBridge, {
+      children: children
+    })
+  });
+});
+export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref2, ref) => {
   let {
       series,
+      children,
       animate = true,
       enableScrubbing,
-      xAxis: xAxisConfigInput,
-      yAxis: yAxisConfigInput,
-      inset: insetInput,
+      xAxis: xAxisConfigProp,
+      yAxis: yAxisConfigProp,
+      inset,
       onScrubberPositionChange,
-      children,
       width = '100%',
       height = '100%',
       style,
-      allowOverflowGestures
-    } = _ref,
-    props = _objectWithoutPropertiesLoose(_ref, _excluded);
+      styles,
+      allowOverflowGestures,
+      fontFamilies,
+      fontProvider: fontProviderProp,
+      // React Native will collapse views by default when only used
+      // to group children, which interferes with gesture-handler
+      // https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/gesture-detector/#:~:text=%7B%0A%20%20return%20%3C-,View,-collapsable%3D%7B
+      collapsable = false
+    } = _ref2,
+    props = _objectWithoutPropertiesLoose(_ref2, _excluded);
   const [containerLayout, onContainerLayout] = useLayout();
-  const chartWidth = typeof width === 'number' ? width : containerLayout.width;
-  const chartHeight = typeof height === 'number' ? height : containerLayout.height;
-  const userInset = useMemo(() => {
-    return getChartInset(insetInput, defaultChartInset);
-  }, [insetInput]);
+  const chartWidth = containerLayout.width;
+  const chartHeight = containerLayout.height;
+  const calculatedInset = useMemo(() => getChartInset(inset, defaultChartInset), [inset]);
 
   // there can only be one x axis but the helper function always returns an array
-  const xAxisConfig = useMemo(() => getAxisConfig('x', xAxisConfigInput)[0], [xAxisConfigInput]);
-  const yAxisConfig = useMemo(() => getAxisConfig('y', yAxisConfigInput), [yAxisConfigInput]);
+  const xAxisConfig = useMemo(() => getAxisConfig('x', xAxisConfigProp)[0], [xAxisConfigProp]);
+  const yAxisConfig = useMemo(() => getAxisConfig('y', yAxisConfigProp), [yAxisConfigProp]);
   const {
     renderedAxes,
     registerAxis,
@@ -42,11 +65,11 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
     axisPadding
   } = useTotalAxisPadding();
   const totalInset = useMemo(() => ({
-    top: userInset.top + axisPadding.top,
-    right: userInset.right + axisPadding.right,
-    bottom: userInset.bottom + axisPadding.bottom,
-    left: userInset.left + axisPadding.left
-  }), [userInset, axisPadding]);
+    top: calculatedInset.top + axisPadding.top,
+    right: calculatedInset.right + axisPadding.right,
+    bottom: calculatedInset.bottom + axisPadding.bottom,
+    left: calculatedInset.left + axisPadding.left
+  }), [calculatedInset, axisPadding]);
   const chartRect = useMemo(() => {
     if (chartWidth <= 0 || chartHeight <= 0) return {
       x: 0,
@@ -63,8 +86,14 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
       height: availableHeight > 0 ? availableHeight : 0
     };
   }, [chartHeight, chartWidth, totalInset]);
-  const xAxis = useMemo(() => {
-    if (!chartRect || chartRect.width <= 0 || chartRect.height <= 0) return undefined;
+  const {
+    xAxis,
+    xScale
+  } = useMemo(() => {
+    if (!chartRect || chartRect.width <= 0 || chartRect.height <= 0) return {
+      xAxis: undefined,
+      xScale: undefined
+    };
     const domain = getAxisDomain(xAxisConfig, series != null ? series : [], 'x');
     const range = getAxisRange(xAxisConfig, chartRect, 'x');
     const axisConfig = {
@@ -75,11 +104,47 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
       categoryPadding: xAxisConfig.categoryPadding,
       domainLimit: xAxisConfig.domainLimit
     };
-    return axisConfig;
+
+    // Create the scale
+    const scale = getAxisScale({
+      config: axisConfig,
+      type: 'x',
+      range: axisConfig.range,
+      dataDomain: axisConfig.domain
+    });
+    if (!scale) return {
+      xAxis: undefined,
+      xScale: undefined
+    };
+
+    // Update axis config with actual scale domain (after .nice() or other adjustments)
+    const scaleDomain = scale.domain();
+    const actualDomain = Array.isArray(scaleDomain) && scaleDomain.length === 2 ? {
+      min: scaleDomain[0],
+      max: scaleDomain[1]
+    } : axisConfig.domain;
+    const finalAxisConfig = _extends({}, axisConfig, {
+      domain: actualDomain
+    });
+    return {
+      xAxis: finalAxisConfig,
+      xScale: scale
+    };
   }, [xAxisConfig, series, chartRect]);
-  const yAxes = useMemo(() => {
+  const xSerializableScale = useMemo(() => {
+    if (!xScale) return;
+    return convertToSerializableScale(xScale);
+  }, [xScale]);
+  const {
+    yAxes,
+    yScales
+  } = useMemo(() => {
     const axes = new Map();
-    if (!chartRect || chartRect.width <= 0 || chartRect.height <= 0) return axes;
+    const scales = new Map();
+    if (!chartRect || chartRect.width <= 0 || chartRect.height <= 0) return {
+      yAxes: axes,
+      yScales: scales
+    };
     yAxisConfig.forEach(axisParam => {
       var _axisParam$id, _series$filter, _axisParam$domainLimi;
       const axisId = (_axisParam$id = axisParam.id) != null ? _axisParam$id : defaultAxisId;
@@ -90,33 +155,19 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
         return ((_s$yAxisId = s.yAxisId) != null ? _s$yAxisId : defaultAxisId) === axisId;
       })) != null ? _series$filter : [];
 
-      // Calculate domain and range in one pass
-      const domain = getAxisDomain(axisParam, relevantSeries, 'y');
+      // Calculate domain and range
+      const dataDomain = getAxisDomain(axisParam, relevantSeries, 'y');
       const range = getAxisRange(axisParam, chartRect, 'y');
-      axes.set(axisId, {
+      const axisConfig = {
         scaleType: axisParam.scaleType,
-        domain,
+        domain: dataDomain,
         range,
         data: axisParam.data,
         categoryPadding: axisParam.categoryPadding,
         domainLimit: (_axisParam$domainLimi = axisParam.domainLimit) != null ? _axisParam$domainLimi : 'nice'
-      });
-    });
-    return axes;
-  }, [yAxisConfig, series, chartRect]);
-  const xScale = useMemo(() => {
-    if (!chartRect || chartRect.width <= 0 || chartRect.height <= 0 || xAxis === undefined) return undefined;
-    return getAxisScale({
-      config: xAxis,
-      type: 'x',
-      range: xAxis.range,
-      dataDomain: xAxis.domain
-    });
-  }, [chartRect, xAxis]);
-  const yScales = useMemo(() => {
-    const scales = new Map();
-    if (!chartRect || chartRect.width <= 0 || chartRect.height <= 0) return scales;
-    yAxes.forEach((axisConfig, axisId) => {
+      };
+
+      // Create the scale
       const scale = getAxisScale({
         config: axisConfig,
         type: 'y',
@@ -125,17 +176,42 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
       });
       if (scale) {
         scales.set(axisId, scale);
+
+        // Update axis config with actual scale domain (after .nice() or other adjustments)
+        const scaleDomain = scale.domain();
+        const actualDomain = Array.isArray(scaleDomain) && scaleDomain.length === 2 ? {
+          min: scaleDomain[0],
+          max: scaleDomain[1]
+        } : axisConfig.domain;
+        axes.set(axisId, _extends({}, axisConfig, {
+          domain: actualDomain
+        }));
       }
     });
-    return scales;
-  }, [chartRect, yAxes]);
+    return {
+      yAxes: axes,
+      yScales: scales
+    };
+  }, [yAxisConfig, series, chartRect]);
+
+  // We need a set of serialized scales usable in UI thread
+  const ySerializableScales = useMemo(() => {
+    const serializableScales = new Map();
+    yScales.forEach((scale, id) => {
+      const serializableScale = convertToSerializableScale(scale);
+      if (serializableScale) {
+        serializableScales.set(id, serializableScale);
+      }
+    });
+    return serializableScales;
+  }, [yScales]);
   const getXAxis = useCallback(() => xAxis, [xAxis]);
   const getYAxis = useCallback(id => yAxes.get(id != null ? id : defaultAxisId), [yAxes]);
   const getXScale = useCallback(() => xScale, [xScale]);
   const getYScale = useCallback(id => yScales.get(id != null ? id : defaultAxisId), [yScales]);
+  const getXSerializableScale = useCallback(() => xSerializableScale, [xSerializableScale]);
+  const getYSerializableScale = useCallback(id => ySerializableScales.get(id != null ? id : defaultAxisId), [ySerializableScales]);
   const getSeries = useCallback(seriesId => series == null ? void 0 : series.find(s => s.id === seriesId), [series]);
-
-  // Compute stacked data for series with stack properties
   const stackedDataMap = useMemo(() => {
     if (!series) return new Map();
     return calculateStackedSeriesData(series);
@@ -144,6 +220,20 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
     if (!seriesId) return undefined;
     return stackedDataMap.get(seriesId);
   }, [stackedDataMap]);
+  const dataLength = useMemo(() => {
+    // If xAxis has categorical data, use that length
+    if (xAxisConfig.data && xAxisConfig.data.length > 0) {
+      return xAxisConfig.data.length;
+    }
+
+    // Otherwise, find the longest series
+    if (!series || series.length === 0) return 0;
+    return series.reduce((max, s) => {
+      var _seriesData$length;
+      const seriesData = getStackedSeriesData(s.id);
+      return Math.max(max, (_seriesData$length = seriesData == null ? void 0 : seriesData.length) != null ? _seriesData$length : 0);
+    }, 0);
+  }, [xAxisConfig.data, series, getStackedSeriesData]);
   const getAxisBounds = useCallback(axisId => {
     const axis = renderedAxes.get(axisId);
     if (!axis || !chartRect) return;
@@ -155,7 +245,7 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
     const offsetFromPreviousAxes = axesAtPosition.slice(0, axisIndex).reduce((sum, a) => sum + a.size, 0);
     if (axis.position === 'top') {
       // Position above the chart rect, accounting for user inset
-      const startY = userInset.top + offsetFromPreviousAxes;
+      const startY = calculatedInset.top + offsetFromPreviousAxes;
       return {
         x: chartRect.x,
         y: startY,
@@ -173,7 +263,7 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
       };
     } else if (axis.position === 'left') {
       // Position to the left of the chart rect, accounting for user inset
-      const startX = userInset.left + offsetFromPreviousAxes;
+      const startX = calculatedInset.left + offsetFromPreviousAxes;
       return {
         x: startX,
         y: chartRect.y,
@@ -190,7 +280,11 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
         height: chartRect.height
       };
     }
-  }, [renderedAxes, chartRect, userInset]);
+  }, [renderedAxes, chartRect, calculatedInset]);
+  const fontProvider = useMemo(() => {
+    if (fontProviderProp) return fontProviderProp;
+    return Skia.TypefaceFontProvider.Make();
+  }, [fontProviderProp]);
   const contextValue = useMemo(() => ({
     series: series != null ? series : [],
     getSeries,
@@ -198,25 +292,23 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
     animate,
     width: chartWidth,
     height: chartHeight,
+    fontFamilies,
+    fontProvider,
     getXAxis,
     getYAxis,
     getXScale,
     getYScale,
+    getXSerializableScale,
+    getYSerializableScale,
     drawingArea: chartRect,
+    dataLength,
     registerAxis,
     unregisterAxis,
     getAxisBounds
-  }), [series, getSeries, getStackedSeriesData, animate, chartWidth, chartHeight, getXAxis, getYAxis, getXScale, getYScale, chartRect, registerAxis, unregisterAxis, getAxisBounds]);
-  const containerStyles = useMemo(() => {
-    const dynamicStyles = {};
-    if (typeof width === 'string') {
-      dynamicStyles.width = width;
-    }
-    if (typeof height === 'string') {
-      dynamicStyles.height = height;
-    }
-    return [style, dynamicStyles];
-  }, [style, width, height]);
+  }), [series, getSeries, getStackedSeriesData, animate, chartWidth, chartHeight, fontFamilies, fontProvider, getXAxis, getYAxis, getXScale, getYScale, getXSerializableScale, getYSerializableScale, chartRect, dataLength, registerAxis, unregisterAxis, getAxisBounds]);
+  const rootStyles = useMemo(() => {
+    return [style, styles == null ? void 0 : styles.root];
+  }, [style, styles == null ? void 0 : styles.root]);
   return /*#__PURE__*/_jsx(CartesianChartProvider, {
     value: contextValue,
     children: /*#__PURE__*/_jsx(ScrubberProvider, {
@@ -227,12 +319,14 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, r
         ref: ref,
         accessibilityLiveRegion: "polite",
         accessibilityRole: "image",
+        collapsable: collapsable,
+        height: height,
         onLayout: onContainerLayout,
-        style: containerStyles
+        style: rootStyles,
+        width: width
       }, props, {
-        children: /*#__PURE__*/_jsx(Svg, {
-          height: chartHeight,
-          width: chartWidth,
+        children: /*#__PURE__*/_jsx(ChartCanvas, {
+          style: styles == null ? void 0 : styles.chart,
           children: children
         })
       }))

package/esm/chart/ChartContextBridge.js

@@ -0,0 +1,148 @@
+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); }
+/**
+ * Simplified context bridge utilities for React Native.
+ * Adapted from its-fine to enable context sharing across React renderers
+ * https://github.com/pmndrs/its-fine/blob/598b81f02778c22ed21121c2b1a786bdefb14e23/src/index.tsx
+ */
+
+import * as React from 'react';
+
+/**
+ * Represents a react-internal tree node.
+ */
+
+/**
+ * Represents a tree node selector for traversal.
+ */
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * Traverses up or down a React tree, return `true` to stop and select a node.
+ */
+function traverseTreeNode(node, ascending, selector) {
+  if (!node) return;
+  if (selector(node) === true) return node;
+  let child = ascending ? node.return : node.child;
+  while (child) {
+    const match = traverseTreeNode(child, ascending, selector);
+    if (match) return match;
+    child = ascending ? null : child.sibling;
+  }
+}
+
+/**
+ * Wraps context to hide React development warnings about using contexts between renderers.
+ */
+function wrapContext(context) {
+  try {
+    return Object.defineProperties(context, {
+      _currentRenderer: {
+        get() {
+          return null;
+        },
+        set() {}
+      },
+      _currentRenderer2: {
+        get() {
+          return null;
+        },
+        set() {}
+      }
+    });
+  } catch (_) {
+    return context;
+  }
+}
+
+// In development, React will warn about using contexts between renderers.
+// Suppress the warning because our context bridge fixes this issue
+const error = console.error;
+console.error = function () {
+  for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+    args[_key] = arguments[_key];
+  }
+  const message = args.join('');
+  if (message != null && message.startsWith('Warning:') && message.includes('useContext')) {
+    console.error = error;
+    return;
+  }
+  return error.apply(this, args);
+};
+const TreeNodeContext = wrapContext(/*#__PURE__*/React.createContext(null));
+
+/**
+ * A react-internal tree node provider that binds React children to the React tree for chart context bridging.
+ */
+export class ChartBridgeProvider extends React.Component {
+  render() {
+    return /*#__PURE__*/_jsx(TreeNodeContext.Provider, {
+      value: this._reactInternals,
+      children: this.props.children
+    });
+  }
+}
+
+/**
+ * Returns the current react-internal tree node.
+ */
+function useTreeNode() {
+  const root = React.useContext(TreeNodeContext);
+  if (root === null) throw new Error('useTreeNode must be called within a <ChartBridgeProvider />!');
+  const id = React.useId();
+  const treeNode = React.useMemo(() => {
+    for (const maybeNode of [root, root == null ? void 0 : root.alternate]) {
+      if (!maybeNode) continue;
+      const node = traverseTreeNode(maybeNode, false, node => {
+        let state = node.memoizedState;
+        while (state) {
+          if (state.memoizedState === id) return true;
+          state = state.next;
+        }
+      });
+      if (node) return node;
+    }
+  }, [root, id]);
+  return treeNode;
+}
+/**
+ * Returns a map of all contexts and their values.
+ */
+function useContextMap() {
+  const treeNode = useTreeNode();
+  const [contextMap] = React.useState(() => new Map());
+
+  // Collect live context
+  contextMap.clear();
+  let node = treeNode;
+  while (node) {
+    if (node.type && typeof node.type === 'object') {
+      // https://github.com/facebook/react/pull/28226
+      const enableRenderableContext = node.type._context === undefined && node.type.Provider === node.type;
+      const context = enableRenderableContext ? node.type : node.type._context;
+      if (context && context !== TreeNodeContext && !contextMap.has(context)) {
+        // eslint-disable-next-line react-hooks/rules-of-hooks
+        contextMap.set(context, React.useContext(wrapContext(context)));
+      }
+    }
+    node = node.return;
+  }
+  return contextMap;
+}
+
+/**
+ * Represents a chart context bridge provider component.
+ */
+
+/**
+ * Returns a ChartContextBridge of live context providers to pierce Context across renderers.
+ * Pass ChartContextBridge as a component to a secondary renderer (e.g., Skia Canvas) to enable context-sharing in charts.
+ */
+export function useChartContextBridge() {
+  const contextMap = useContextMap();
+
+  // Flatten context and their memoized values into a `ChartContextBridge` provider
+  return React.useMemo(() => Array.from(contextMap.keys()).reduce((Prev, context) => props => /*#__PURE__*/_jsx(Prev, {
+    children: /*#__PURE__*/_jsx(context.Provider, _extends({}, props, {
+      value: contextMap.get(context)
+    }))
+  }), props => /*#__PURE__*/_jsx(ChartBridgeProvider, _extends({}, props))), [contextMap]);
+}