@coinbase/cds-mobile-visualization 3.3.0 → 3.4.0-beta.10

package/esm/chart/CartesianChart.js

@@ -0,0 +1,335 @@
+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 { 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";
+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: xAxisConfigProp,
+      yAxis: yAxisConfigProp,
+      inset,
+      onScrubberPositionChange,
+      width = '100%',
+      height = '100%',
+      style,
+      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 = 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', xAxisConfigProp)[0], [xAxisConfigProp]);
+  const yAxisConfig = useMemo(() => getAxisConfig('y', yAxisConfigProp), [yAxisConfigProp]);
+  const {
+    renderedAxes,
+    registerAxis,
+    unregisterAxis,
+    axisPadding
+  } = useTotalAxisPadding();
+  const totalInset = useMemo(() => ({
+    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,
+      y: 0,
+      width: 0,
+      height: 0
+    };
+    const availableWidth = chartWidth - totalInset.left - totalInset.right;
+    const availableHeight = chartHeight - totalInset.top - totalInset.bottom;
+    return {
+      x: totalInset.left,
+      y: totalInset.top,
+      width: availableWidth > 0 ? availableWidth : 0,
+      height: availableHeight > 0 ? availableHeight : 0
+    };
+  }, [chartHeight, chartWidth, totalInset]);
+  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 = {
+      scaleType: xAxisConfig.scaleType,
+      domain,
+      range,
+      data: xAxisConfig.data,
+      categoryPadding: xAxisConfig.categoryPadding,
+      domainLimit: xAxisConfig.domainLimit
+    };
+
+    // 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 xSerializableScale = useMemo(() => {
+    if (!xScale) return;
+    return convertToSerializableScale(xScale);
+  }, [xScale]);
+  const {
+    yAxes,
+    yScales
+  } = useMemo(() => {
+    const axes = new Map();
+    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;
+
+      // Get relevant series data
+      const relevantSeries = (_series$filter = series == null ? void 0 : series.filter(s => {
+        var _s$yAxisId;
+        return ((_s$yAxisId = s.yAxisId) != null ? _s$yAxisId : defaultAxisId) === axisId;
+      })) != null ? _series$filter : [];
+
+      // Calculate domain and range
+      const dataDomain = getAxisDomain(axisParam, relevantSeries, 'y');
+      const range = getAxisRange(axisParam, chartRect, 'y');
+      const axisConfig = {
+        scaleType: axisParam.scaleType,
+        domain: dataDomain,
+        range,
+        data: axisParam.data,
+        categoryPadding: axisParam.categoryPadding,
+        domainLimit: (_axisParam$domainLimi = axisParam.domainLimit) != null ? _axisParam$domainLimi : 'nice'
+      };
+
+      // Create the scale
+      const scale = getAxisScale({
+        config: axisConfig,
+        type: 'y',
+        range: axisConfig.range,
+        dataDomain: axisConfig.domain
+      });
+      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 {
+      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]);
+  const stackedDataMap = useMemo(() => {
+    if (!series) return new Map();
+    return calculateStackedSeriesData(series);
+  }, [series]);
+  const getStackedSeriesData = useCallback(seriesId => {
+    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;
+    const axesAtPosition = Array.from(renderedAxes.values()).filter(a => a.position === axis.position).sort((a, b) => a.id.localeCompare(b.id));
+    const axisIndex = axesAtPosition.findIndex(a => a.id === axisId);
+    if (axisIndex === -1) return;
+
+    // Calculate offset from previous axes at the same position
+    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 = calculatedInset.top + offsetFromPreviousAxes;
+      return {
+        x: chartRect.x,
+        y: startY,
+        width: chartRect.width,
+        height: axis.size
+      };
+    } else if (axis.position === 'bottom') {
+      // Position below the chart rect, accounting for user inset
+      const startY = chartRect.y + chartRect.height + offsetFromPreviousAxes;
+      return {
+        x: chartRect.x,
+        y: startY,
+        width: chartRect.width,
+        height: axis.size
+      };
+    } else if (axis.position === 'left') {
+      // Position to the left of the chart rect, accounting for user inset
+      const startX = calculatedInset.left + offsetFromPreviousAxes;
+      return {
+        x: startX,
+        y: chartRect.y,
+        width: axis.size,
+        height: chartRect.height
+      };
+    } else {
+      // right - position to the right of the chart rect, accounting for user inset
+      const startX = chartRect.x + chartRect.width + offsetFromPreviousAxes;
+      return {
+        x: startX,
+        y: chartRect.y,
+        width: axis.size,
+        height: chartRect.height
+      };
+    }
+  }, [renderedAxes, chartRect, calculatedInset]);
+  const fontProvider = useMemo(() => {
+    if (fontProviderProp) return fontProviderProp;
+    return Skia.TypefaceFontProvider.Make();
+  }, [fontProviderProp]);
+  const contextValue = useMemo(() => ({
+    series: series != null ? series : [],
+    getSeries,
+    getSeriesData: getStackedSeriesData,
+    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, 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, {
+      allowOverflowGestures: allowOverflowGestures,
+      enableScrubbing: enableScrubbing,
+      onScrubberPositionChange: onScrubberPositionChange,
+      children: /*#__PURE__*/_jsx(Box, _extends({
+        ref: ref,
+        accessibilityLiveRegion: "polite",
+        accessibilityRole: "image",
+        collapsable: collapsable,
+        height: height,
+        onLayout: onContainerLayout,
+        style: rootStyles,
+        width: width
+      }, props, {
+        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]);
+}

package/esm/chart/ChartProvider.js

@@ -0,0 +1,10 @@
+import { createContext, useContext } from 'react';
+const CartesianChartContext = /*#__PURE__*/createContext(undefined);
+export const useCartesianChartContext = () => {
+  const context = useContext(CartesianChartContext);
+  if (!context) {
+    throw new Error('useCartesianChartContext must be used within a CartesianChart component. See http://cds.coinbase.com/components/graphs/CartesianChart.');
+  }
+  return context;
+};
+export const CartesianChartProvider = CartesianChartContext.Provider;