@pareto-engineering/design-system 5.0.0 → 5.0.2

package/dist/es/a/{AreaChart → Charts/AreaChart}/AreaChart.js

@@ -1,13 +1,11 @@
-// front/packages/design-system/src/ui/a/AreaChart/AreaChart.jsx
-
 import * as React from 'react';
+import { useState } from 'react';
 import PropTypes from 'prop-types';
 import { AreaChart as RechartsAreaChart, Area, XAxis, YAxis, CartesianGrid, Tooltip, ResponsiveContainer } from 'recharts';
 import styleNames from '@pareto-engineering/bem/exports';
+import { formatTime, formatDate, DATE_FORMATS } from "../../../utils";
+import { CustomLegend, CustomTooltipContent, YLabelsDropDown } from "../Common";
 import "./styles.scss";
-
-// Local Definitions
-
 const baseClassName = styleNames.base;
 const componentClassName = 'area-chart';
 const AreaChart = ({
@@ -22,19 +20,16 @@ const AreaChart = ({
   colors,
   filled,
   height,
-  width
-  // ...otherProps
+  width,
+  isTimeFormat,
+  dateFormat,
+  capitalizedLegend
 }) => {
-  const processedData = data.map(item => {
-    const yValues = yKeys.map(key => item[key]);
-    const lowerBound = Math.min(...yValues);
-    const upperBound = Math.max(...yValues);
-    const margin = (upperBound - lowerBound) * 0.1;
-    return {
-      ...item,
-      bounds: [lowerBound - margin, upperBound + margin]
-    };
-  });
+  const allYLabels = yKeys.map(key => ({
+    label: key,
+    color: colors[yKeys.indexOf(key)]
+  }));
+  const [selectedYLabels, setSelectedYLabels] = useState(allYLabels);
   const yAxisBounds = () => {
     const yValues = data.map(item => yKeys.map(key => item[key]));
     const min = Math.min(...yValues.flat());
@@ -42,54 +37,24 @@ const AreaChart = ({
     const margin = (max - min) * 0.1;
     return [min - margin, max + margin];
   };
-  const CustomTooltipContent = ({
-    active,
-    payload,
-    label
-  }) => {
-    if (active && payload && payload.length) {
-      const newPayload = payload.filter(item => item.name !== 'bounds');
-      return /*#__PURE__*/React.createElement("div", {
-        className: "custom-tooltip"
-      }, /*#__PURE__*/React.createElement("p", {
-        className: "label"
-      }, `${xLabel}: ${label}`), newPayload.map(entry => /*#__PURE__*/React.createElement("p", {
-        className: "label",
-        key: `${entry.name}`,
-        style: {
-          color: entry.color
-        }
-      }, `${entry.name}: ${entry.value}`)));
-    }
-    return null;
-  };
-  const CustomLegend = ({
-    colorsArray,
-    yKeysArray
-  }) => /*#__PURE__*/React.createElement("div", {
-    className: "custom-legend"
-  }, yKeysArray.map((key, index) => /*#__PURE__*/React.createElement("div", {
-    key: key,
-    className: "item"
-  }, /*#__PURE__*/React.createElement("span", {
-    className: "line",
-    style: {
-      backgroundColor: colorsArray[index]
-    }
-  }), /*#__PURE__*/React.createElement("span", {
-    className: "text"
-  }, key))));
   return /*#__PURE__*/React.createElement("div", {
     id: id,
     className: [baseClassName, componentClassName, userClassName].filter(e => e).join(' ')
-  }, /*#__PURE__*/React.createElement("h3", null, title), /*#__PURE__*/React.createElement(CustomLegend, {
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "chart-header"
+  }, /*#__PURE__*/React.createElement("h3", null, title), /*#__PURE__*/React.createElement(YLabelsDropDown, {
+    allYLabels: allYLabels,
+    selectedYLabels: selectedYLabels,
+    setSelectedYLabels: setSelectedYLabels
+  })), /*#__PURE__*/React.createElement(CustomLegend, {
     colorsArray: colors,
-    yKeysArray: yKeys
+    yKeysArray: yKeys,
+    capitalizedLegend: capitalizedLegend
   }), /*#__PURE__*/React.createElement(ResponsiveContainer, {
     width: width,
     height: height
   }, /*#__PURE__*/React.createElement(RechartsAreaChart, {
-    data: processedData
+    data: data
   }, /*#__PURE__*/React.createElement(CartesianGrid, {
     strokeDasharray: "3 3"
   }), /*#__PURE__*/React.createElement(XAxis, {
@@ -101,7 +66,8 @@ const AreaChart = ({
     },
     axisLine: false,
     tickLine: false,
-    tickCount: 3
+    tickCount: 3,
+    tickFormatter: value => formatDate(value, dateFormat)
   }), /*#__PURE__*/React.createElement(YAxis, {
     domain: yAxisBounds,
     scale: "linear",
@@ -110,7 +76,7 @@ const AreaChart = ({
       value: yLabel,
       angle: -90,
       position: 'left',
-      offset: 1,
+      offset: -3,
       style: {
         textAnchor: 'middle'
       }
@@ -120,10 +86,18 @@ const AreaChart = ({
       bottom: 10
     },
     axisLine: false,
-    tickLine: true,
-    tickFormatter: value => value.toFixed(2)
+    tickLine: false,
+    tickFormatter: value => {
+      if (isTimeFormat) {
+        return formatTime(value);
+      }
+      return value.toFixed(2);
+    }
   }), /*#__PURE__*/React.createElement(Tooltip, {
-    content: /*#__PURE__*/React.createElement(CustomTooltipContent, null)
+    content: /*#__PURE__*/React.createElement(CustomTooltipContent, {
+      dateFormat: dateFormat,
+      isTimeFormat: isTimeFormat
+    })
   }), filled && /*#__PURE__*/React.createElement(Area, {
     id: "bounds",
     type: "linear",
@@ -135,12 +109,12 @@ const AreaChart = ({
     dot: false,
     label: false,
     isAnimationActive: false
-  }), yKeys.map((key, index) => /*#__PURE__*/React.createElement(Area, {
-    id: key,
-    key: key,
+  }), selectedYLabels.map(key => /*#__PURE__*/React.createElement(Area, {
+    id: key.label,
+    key: key.label,
     type: "linear",
-    dataKey: key,
-    stroke: colors[index],
+    dataKey: key.label,
+    stroke: key.color,
     fill: "none",
     connectNulls: true,
     dot: false,
@@ -151,21 +125,66 @@ const AreaChart = ({
   })))));
 };
 AreaChart.propTypes = {
+  /**
+   * Array of data objects to be displayed in the chart.
+   */
   // eslint-disable-next-line react/forbid-prop-types
   data: PropTypes.arrayOf(PropTypes.object).isRequired,
+  /**
+   * Title of the chart.
+   */
   title: PropTypes.string.isRequired,
+  /**
+   * Key for the x-axis data.
+   */
   xKey: PropTypes.string.isRequired,
+  /**
+   * Array of keys for the y-axis data.
+   */
   yKeys: PropTypes.arrayOf(PropTypes.string).isRequired,
+  /**
+   * Label for the x-axis.
+   */
   xLabel: PropTypes.string,
+  /**
+   * Label for the y-axis.
+   */
   yLabel: PropTypes.string,
+  /**
+   * Array of colors corresponding to the y-axis data keys.
+   */
   colors: PropTypes.arrayOf(PropTypes.string).isRequired,
+  /**
+   * Boolean to determine if the area under the curve should be filled.
+   */
   filled: PropTypes.bool,
+  /**
+   * Height of the chart.
+   */
   height: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-  width: PropTypes.oneOfType([PropTypes.string, PropTypes.number])
+  /**
+   * Width of the chart.
+   */
+  width: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  /**
+   * Flag on whether to capitalize legend keys
+   */
+  capitalizedLegend: PropTypes.bool,
+  /**
+   * Flag on whether it is a timeformat or not
+   */
+  isTimeFormat: PropTypes.bool,
+  /**
+   * The type of format for the datetime value
+   */
+  dateFormat: PropTypes.oneOf(Object.values(DATE_FORMATS))
 };
 AreaChart.defaultProps = {
   filled: false,
   width: '100%',
-  height: 300
+  height: 300,
+  capitalizedLegend: false,
+  isTimeFormat: false,
+  dateFormat: DATE_FORMATS.HUMAN_READABLE
 };
 export default AreaChart;

package/dist/es/a/Charts/AreaChart/styles.scss

@@ -0,0 +1,48 @@
+@use "@pareto-engineering/bem";
+
+$default-margin: 1rem;
+$default-padding: 1rem;
+$default-box-shadow: 0 .25rem .75rem var(--ui-lines);
+$default-text-font-size: calc(var(--s-1) * 1rem);
+
+.#{bem.$base} {
+  &.area-chart {
+    background-color: var(--background-far);
+    border-radius: var(--theme-default-border-radius);
+    box-shadow: $default-box-shadow;
+    margin: $default-margin 0;
+    padding: $default-padding;
+
+    .chart-header {
+      align-items: center;
+      display: flex;
+      justify-content: space-between;
+      margin-bottom: $default-margin;
+
+      h3 {
+        color: var(--subtitle);
+        margin: calc($default-margin / 5);
+        text-align: left;
+      }
+    }
+
+    /* stylelint-disable selector-max-compound-selectors -- nested elements */
+    .recharts-wrapper {
+      .recharts-surface {
+        .recharts-cartesian-grid line {
+          stroke: var(--ui-lines);
+        }
+
+        .recharts-text {
+          fill: var(--soft-paragraph);
+          font-size: calc($default-text-font-size * .75);
+        }
+
+        .recharts-text.recharts-label {
+          fill: var(--paragraph);
+          font-size: $default-text-font-size;
+        }
+      }
+    }
+  }
+}

package/dist/es/a/Charts/BarChart/BarChart.js

@@ -0,0 +1,128 @@
+import * as React from 'react';
+import { useState } from 'react';
+import PropTypes from 'prop-types';
+import { BarChart as RechartsBarChart, Bar, XAxis, YAxis, CartesianGrid, Tooltip, ResponsiveContainer } from 'recharts';
+import styleNames from '@pareto-engineering/bem/exports';
+import { CustomLegend, CustomTooltipContent, YLabelsDropDown } from "../Common";
+import "./styles.scss";
+
+// Local Definitions
+
+const baseClassName = styleNames.base;
+const componentClassName = 'bar-chart';
+const BarChart = ({
+  id,
+  className: userClassName,
+  data,
+  title,
+  xKey,
+  yKeys,
+  xLabel,
+  yLabel,
+  colors,
+  height,
+  width,
+  isTimeFormat,
+  capitalizedLegend
+}) => {
+  const allYLabels = yKeys.map(key => ({
+    label: key,
+    color: colors[yKeys.indexOf(key)]
+  }));
+  const [selectedYLabels, setSelectedYLabels] = useState(allYLabels);
+  return /*#__PURE__*/React.createElement("div", {
+    id: id,
+    className: [baseClassName, componentClassName, userClassName].filter(e => e).join(' ')
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "chart-header"
+  }, /*#__PURE__*/React.createElement("h3", null, title), /*#__PURE__*/React.createElement(YLabelsDropDown, {
+    allYLabels: allYLabels,
+    selectedYLabels: selectedYLabels,
+    setSelectedYLabels: setSelectedYLabels
+  })), /*#__PURE__*/React.createElement(CustomLegend, {
+    colorsArray: selectedYLabels.map(item => item.color),
+    yKeysArray: selectedYLabels.map(item => item.label),
+    capitalizedLegend: capitalizedLegend
+  }), /*#__PURE__*/React.createElement(ResponsiveContainer, {
+    width: width,
+    height: height
+  }, /*#__PURE__*/React.createElement(RechartsBarChart, {
+    data: data
+  }, /*#__PURE__*/React.createElement(CartesianGrid, {
+    vertical: false
+  }), /*#__PURE__*/React.createElement(XAxis, {
+    dataKey: xKey,
+    label: {
+      value: xLabel,
+      position: 'insideBottom',
+      offset: -5
+    } // Adjusted offset for padding
+    ,
+    axisLine: false,
+    tickLine: false,
+    tickCount: 3
+  }), /*#__PURE__*/React.createElement(YAxis, {
+    label: {
+      value: yLabel,
+      angle: -90,
+      position: 'insideLeft',
+      offset: 15
+    },
+    axisLine: false,
+    tickLine: false
+  }), /*#__PURE__*/React.createElement(Tooltip, {
+    content: /*#__PURE__*/React.createElement(CustomTooltipContent, {
+      isTimeFormat: isTimeFormat
+    })
+  }), selectedYLabels.map(key => /*#__PURE__*/React.createElement(Bar, {
+    stackId: "a",
+    id: key.label,
+    key: key.label,
+    dataKey: key.label,
+    fill: key.color
+  })))));
+};
+BarChart.propTypes = {
+  /**
+   * Array of data objects to be displayed in the chart.
+   */
+  // eslint-disable-next-line react/forbid-prop-types
+  data: PropTypes.arrayOf(PropTypes.object).isRequired,
+  /**
+   * Title of the chart.
+   */
+  title: PropTypes.string.isRequired,
+  /**
+   * Key for the x-axis data.
+   */
+  xKey: PropTypes.string.isRequired,
+  /**
+   * Array of keys for the y-axis data.
+   */
+  yKeys: PropTypes.arrayOf(PropTypes.string).isRequired,
+  /**
+   * Label for the x-axis.
+   */
+  xLabel: PropTypes.string,
+  /**
+   * Label for the y-axis.
+   */
+  yLabel: PropTypes.string,
+  /**
+   * Array of colors corresponding to the y-axis data keys.
+   */
+  colors: PropTypes.arrayOf(PropTypes.string).isRequired,
+  /**
+   * Height of the chart.
+   */
+  height: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+  /**
+   * Width of the chart.
+   */
+  width: PropTypes.oneOfType([PropTypes.string, PropTypes.number])
+};
+BarChart.defaultProps = {
+  width: '100%',
+  height: 300
+};
+export default BarChart;

package/dist/es/a/Charts/BarChart/index.js

@@ -0,0 +1 @@
+export { default as BarChart } from "./BarChart";

package/dist/es/a/Charts/BarChart/styles.scss

@@ -0,0 +1,48 @@
+@use "@pareto-engineering/bem";
+
+$default-margin: 1rem;
+$default-padding: 1rem;
+$default-box-shadow: 0 .25rem .75rem var(--ui-lines);
+$default-text-font-size: calc(var(--s-1) * 1rem);
+
+.#{bem.$base} {
+  &.bar-chart {
+    background-color: var(--background-far);
+    border-radius: var(--theme-default-border-radius);
+    box-shadow: $default-box-shadow;
+    margin: $default-margin 0;
+    padding: $default-padding;
+
+    .chart-header {
+      align-items: center;
+      display: flex;
+      justify-content: space-between;
+      margin-bottom: $default-margin;
+
+      h3 {
+        color: var(--subtitle);
+        margin: calc($default-margin / 5);
+        text-align: left;
+      }
+    }
+
+    /* stylelint-disable selector-max-compound-selectors -- nested elements */
+    .recharts-wrapper {
+      .recharts-surface {
+        .recharts-cartesian-grid line {
+          stroke: var(--ui-lines);
+        }
+
+        .recharts-text {
+          fill: var(--soft-paragraph);
+          font-size: calc($default-text-font-size * .75);
+        }
+
+        .recharts-text.recharts-label {
+          fill: var(--paragraph);
+          font-size: $default-text-font-size;
+        }
+      }
+    }
+  }
+}

package/dist/es/a/Charts/Common/CustomLegend/CustomLegend.js

@@ -0,0 +1,76 @@
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import styleNames from '@pareto-engineering/bem/exports';
+import { snakeCaseToTitleCase } from "../../../../utils";
+import "./styles.scss";
+const baseClassName = styleNames.base;
+const componentClassName = 'custom-legend';
+const CustomLegend = ({
+  id,
+  className: userClassName,
+  colorsArray,
+  yKeysArray,
+  orientation,
+  getLegendItemTitle,
+  getLegendItemSubtitle,
+  capitalizedLegend
+}) => /*#__PURE__*/React.createElement("div", {
+  id: id,
+  className: [baseClassName, componentClassName, userClassName, orientation].filter(e => e).join(' ')
+}, yKeysArray.map((key, index) => /*#__PURE__*/React.createElement("div", {
+  key: key,
+  className: "item"
+}, /*#__PURE__*/React.createElement("div", {
+  className: "title"
+}, /*#__PURE__*/React.createElement("span", {
+  className: "dot",
+  style: {
+    backgroundColor: colorsArray[index]
+  }
+}), /*#__PURE__*/React.createElement("span", {
+  className: "text"
+}, capitalizedLegend ? snakeCaseToTitleCase(getLegendItemTitle(key)) : getLegendItemTitle(key))), /*#__PURE__*/React.createElement("span", {
+  className: "sub-title"
+}, getLegendItemSubtitle(key)))));
+CustomLegend.propTypes = {
+  /**
+   * The id of the dropdown component.
+   */
+  id: PropTypes.string,
+  /**
+   * Additional class names for the dropdown component.
+   */
+  className: PropTypes.string,
+  /**
+   * Array of colors corresponding to the y-axis data keys.
+   */
+  colorsArray: PropTypes.arrayOf(PropTypes.string).isRequired,
+  /**
+   * Array of keys for the y-axis data.
+   */
+  yKeysArray: PropTypes.arrayOf(PropTypes.string).isRequired,
+  /**
+   * The orientation of the Legend
+   */
+  orientation: PropTypes.oneOf(['vertical', 'horizontal']),
+  /**
+   * The function to get the legendItemKey
+   */
+  getLegendItemTitle: PropTypes.func,
+  /**
+   * The function to get legend children
+   */
+  getLegendItemSubtitle: PropTypes.func,
+  /**
+   * Flag on whether to capitalize legend keys
+   */
+  capitalizedLegend: PropTypes.bool
+};
+CustomLegend.defaultProps = {
+  orientation: 'horizontal',
+  getLegendItemTitle: key => key,
+  /* eslint-disable no-unused-vars */
+  getLegendItemSubtitle: () => {},
+  capitalizedLegend: false
+};
+export default CustomLegend;

package/dist/es/a/Charts/Common/CustomLegend/index.js

@@ -0,0 +1 @@
+export { default as CustomLegend } from "./CustomLegend";

package/dist/es/a/Charts/Common/CustomLegend/styles.scss

@@ -0,0 +1,67 @@
+@use "@pareto-engineering/bem";
+
+$default-padding: 1rem;
+$default-margin: 1rem;
+$default-text-font-size: calc(var(--s-1) * 1rem);
+$default-border-radius: .25rem;
+$default-legend-gap: .625rem;
+$default-legend-padding: calc($default-padding * .125) calc($default-padding * .625);
+$default-legend-dot-width: .5rem;
+$default-legend-dot-height: .5rem;
+$default-legend-dot-margin-right: .3125rem;
+$default-box-shadow: 0 4px 16px 0 var(--soft-shadow);
+
+.#{bem.$base} {
+  &.custom-legend {
+    gap: $default-legend-gap;
+    justify-content: flex-end;
+    padding-bottom: $default-padding;
+    padding-right: calc($default-padding * .25);
+
+    &.vertical {
+      display: block;
+      margin-right: calc($default-margin * 2);
+      min-width: fit-content;
+
+      .item {
+        box-shadow: $default-box-shadow;
+        padding-top: $default-padding;
+      }
+    }
+
+    &.horizontal {
+      display: flex;
+    }
+
+    .item {
+      border-radius: $default-border-radius;
+      padding: $default-legend-padding;
+
+      .title {
+        align-items: center;
+        display: flex;
+
+        .dot {
+          border-radius: 50%;
+          display: inline-block;
+          height: $default-legend-dot-height;
+          margin-right: $default-legend-dot-margin-right;
+          width: $default-legend-dot-width;
+        }
+
+        .text {
+          color: var(--paragraph);
+          font-size: calc($default-text-font-size * .75);
+        }
+      }
+
+      .sub-title {
+        color: var(--heading);
+        display: flex;
+        font-size: calc($default-text-font-size * 1.2);
+        font-weight: 500;
+        justify-content: flex-end;
+      }
+    }
+  }
+}

package/dist/es/a/Charts/Common/CustomTooltipContent/CustomTooltipContent.js

@@ -0,0 +1,87 @@
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import styleNames from '@pareto-engineering/bem/exports';
+import { formatTime, formatDate, DATE_FORMATS, snakeCaseToTitleCase } from "../../../../utils";
+import "./styles.scss";
+const baseClassName = styleNames.base;
+const componentClassName = 'custom-tooltip-content';
+const CustomTooltipContent = ({
+  id,
+  className: userClassName,
+  dateFormat,
+  isTimeFormat,
+  isDateValue,
+  active,
+  payload,
+  label
+}) => {
+  const formatLabelValue = value => {
+    if (isTimeFormat) {
+      return formatTime(value);
+    }
+    if (typeof value === 'number') {
+      if (Number.isInteger(value)) return value;
+      return value.toFixed(2);
+    }
+    return value;
+  };
+  if (active && payload && payload.length) {
+    const newPayload = payload.filter(item => item.name !== 'bounds');
+    return /*#__PURE__*/React.createElement("div", {
+      id: id,
+      className: [baseClassName, componentClassName, userClassName].filter(e => e).join(' ')
+    }, /*#__PURE__*/React.createElement("p", {
+      className: "label"
+    }, isDateValue ? formatDate(label, dateFormat) : label), newPayload.map(entry => /*#__PURE__*/React.createElement("p", {
+      className: "label",
+      key: `${entry.name}`,
+      style: {
+        color: entry.color,
+        textTransform: 'capitalize'
+      }
+    }, `${snakeCaseToTitleCase(entry.name)}: ${formatLabelValue(entry.value)}`)));
+  }
+  return null;
+};
+CustomTooltipContent.propTypes = {
+  /**
+  * The id of the dropdown component.
+  */
+  id: PropTypes.string,
+  /**
+   * Additional class names for the dropdown component.
+   */
+  className: PropTypes.string,
+  /**
+   * Flag on whether it is a timeformat or not
+   */
+  isTimeFormat: PropTypes.bool,
+  /**
+   * The type of format for the datetime value
+   */
+  dateFormat: PropTypes.oneOf(Object.values(DATE_FORMATS)),
+  /**
+   * Flag on whether the label is a date value or not
+   */
+  isDateValue: PropTypes.bool,
+  /**
+   * If set true, the tooltip is displayed.
+   * If set false, the tooltip is hidden, usually calculated internally.
+   */
+  active: PropTypes.bool.isRequired,
+  /**
+   * The source data of the content to be displayed in the tooltip,
+   * always calculated internally and cannot be user set.
+   */
+  payload: PropTypes.arrayOf(PropTypes.string).isRequired,
+  /**
+   *The label value which is active now, usually calculated internally.
+   */
+  label: PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired
+};
+CustomTooltipContent.defaultProps = {
+  isTimeFormat: false,
+  isDateValue: true,
+  dateFormat: DATE_FORMATS.HUMAN_READABLE
+};
+export default CustomTooltipContent;

package/dist/es/a/Charts/Common/CustomTooltipContent/index.js

@@ -0,0 +1 @@
+export { default as CustomTooltipContent } from "./CustomTooltipContent";