fix(chartcards): update axes proptypes to oneOf top

carbon-design-system · Aug 3, 2020 · fe0ea97 · fe0ea97
1 parent c99807a
commit fe0ea97
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/src/components/TimeSeriesCard/TimeSeriesCard.jsx b/src/components/TimeSeriesCard/TimeSeriesCard.jsx
@@ -76,7 +76,8 @@ const TimeSeriesCardPropTypes = {
     /** Optionally addes a zoom bar to the chart */
     zoomBar: PropTypes.shape({
       /** Determines which axis to put the zoomBar */
-      axes: PropTypes.string,
+      axes: PropTypes.oneOf(['top']), // top is the only axes supported right now
+      // axes: PropTypes.oneOf(['top', 'bottom', 'left', 'right']), // TODO: When the other axes are supported, swap to this proptype
       /** Determines whether the zoomBar is enabled */
       enabled: PropTypes.bool,
       /** Optional domain to zoom to by default. Can be a timestamp or date string */

diff --git a/src/constants/CardPropTypes.js b/src/constants/CardPropTypes.js
@@ -266,7 +266,8 @@ export const BarChartCardPropTypes = {
     /** Optionally addes a zoom bar to the chart */
     zoomBar: PropTypes.shape({
       /** Determines which axis to put the zoomBar */
-      axes: PropTypes.string,
+      axes: PropTypes.oneOf(['top']), // top is the only axes supported right now
+      // axes: PropTypes.oneOf(['top', 'bottom', 'left', 'right']), // TODO: When the other axes are supported, swap to this proptype
       /** Determines whether the zoomBar is enabled */
       enabled: PropTypes.bool,
       /** Optional domain to zoom to by default. Can be a timestamp or date string */

diff --git a/src/utils/__tests__/__snapshots__/publicAPI.test.js.snap b/src/utils/__tests__/__snapshots__/publicAPI.test.js.snap
@@ -4430,7 +4430,12 @@ Map {
               "args": Array [
                 Object {
                   "axes": Object {
-                    "type": "string",
+                    "args": Array [
+                      Array [
+                        "top",
+                      ],
+                    ],
+                    "type": "oneOf",
                   },
                   "enabled": Object {
                     "type": "bool",
@@ -9302,7 +9307,12 @@ Map {
               "args": Array [
                 Object {
                   "axes": Object {
-                    "type": "string",
+                    "args": Array [
+                      Array [
+                        "top",
+                      ],
+                    ],
+                    "type": "oneOf",
                   },
                   "enabled": Object {
                     "type": "bool",