@coinbase/cds-mobile-visualization 3.4.0-beta.12 → 3.4.0-beta.14

package/esm/chart/CartesianChart.js

@@ -1,4 +1,4 @@
-const _excluded = ["series", "children", "animate", "enableScrubbing", "xAxis", "yAxis", "inset", "onScrubberPositionChange", "width", "height", "style", "styles", "allowOverflowGestures", "fontFamilies", "fontProvider", "collapsable"];
+const _excluded = ["series", "children", "animate", "enableScrubbing", "xAxis", "yAxis", "inset", "onScrubberPositionChange", "legend", "legendPosition", "legendAccessibilityLabel", "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';
@@ -9,8 +9,9 @@ import { ScrubberProvider } from './scrubber/ScrubberProvider';
 import { convertToSerializableScale } from './utils/scale';
 import { useChartContextBridge } from './ChartContextBridge';
 import { CartesianChartProvider } from './ChartProvider';
+import { Legend } from './legend';
 import { defaultAxisId, defaultChartInset, getAxisConfig, getAxisDomain, getAxisRange, getAxisScale, getChartInset, getStackedSeriesData as calculateStackedSeriesData, useTotalAxisPadding } from './utils';
-import { jsx as _jsx } from "react/jsx-runtime";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const ChartCanvas = /*#__PURE__*/memo(_ref => {
   let {
     children,
@@ -37,6 +38,9 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref2,
       yAxis: yAxisConfigProp,
       inset,
       onScrubberPositionChange,
+      legend,
+      legendPosition = 'bottom',
+      legendAccessibilityLabel,
       width = '100%',
       height = '100%',
       style,
@@ -309,22 +313,48 @@ export const CartesianChart = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref2,
   const rootStyles = useMemo(() => {
     return [style, styles == null ? void 0 : styles.root];
   }, [style, styles == null ? void 0 : styles.root]);
+  const legendElement = useMemo(() => {
+    if (!legend) return;
+    if (legend === true) {
+      const isHorizontal = legendPosition === 'top' || legendPosition === 'bottom';
+      const flexDirection = isHorizontal ? 'row' : 'column';
+      return /*#__PURE__*/_jsx(Legend, {
+        accessibilityLabel: legendAccessibilityLabel,
+        flexDirection: flexDirection
+      });
+    }
+    return legend;
+  }, [legend, legendAccessibilityLabel, legendPosition]);
+  const rootBoxProps = useMemo(() => _extends({
+    ref,
+    accessibilityLiveRegion: 'polite',
+    accessibilityRole: 'image',
+    height,
+    style: rootStyles,
+    width
+  }, props), [ref, height, rootStyles, width, props]);
   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",
+      children: legend ? /*#__PURE__*/_jsxs(Box, _extends({}, rootBoxProps, {
+        flexDirection: legendPosition === 'top' || legendPosition === 'bottom' ? 'column' : 'row',
+        children: [(legendPosition === 'top' || legendPosition === 'left') && legendElement, /*#__PURE__*/_jsx(Box, {
+          collapsable: collapsable,
+          onLayout: onContainerLayout,
+          style: {
+            flex: 1
+          },
+          children: /*#__PURE__*/_jsx(ChartCanvas, {
+            style: styles == null ? void 0 : styles.chart,
+            children: children
+          })
+        }), (legendPosition === 'bottom' || legendPosition === 'right') && legendElement]
+      })) : /*#__PURE__*/_jsx(Box, _extends({}, rootBoxProps, {
         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/__stories__/CartesianChart.stories.js

@@ -155,7 +155,7 @@ const EarningsHistory = () => {
       backgroundColor: theme.color.bgPositive
     }
   });
-  const LegendItem = /*#__PURE__*/memo(_ref2 => {
+  const LegendEntry = /*#__PURE__*/memo(_ref2 => {
     let {
       opacity = 1,
       label
@@ -217,10 +217,10 @@ const EarningsHistory = () => {
     }), /*#__PURE__*/_jsxs(HStack, {
       gap: 2,
       justifyContent: "flex-end",
-      children: [/*#__PURE__*/_jsx(LegendItem, {
+      children: [/*#__PURE__*/_jsx(LegendEntry, {
         label: "Estimated EPS",
         opacity: 0.5
-      }), /*#__PURE__*/_jsx(LegendItem, {
+      }), /*#__PURE__*/_jsx(LegendEntry, {
         label: "Actual EPS"
       })]
     })]

package/esm/chart/bar/Bar.js

@@ -24,6 +24,7 @@ export const Bar = /*#__PURE__*/memo(_ref => {
     originY,
     dataX,
     dataY,
+    seriesId,
     BarComponent = DefaultBar,
     fill,
     fillOpacity = 1,
@@ -59,6 +60,7 @@ export const Bar = /*#__PURE__*/memo(_ref => {
     originY: effectiveOriginY,
     roundBottom: roundBottom,
     roundTop: roundTop,
+    seriesId: seriesId,
     stroke: stroke,
     strokeWidth: strokeWidth,
     transition: transition,

package/esm/chart/bar/BarStack.js

@@ -8,6 +8,11 @@ import { Bar } from './Bar';
 import { DefaultBarStack } from './DefaultBarStack';
 import { jsx as _jsx } from "react/jsx-runtime";
 const EPSILON = 1e-4;
+
+/**
+ * Extended series type that includes bar-specific properties.
+ */
+
 /**
  * BarStack component that renders a single stack of bars at a specific category index.
  * Handles the stacking logic for bars within a single category.
@@ -153,6 +158,7 @@ export const BarStack = /*#__PURE__*/memo(_ref => {
         // Check if the bar should be rounded based on the baseline, with an epsilon to handle floating-point rounding
         roundTop: roundBaseline || Math.abs(barTop - baseline) >= EPSILON,
         roundBottom: roundBaseline || Math.abs(barBottom - baseline) >= EPSILON,
+        BarComponent: s.BarComponent,
         shouldApplyGap
       });
     });
@@ -514,7 +520,7 @@ export const BarStack = /*#__PURE__*/memo(_ref => {
   const xData = xAxis != null && xAxis.data && Array.isArray(xAxis.data) && typeof xAxis.data[0] === 'number' ? xAxis.data : undefined;
   const dataX = xData ? xData[categoryIndex] : categoryIndex;
   const barElements = bars.map((bar, index) => /*#__PURE__*/_jsx(Bar, {
-    BarComponent: defaultBarComponent,
+    BarComponent: bar.BarComponent || defaultBarComponent,
     borderRadius: borderRadius,
     dataX: dataX,
     dataY: bar.dataY,
@@ -524,6 +530,7 @@ export const BarStack = /*#__PURE__*/memo(_ref => {
     originY: baseline,
     roundBottom: bar.roundBottom,
     roundTop: bar.roundTop,
+    seriesId: bar.seriesId,
     stroke: defaultStroke,
     strokeWidth: defaultStrokeWidth,
     transition: transition,

package/esm/chart/index.js

@@ -6,6 +6,7 @@ export * from './CartesianChart';
 export * from './ChartContextBridge';
 export * from './ChartProvider';
 export * from './gradient';
+export * from './legend';
 export * from './line';
 export * from './Path';
 export * from './PeriodSelector';

package/esm/chart/legend/DefaultLegendEntry.js

@@ -0,0 +1,42 @@
+const _excluded = ["label", "color", "shape", "ShapeComponent", "gap", "style", "styles", "testID"];
+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 } from 'react';
+import { StyleSheet } from 'react-native';
+import { HStack } from '@coinbase/cds-mobile/layout';
+import { Text } from '@coinbase/cds-mobile/typography/Text';
+import { DefaultLegendShape } from './DefaultLegendShape';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const styles = StyleSheet.create({
+  legendEntry: {
+    alignItems: 'center'
+  }
+});
+export const DefaultLegendEntry = /*#__PURE__*/memo(_ref => {
+  let {
+      label,
+      color,
+      shape,
+      ShapeComponent = DefaultLegendShape,
+      gap = 1,
+      style,
+      styles: stylesProp,
+      testID
+    } = _ref,
+    props = _objectWithoutPropertiesLoose(_ref, _excluded);
+  return /*#__PURE__*/_jsxs(HStack, _extends({
+    gap: gap,
+    style: [styles.legendEntry, style, stylesProp == null ? void 0 : stylesProp.root],
+    testID: testID
+  }, props, {
+    children: [/*#__PURE__*/_jsx(ShapeComponent, {
+      color: color,
+      shape: shape,
+      style: stylesProp == null ? void 0 : stylesProp.shape
+    }), typeof label === 'string' ? /*#__PURE__*/_jsx(Text, {
+      font: "label1",
+      style: stylesProp == null ? void 0 : stylesProp.label,
+      children: label
+    }) : label]
+  }));
+});

package/esm/chart/legend/DefaultLegendShape.js

@@ -0,0 +1,64 @@
+const _excluded = ["color", "shape", "style", "testID"];
+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 } from 'react';
+import { StyleSheet, View } from 'react-native';
+import { useTheme } from '@coinbase/cds-mobile';
+import { Box } from '@coinbase/cds-mobile/layout';
+import { jsx as _jsx } from "react/jsx-runtime";
+const styles = StyleSheet.create({
+  container: {
+    width: 10,
+    height: 24,
+    alignItems: 'center',
+    justifyContent: 'center'
+  },
+  pill: {
+    width: 6,
+    height: 24,
+    borderRadius: 3
+  },
+  circle: {
+    width: 10,
+    height: 10,
+    borderRadius: 5
+  },
+  square: {
+    width: 10,
+    height: 10
+  },
+  squircle: {
+    width: 10,
+    height: 10,
+    borderRadius: 2
+  }
+});
+const stylesByVariant = {
+  pill: styles.pill,
+  circle: styles.circle,
+  square: styles.square,
+  squircle: styles.squircle
+};
+const isVariantShape = shape => typeof shape === 'string' && shape in stylesByVariant;
+export const DefaultLegendShape = /*#__PURE__*/memo(_ref => {
+  let {
+      color,
+      shape = 'circle',
+      style,
+      testID
+    } = _ref,
+    props = _objectWithoutPropertiesLoose(_ref, _excluded);
+  const theme = useTheme();
+  if (!isVariantShape(shape)) return shape;
+  const variantStyle = stylesByVariant[shape];
+  return /*#__PURE__*/_jsx(Box, _extends({
+    style: [styles.container, style],
+    testID: testID
+  }, props, {
+    children: /*#__PURE__*/_jsx(View, {
+      style: [variantStyle, {
+        backgroundColor: color != null ? color : theme.color.fgPrimary
+      }]
+    })
+  }));
+});

package/esm/chart/legend/Legend.js

@@ -0,0 +1,59 @@
+const _excluded = ["flexDirection", "justifyContent", "alignItems", "flexWrap", "rowGap", "columnGap", "seriesIds", "EntryComponent", "ShapeComponent", "accessibilityLabel", "style", "styles"];
+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 { forwardRef, memo, useMemo } from 'react';
+import { Box } from '@coinbase/cds-mobile/layout';
+import { useCartesianChartContext } from '../ChartProvider';
+import { DefaultLegendEntry } from './DefaultLegendEntry';
+import { DefaultLegendShape } from './DefaultLegendShape';
+import { jsx as _jsx } from "react/jsx-runtime";
+export const Legend = /*#__PURE__*/memo(/*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+      flexDirection = 'row',
+      justifyContent = 'center',
+      alignItems = flexDirection === 'row' ? 'center' : 'flex-start',
+      flexWrap = 'wrap',
+      rowGap = 0.75,
+      columnGap = 2,
+      seriesIds,
+      EntryComponent = DefaultLegendEntry,
+      ShapeComponent = DefaultLegendShape,
+      accessibilityLabel = 'Legend',
+      style,
+      styles
+    } = _ref,
+    props = _objectWithoutPropertiesLoose(_ref, _excluded);
+  const {
+    series
+  } = useCartesianChartContext();
+  const filteredSeries = useMemo(() => {
+    if (seriesIds === undefined) return series.filter(s => s.label !== undefined);
+    return series.filter(s => seriesIds.includes(s.id) && s.label !== undefined);
+  }, [series, seriesIds]);
+  if (filteredSeries.length === 0) return;
+  return /*#__PURE__*/_jsx(Box, _extends({
+    ref: ref,
+    accessibilityLabel: accessibilityLabel,
+    accessibilityRole: "summary",
+    alignItems: alignItems,
+    columnGap: columnGap,
+    flexDirection: flexDirection,
+    flexWrap: flexWrap,
+    justifyContent: justifyContent,
+    rowGap: rowGap,
+    style: [style, styles == null ? void 0 : styles.root]
+  }, props, {
+    children: filteredSeries.map(s => /*#__PURE__*/_jsx(EntryComponent, {
+      ShapeComponent: ShapeComponent,
+      color: s.color,
+      label: s.label,
+      seriesId: s.id,
+      shape: s.legendShape,
+      styles: {
+        root: styles == null ? void 0 : styles.entry,
+        shape: styles == null ? void 0 : styles.entryShape,
+        label: styles == null ? void 0 : styles.entryLabel
+      }
+    }, s.id))
+  }));
+}));