@centreon/ui 24.4.73 → 24.4.74

package/src/Graph/BarStack/BarStack.stories.tsx

@@ -0,0 +1,125 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+import ResponsiveBarStack from './BarStack';
+import { BarType } from './models';
+
+import { BarStack } from '.';
+
+const data = [
+  { color: '#88B922', label: 'Ok', value: 148 },
+  { color: '#999999', label: 'Unknown', value: 63 },
+  { color: '#F7931A', label: 'Warning', value: 16 },
+  { color: '#FF6666', label: 'Down', value: 13 }
+];
+
+const dataWithBigNumbers = [
+  { color: '#88B922', label: 'Ok', value: 260000 },
+  { color: '#999999', label: 'Unknown', value: 1010900 },
+  { color: '#F7931A', label: 'Warning', value: 63114 },
+  { color: '#FF6666', label: 'Down', value: 122222 }
+];
+
+const dataWithSmallNumber = [
+  { color: '#88B922', label: 'Ok', value: 148 },
+  { color: '#999999', label: 'Unknown', value: 42 },
+  { color: '#F7931A', label: 'Warning', value: 7 },
+  { color: '#FF6666', label: 'Down', value: 5 }
+];
+
+const meta: Meta<typeof BarStack> = {
+  component: BarStack
+};
+
+export default meta;
+type Story = StoryObj<typeof BarStack>;
+
+const TooltipContent = ({ label, color, value }: BarType): JSX.Element => {
+  return (
+    <div style={{ color }}>
+      {label} : {value}
+    </div>
+  );
+};
+
+const Template = (args): JSX.Element => {
+  return (
+    <div style={{ height: '400px', width: '400px' }}>
+      <ResponsiveBarStack {...args} />
+    </div>
+  );
+};
+
+export const Vertical: Story = {
+  args: { data, title: 'hosts' },
+  render: Template
+};
+
+export const WithoutTitle: Story = {
+  args: { data },
+  render: Template
+};
+
+export const WithoutLegend: Story = {
+  args: { data, displayLegend: false, title: 'hosts' },
+
+  render: Template
+};
+
+export const withDisplayedValues: Story = {
+  args: { data, displayValues: true, title: 'hosts' },
+  render: Template
+};
+
+export const WithPencentage: Story = {
+  args: { data, displayValues: true, title: 'hosts', unit: 'percentage' },
+  render: Template
+};
+
+export const WithTooltip: Story = {
+  args: { TooltipContent, data, title: 'hosts' },
+  render: Template
+};
+
+export const WithBigNumbers: Story = {
+  args: {
+    TooltipContent,
+    data: dataWithBigNumbers,
+    displayValues: true,
+    title: 'hosts'
+  },
+  render: Template
+};
+
+export const WithSmallNumbers: Story = {
+  args: {
+    TooltipContent,
+    data: dataWithSmallNumber,
+    displayValues: true,
+    title: 'hosts'
+  },
+  render: Template
+};
+
+export const Horizontal: Story = {
+  args: {
+    TooltipContent,
+    data,
+    displayValues: true,
+    legendDirection: 'row',
+    title: 'hosts',
+    variant: 'horizontal'
+  },
+  render: Template
+};
+
+export const HorizontalWithoutLegend: Story = {
+  args: {
+    TooltipContent,
+    data,
+    displayLegend: false,
+    displayValues: true,
+    title: 'hosts',
+    variant: 'horizontal'
+  },
+  render: Template
+};

package/src/Graph/BarStack/BarStack.styles.ts

@@ -0,0 +1,66 @@
+import { makeStyles } from 'tss-react/mui';
+
+import { legendMaxHeight, legendMaxWidth } from './constants';
+
+export const useStyles = makeStyles()({
+  clippedTitle: {
+    overflow: 'hidden',
+    textOverflow: 'clip'
+  },
+  container: {
+    '&[data-has-title="false"]': {
+      gridTemplateRows: 'auto'
+    },
+    '&[data-title-variant="md"]': {
+      gridTemplateRows: '36px auto',
+      overflow: 'hidden',
+      textOverflow: 'clip'
+    },
+    '&[data-title-variant="sm"]': {
+      gridTemplateRows: '20px auto'
+    },
+    '&[data-title-variant="xs"]': {
+      gridTemplateRows: '40px auto'
+    },
+    display: 'grid',
+    height: '100%'
+  }
+});
+
+export const useGraphAndLegendStyles = makeStyles()((theme) => ({
+  graphAndLegend: {
+    '&[data-display-legend="false"][data-is-vertical="false"]': {
+      gridTemplateRows: '1fr'
+    },
+    '&[data-display-legend="true"][data-is-vertical="false"]': {
+      gap: theme.spacing(0.5),
+      gridTemplateRows: `1fr ${legendMaxHeight}px`
+    },
+    '&[data-is-vertical="true"][data-display-legend="false"]': {
+      gridTemplateColumns: '1fr'
+    },
+    '&[data-is-vertical="true"][data-display-legend="true"]': {
+      gap: theme.spacing(0.5),
+      gridTemplateColumns: `1fr ${legendMaxWidth}px`
+    },
+    display: 'grid',
+    height: '100%'
+  },
+  legend: {
+    '&[data-is-vertical="false"]': {
+      overflowY: 'auto'
+    },
+    '&[data-is-vertical="true"]': {
+      alignSelf: 'center'
+    }
+  }
+}));
+
+export const useGraphStyles = makeStyles()((theme) => ({
+  tooltip: {
+    backgroundColor: theme.palette.background.paper,
+    boxShadow: theme.shadows[3],
+    color: theme.palette.text.primary,
+    padding: 0
+  }
+}));

package/src/Graph/BarStack/BarStack.tsx

@@ -0,0 +1,14 @@
+import { ParentSize } from '../..';
+
+import ResponsiveBarStack from './ResponsiveBarStack';
+import { BarStackProps } from './models';
+
+const Bar = (props: BarStackProps): JSX.Element => (
+  <ParentSize>
+    {({ width, height }) => (
+      <ResponsiveBarStack {...props} height={height} width={width} />
+    )}
+  </ParentSize>
+);
+
+export default Bar;

package/src/Graph/BarStack/Graph.tsx

@@ -0,0 +1,176 @@
+import { memo, useMemo } from 'react';
+
+import {
+  BarRounded,
+  BarStackHorizontal,
+  BarStack as BarStackVertical
+} from '@visx/shape';
+import { Text } from '@visx/text';
+import { equals, props } from 'ramda';
+
+import { Tooltip } from '../../components';
+import { getValueByUnit } from '../common/utils';
+
+import { useGraphStyles } from './BarStack.styles';
+import { BarStackProps } from './models';
+import { useGraphAndLegend } from './useGraphAndLegend';
+
+interface Props
+  extends Pick<
+    BarStackProps,
+    | 'data'
+    | 'displayValues'
+    | 'onSingleBarClick'
+    | 'unit'
+    | 'TooltipContent'
+    | 'tooltipProps'
+  > {
+  colorScale;
+  height: number;
+  isVerticalBar: boolean;
+  total: number;
+  width: number;
+}
+
+const Graph = ({
+  width,
+  height,
+  isVerticalBar,
+  colorScale,
+  data,
+  total,
+  unit,
+  displayValues,
+  onSingleBarClick,
+  tooltipProps,
+  TooltipContent
+}: Props): JSX.Element => {
+  const { classes } = useGraphStyles();
+
+  const BarStackComponent = useMemo(
+    () => (isVerticalBar ? BarStackVertical : BarStackHorizontal),
+    [isVerticalBar]
+  );
+
+  const normalizedHeight = useMemo(() => height - 10, [height]);
+
+  const { barStackData, xScale, yScale, keys } = useGraphAndLegend({
+    data,
+    height: normalizedHeight,
+    isVerticalBar,
+    total,
+    width
+  });
+
+  return (
+    <svg height={normalizedHeight} width="100%">
+      <BarStackComponent
+        color={colorScale}
+        data={[barStackData]}
+        keys={keys}
+        {...(isVerticalBar ? { x: () => undefined } : { y: () => undefined })}
+        xScale={xScale}
+        yScale={yScale}
+      >
+        {(barStacks) =>
+          barStacks.map((barStack, index) =>
+            barStack.bars.map((bar) => {
+              const isFirstBar = equals(index, 0);
+              const isLastBar = equals(index, barStacks.length - 1);
+              const fitsInBar = isVerticalBar
+                ? bar.height >= 18
+                : (equals(unit, 'number') && bar.width > 15) ||
+                  (equals(unit, 'percentage') && bar.width > 35);
+
+              const textX = bar.x + bar.width / 2;
+              const textY = bar.y + bar.height / 2;
+
+              const click = onSingleBarClick
+                ? (e: MouseEvent): void => {
+                    if (!equals(e.button, 0)) {
+                      return;
+                    }
+                    onSingleBarClick(bar);
+                  }
+                : undefined;
+
+              return (
+                <Tooltip
+                  classes={classes}
+                  followCursor={false}
+                  key={`bar-stack-${barStack.index}-${bar.index}`}
+                  label={
+                    TooltipContent && (
+                      <TooltipContent
+                        color={bar.color}
+                        label={bar.key}
+                        total={total}
+                        value={barStack.bars[0].bar.data[barStack.key]}
+                        {...tooltipProps}
+                      />
+                    )
+                  }
+                  position={isVerticalBar ? 'right' : 'bottom'}
+                >
+                  <g data-testid={bar.key} key={bar.key}>
+                    <BarRounded
+                      bottom={isVerticalBar && isFirstBar}
+                      cursor={onSingleBarClick ? 'pointer' : 'default'}
+                      fill={bar.color}
+                      height={bar.height}
+                      key={`bar-stack-${barStack.index}-${bar.index}`}
+                      left={!isVerticalBar && isFirstBar}
+                      radius={8}
+                      right={!isVerticalBar && isLastBar}
+                      top={isVerticalBar && isLastBar}
+                      width={isVerticalBar ? bar.width - 10 : bar.width}
+                      x={bar.x}
+                      y={bar.y}
+                      onMouseDown={click}
+                    />
+                    {displayValues && fitsInBar && (
+                      <Text
+                        cursor={onSingleBarClick ? 'pointer' : 'default'}
+                        data-testid="value"
+                        fill="#000"
+                        fontSize={12}
+                        fontWeight={600}
+                        textAnchor="middle"
+                        verticalAnchor="middle"
+                        x={textX}
+                        y={textY}
+                        onMouseUp={click}
+                      >
+                        {getValueByUnit({
+                          total,
+                          unit: unit || 'number',
+                          value: barStack.bars[0].bar.data[barStack.key]
+                        })}
+                      </Text>
+                    )}
+                  </g>
+                </Tooltip>
+              );
+            })
+          )
+        }
+      </BarStackComponent>
+    </svg>
+  );
+};
+
+const propsToMemoize = [
+  'width',
+  'height',
+  'isVerticalBar',
+  'colorScale',
+  'data',
+  'total',
+  'unit',
+  'displayValues',
+  'tooltipProps'
+];
+
+export default memo(Graph, (prevProps, nextProps) =>
+  equals(props(propsToMemoize, prevProps), props(propsToMemoize, nextProps))
+);

package/src/Graph/BarStack/GraphAndLegend.tsx

@@ -0,0 +1,119 @@
+import { memo, useMemo } from 'react';
+
+import { equals, props } from 'ramda';
+
+import { useGraphAndLegendStyles } from './BarStack.styles';
+import Graph from './Graph';
+import { gap, legendMaxHeight, legendMaxWidth } from './constants';
+import { BarStackProps } from './models';
+
+interface Props
+  extends Pick<
+    BarStackProps,
+    | 'data'
+    | 'displayValues'
+    | 'onSingleBarClick'
+    | 'unit'
+    | 'TooltipContent'
+    | 'tooltipProps'
+  > {
+  colorScale;
+  displayLegend: boolean;
+  height: number;
+  isVerticalBar: boolean;
+  legend: JSX.Element;
+  total: number;
+  width: number;
+}
+
+const GraphAndLegend = ({
+  isVerticalBar,
+  legend,
+  displayLegend,
+  height,
+  width,
+  colorScale,
+  total,
+  unit,
+  data,
+  displayValues,
+  onSingleBarClick,
+  tooltipProps,
+  TooltipContent
+}: Props): JSX.Element => {
+  const { classes } = useGraphAndLegendStyles();
+
+  const isSmall = useMemo(
+    () =>
+      (!isVerticalBar && Math.floor(height) <= 80) ||
+      (isVerticalBar && Math.floor(width) <= 150),
+    [isVerticalBar, height, width]
+  );
+
+  const mustDisplayLegend = useMemo(
+    () => displayLegend && !isSmall,
+    [isSmall, displayLegend]
+  );
+
+  const graphWidth = useMemo(
+    () =>
+      isVerticalBar ? width - (isSmall ? 0 : legendMaxWidth - gap) : width,
+    [width, isVerticalBar, isSmall]
+  );
+
+  const graphHeight = useMemo(
+    () =>
+      isVerticalBar ? height : height - (isSmall ? 0 : legendMaxHeight - gap),
+    [height, isVerticalBar, isSmall]
+  );
+
+  return (
+    <div
+      className={classes.graphAndLegend}
+      data-display-legend={mustDisplayLegend}
+      data-is-vertical={isVerticalBar}
+      style={{ height }}
+    >
+      <Graph
+        TooltipContent={TooltipContent}
+        colorScale={colorScale}
+        data={data}
+        displayValues={displayValues}
+        height={graphHeight}
+        isVerticalBar={isVerticalBar}
+        tooltipProps={tooltipProps}
+        total={total}
+        unit={unit}
+        width={graphWidth}
+        onSingleBarClick={onSingleBarClick}
+      />
+      {mustDisplayLegend && (
+        <div
+          className={classes.legend}
+          data-is-vertical={isVerticalBar}
+          data-testid="Legend"
+        >
+          {legend}
+        </div>
+      )}
+    </div>
+  );
+};
+
+const propsToMemoize = [
+  'width',
+  'height',
+  'isVerticalBar',
+  'colorScale',
+  'data',
+  'total',
+  'unit',
+  'displayValues',
+  'tooltipProps',
+  'displayLegend',
+  'legend'
+];
+
+export default memo(GraphAndLegend, (prevProps, nextProps) =>
+  equals(props(propsToMemoize, prevProps), props(propsToMemoize, nextProps))
+);

package/src/Graph/BarStack/ResponsiveBarStack.tsx

@@ -0,0 +1,114 @@
+import { useMemo } from 'react';
+
+import numeral from 'numeral';
+import { equals } from 'ramda';
+import { useTranslation } from 'react-i18next';
+
+import { Typography } from '@mui/material';
+
+import { Legend as LegendComponent } from '../Legend';
+import { LegendProps } from '../Legend/models';
+
+import { useStyles } from './BarStack.styles';
+import GraphAndLegend from './GraphAndLegend';
+import { gap, smallTitleHeight, titleHeight } from './constants';
+import { BarStackProps } from './models';
+import useResponsiveBarStack from './useResponsiveBarStack';
+
+const DefaultLengd = ({ scale, direction }: LegendProps): JSX.Element => (
+  <LegendComponent direction={direction} scale={scale} />
+);
+
+const BarStack = ({
+  title,
+  data,
+  height,
+  width,
+  onSingleBarClick,
+  displayLegend = true,
+  TooltipContent,
+  Legend = DefaultLengd,
+  unit = 'number',
+  displayValues,
+  variant = 'vertical',
+  legendDirection,
+  tooltipProps = {}
+}: BarStackProps & { height: number; width: number }): JSX.Element => {
+  const { classes, cx } = useStyles();
+  const { t } = useTranslation();
+
+  const {
+    total,
+    titleVariant,
+    legendScale,
+    isVerticalBar,
+    colorScale,
+    formattedLegendDirection
+  } = useResponsiveBarStack({
+    data,
+    height,
+    legendDirection,
+    unit,
+    variant,
+    width
+  });
+
+  const graphAndLegendHeight = useMemo(() => {
+    if (equals(titleVariant, 'xs')) {
+      return height - 2 * smallTitleHeight - gap;
+    }
+
+    if (equals(titleVariant, 'sm')) {
+      return height - smallTitleHeight - gap;
+    }
+
+    return height - titleHeight - gap;
+  }, [titleVariant, height]);
+
+  return (
+    <div
+      className={classes.container}
+      data-has-title={!!title}
+      data-title-variant={titleVariant}
+      data-variant={variant}
+    >
+      {title && (
+        <Typography
+          className={cx(equals(titleVariant, 'md') && classes.clippedTitle)}
+          data-testid="Title"
+          fontWeight="bold"
+          textAlign="center"
+          variant={equals(titleVariant, 'md') ? 'h6' : 'body1'}
+        >
+          {`${numeral(total).format('0a')}`} {t(title)}
+        </Typography>
+      )}
+      <GraphAndLegend
+        TooltipContent={TooltipContent}
+        colorScale={colorScale}
+        data={data}
+        displayLegend={displayLegend}
+        displayValues={displayValues}
+        height={graphAndLegendHeight}
+        isVerticalBar={isVerticalBar}
+        legend={
+          <Legend
+            data={data}
+            direction={formattedLegendDirection}
+            scale={legendScale}
+            title={title}
+            total={total}
+            unit={unit}
+          />
+        }
+        tooltipProps={tooltipProps}
+        total={total}
+        unit={unit}
+        width={width}
+        onSingleBarClick={onSingleBarClick}
+      />
+    </div>
+  );
+};
+
+export default BarStack;

package/src/Graph/BarStack/constants.ts

@@ -0,0 +1,5 @@
+export const legendMaxWidth = 85;
+export const legendMaxHeight = 43;
+export const titleHeight = 36;
+export const smallTitleHeight = 20;
+export const gap = 4;

package/src/Graph/BarStack/index.ts

@@ -0,0 +1 @@
+export { default as BarStack } from './BarStack';

package/src/Graph/BarStack/models.ts

@@ -0,0 +1,19 @@
+export interface BarType {
+  color: string;
+  label: string;
+  value: number;
+}
+
+export type BarStackProps = {
+  Legend?: ({ scale, data, title, total, unit, direction }) => JSX.Element;
+  TooltipContent?: (barData) => JSX.Element | boolean | null;
+  data: Array<BarType>;
+  displayLegend?: boolean;
+  displayValues?: boolean;
+  legendDirection?: 'row' | 'column';
+  onSingleBarClick?: (barData) => void;
+  title?: string;
+  tooltipProps?: object;
+  unit?: 'percentage' | 'number';
+  variant?: 'vertical' | 'horizontal';
+};