@centreon/ui 23.10.121 → 24.4.1-0

package/src/Graph/BarStack/BarStack.cypress.spec.tsx

@@ -0,0 +1,139 @@
+import numeral from 'numeral';
+
+import BarStack from './BarStack';
+import { BarType, BarStackProps } from './models';
+
+const defaultData = [
+  { color: '#88B922', label: 'Ok', value: 148 },
+  { color: '#999999', label: 'Unknown', value: 13 },
+  { color: '#F7931A', label: 'Warning', value: 16 },
+  { color: '#FF6666', label: 'Down', value: 62 }
+];
+
+const total = Math.floor(
+  defaultData.reduce((acc, { value }) => acc + value, 0)
+);
+
+const TooltipContent = ({ label, color, value }: BarType): JSX.Element => {
+  return (
+    <div data-testid={`tooltip-${label}`} style={{ color }}>
+      {label} : {value}
+    </div>
+  );
+};
+
+const initialize = ({
+  width = '400px',
+  height = '400px',
+  data = defaultData,
+  ...args
+}: Omit<BarStackProps, 'data'> & {
+  data?;
+  height?: string;
+  width?: string;
+}): void => {
+  cy.mount({
+    Component: (
+      <div style={{ height, width }}>
+        <BarStack {...args} data={data} />
+      </div>
+    )
+  });
+};
+
+describe('Bar stack', () => {
+  it('renders Bar stack correctly with provided data', () => {
+    initialize({});
+
+    defaultData.forEach(({ label }) => {
+      cy.findByTestId(label).should('be.visible');
+    });
+
+    cy.makeSnapshot();
+  });
+
+  it('adjusts size based on the provided width and height', () => {
+    initialize({ displayLegend: false, height: '300px', width: '300px' });
+
+    cy.findByTestId('barStack').should('have.css', 'height', '300px');
+
+    cy.makeSnapshot();
+  });
+
+  it('renders as a horizontal bar when variant is set to "horizontal"', () => {
+    initialize({ variant: 'horizontal' });
+    cy.get('[data-variant="horizontal"]').should('exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('renders as a vertical bar when variant is set to "vertical"', () => {
+    initialize({ variant: 'vertical' });
+    cy.get('[data-variant="vertical"]').should('exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays tooltip with correct information on hover', () => {
+    initialize({ TooltipContent });
+
+    defaultData.forEach(({ label, value }) => {
+      cy.findByTestId(label).trigger('mouseover', { force: true });
+
+      cy.findByTestId(`tooltip-${label}`)
+        .should('contain', label)
+        .and('contain', numeral(value).format('0a').toUpperCase());
+    });
+
+    cy.makeSnapshot();
+  });
+
+  it('conditionally displays values on rects based on displayValues prop', () => {
+    initialize({ displayValues: true });
+    defaultData.forEach(({ value }, index) => {
+      cy.findAllByTestId('value')
+        .eq(index)
+        .children()
+        .eq(0)
+        .should('have.text', value);
+    });
+
+    initialize({ displayValues: false });
+    cy.findAllByTestId('value').should('not.exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays values on rects in percentage unit when displayValues is set to true and unit to percentage', () => {
+    initialize({ displayValues: true, unit: 'percentage' });
+    defaultData.forEach(({ value }, index) => {
+      cy.findAllByTestId('value')
+        .eq(index)
+        .children()
+        .eq(0)
+        .should('have.text', `${((value * 100) / total).toFixed(1)}%`);
+    });
+
+    cy.makeSnapshot();
+  });
+
+  it('displays Legend component based on displayLegend prop', () => {
+    initialize({ displayLegend: true });
+    cy.findByTestId('Legend').should('be.visible');
+
+    initialize({ displayLegend: false });
+    cy.findByTestId('Legend').should('not.exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the title when the title is giving', () => {
+    initialize({ title: 'host' });
+    cy.findByTestId('Title').should('be.visible');
+
+    initialize({});
+    cy.findByTestId('Title').should('not.exist');
+
+    cy.makeSnapshot();
+  });
+});

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

@@ -0,0 +1,123 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+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: '300px', width: '500px' }}>
+      <BarStack {...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,
+    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,37 @@
+import { makeStyles } from 'tss-react/mui';
+
+export const useBarStackStyles = makeStyles()((theme) => ({
+  barStackTooltip: {
+    backgroundColor: theme.palette.background.paper,
+    color: theme.palette.text.primary,
+    padding: 0,
+    position: 'relative'
+  },
+  container: {
+    alignItems: 'center',
+    display: 'flex',
+    gap: theme.spacing(1.5),
+    justifyContent: 'center'
+  },
+  svgContainer: {
+    alignItems: 'center',
+    backgroundColor: theme.palette.background.panelGroups,
+    borderRadius: theme.spacing(1.25),
+    display: 'flex',
+    justifyContent: 'center'
+  },
+  svgWrapper: {
+    alignItems: 'center',
+    display: 'flex',
+    flexDirection: 'column',
+    gap: theme.spacing(1),
+    justifyContent: 'center'
+  },
+  title: {
+    fontSize: theme.typography.h6.fontSize,
+    fontWeight: theme.typography.fontWeightMedium,
+    margin: 0,
+    padding: 0,
+    textAlign: 'center'
+  }
+}));

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/ResponsiveBarStack.tsx

@@ -0,0 +1,211 @@
+import { useRef } from 'react';
+
+import { BarStack as BarStackVertical, BarStackHorizontal } from '@visx/shape';
+import { Group } from '@visx/group';
+import numeral from 'numeral';
+import { Text } from '@visx/text';
+import { useTranslation } from 'react-i18next';
+import { equals } from 'ramda';
+
+import { Tooltip } from '../../components';
+import { LegendProps } from '../Legend/models';
+import { Legend as LegendComponent } from '../Legend';
+import { getValueByUnit } from '../common/utils';
+
+import { BarStackProps } from './models';
+import { useBarStackStyles } from './BarStack.styles';
+import useResponsiveBarStack from './useResponsiveBarStack';
+
+const DefaultLengd = ({ scale, direction }: LegendProps): JSX.Element => (
+  <LegendComponent direction={direction} scale={scale} />
+);
+
+const BarStack = ({
+  title,
+  data,
+  width,
+  height,
+  size = 72,
+  onSingleBarClick,
+  displayLegend = true,
+  TooltipContent,
+  Legend = DefaultLengd,
+  unit = 'number',
+  displayValues,
+  variant = 'vertical',
+  legendDirection = 'column',
+  tooltipProps = {}
+}: BarStackProps & { height: number; width: number }): JSX.Element => {
+  const { t } = useTranslation();
+  const { classes } = useBarStackStyles();
+
+  const titleRef = useRef(null);
+  const legendRef = useRef(null);
+
+  const {
+    barSize,
+    colorScale,
+    input,
+    keys,
+    legendScale,
+    total,
+    xScale,
+    yScale,
+    svgWrapperWidth,
+    svgContainerSize,
+    isVerticalBar
+  } = useResponsiveBarStack({
+    data,
+    height,
+    legendRef,
+    size,
+    titleRef,
+    unit,
+    variant,
+    width
+  });
+
+  const BarStackComponent = isVerticalBar
+    ? BarStackVertical
+    : BarStackHorizontal;
+
+  return (
+    <div className={classes.container} style={{ height, width }}>
+      <div
+        className={classes.svgWrapper}
+        style={{
+          height,
+          width: svgWrapperWidth
+        }}
+      >
+        {title && (
+          <div className={classes.title} data-testid="Title" ref={titleRef}>
+            {`${numeral(total).format('0a').toUpperCase()} `} {t(title)}
+          </div>
+        )}
+        <div
+          className={classes.svgContainer}
+          data-testid="barStack"
+          style={svgContainerSize}
+        >
+          <svg
+            data-variant={variant}
+            height={barSize.height}
+            width={barSize.width}
+          >
+            <Group>
+              <BarStackComponent
+                color={colorScale}
+                data={[input]}
+                keys={keys}
+                {...(isVerticalBar
+                  ? { x: () => undefined }
+                  : { y: () => undefined })}
+                xScale={xScale}
+                yScale={yScale}
+              >
+                {(barStacks) =>
+                  barStacks.map((barStack) =>
+                    barStack.bars.map((bar) => {
+                      const shouldDisplayValues = (): boolean => {
+                        if (bar.height < 10) {
+                          return false;
+                        }
+
+                        return (
+                          (equals(unit, 'number') && bar.width > 10) ||
+                          (equals(unit, 'percentage') && bar.width > 25)
+                        );
+                      };
+
+                      const TextX = bar.x + bar.width / 2;
+                      const TextY = bar.y + bar.height / 2;
+
+                      const onClick = (): void => {
+                        onSingleBarClick?.(bar);
+                      };
+
+                      return (
+                        <Tooltip
+                          hasCaret
+                          classes={{
+                            tooltip: classes.barStackTooltip
+                          }}
+                          followCursor={false}
+                          key={`bar-stack-${barStack.index}-${bar.index}`}
+                          label={
+                            TooltipContent && (
+                              <TooltipContent
+                                color={bar.color}
+                                label={bar.key}
+                                title={title}
+                                total={total}
+                                value={barStack.bars[0].bar.data[barStack.key]}
+                                {...tooltipProps}
+                              />
+                            )
+                          }
+                          position={
+                            isVerticalBar ? 'right-start' : 'bottom-start'
+                          }
+                        >
+                          <g data-testid={bar.key} onClick={onClick}>
+                            <rect
+                              cursor="pointer"
+                              fill={bar.color}
+                              height={
+                                isVerticalBar ? bar.height - 1 : bar.height
+                              }
+                              key={`bar-stack-${barStack.index}-${bar.index}`}
+                              ry={10}
+                              width={isVerticalBar ? bar.width : bar.width - 1}
+                              x={bar.x}
+                              y={bar.y}
+                            />
+                            {displayValues && shouldDisplayValues() && (
+                              <Text
+                                cursor="pointer"
+                                data-testid="value"
+                                fill="#000"
+                                fontSize={12}
+                                fontWeight={600}
+                                textAnchor="middle"
+                                verticalAnchor="middle"
+                                x={TextX}
+                                y={TextY}
+                              >
+                                {getValueByUnit({
+                                  total,
+                                  unit,
+                                  value: barStack.bars[0].bar.data[barStack.key]
+                                })}
+                              </Text>
+                            )}
+                          </g>
+                        </Tooltip>
+                      );
+                    })
+                  )
+                }
+              </BarStackComponent>
+            </Group>
+          </svg>
+        </div>
+      </div>
+      {displayLegend && (
+        <div data-testid="Legend" ref={legendRef}>
+          <Legend
+            data={data}
+            direction={legendDirection}
+            scale={legendScale}
+            title={title}
+            total={total}
+            unit={unit}
+          />
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default BarStack;

package/src/Graph/BarStack/index.ts

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

package/src/Graph/BarStack/models.ts

@@ -0,0 +1,20 @@
+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;
+  size?: number;
+  title?: string;
+  tooltipProps?: object;
+  unit?: 'percentage' | 'number';
+  variant?: 'vertical' | 'horizontal';
+};

package/src/Graph/BarStack/useResponsiveBarStack.ts

@@ -0,0 +1,131 @@
+import { scaleBand, scaleLinear, scaleOrdinal } from '@visx/scale';
+import { equals, pluck } from 'ramda';
+
+import { getValueByUnit } from '../common/utils';
+import { LegendScale } from '../Legend/models';
+
+import { BarType } from './models';
+
+interface Size {
+  height: number;
+  width: number;
+}
+
+interface useBarStackProps {
+  data: Array<BarType>;
+  height: number;
+  legendRef;
+  size: number;
+  titleRef;
+  unit?: 'percentage' | 'number';
+  variant?: 'vertical' | 'horizontal';
+  width: number;
+}
+interface useBarStackState {
+  barSize: Size;
+  colorScale;
+  input;
+  isVerticalBar: boolean;
+  keys: Array<string>;
+  legendScale: LegendScale;
+  svgContainerSize: Size;
+  svgWrapperWidth: number;
+  total: number;
+  xScale;
+  yScale;
+}
+
+const useResponsiveBarStack = ({
+  data,
+  variant,
+  height,
+  width,
+  unit = 'number',
+  titleRef,
+  legendRef,
+  size
+}: useBarStackProps): useBarStackState => {
+  const isVerticalBar = equals(variant, 'vertical');
+
+  const heightOfTitle = titleRef.current?.offsetHeight || 0;
+  const widthOfLegend = legendRef.current?.offsetWidth || 0;
+
+  const horizontalGap = widthOfLegend > 0 ? 12 : 0;
+  const verticalGap = heightOfTitle > 0 ? 8 : 0;
+
+  const svgWrapperWidth = isVerticalBar
+    ? size + 36
+    : width - widthOfLegend - horizontalGap;
+
+  const svgContainerSize = {
+    height: isVerticalBar ? height - heightOfTitle - verticalGap : size,
+    width: isVerticalBar ? size : width - widthOfLegend - horizontalGap
+  };
+
+  const barSize = {
+    height: svgContainerSize.height - 16,
+    width: svgContainerSize.width - 16
+  };
+
+  const total = Math.floor(data.reduce((acc, { value }) => acc + value, 0));
+
+  const yScale = isVerticalBar
+    ? scaleLinear({
+        domain: [0, total]
+      })
+    : scaleBand({
+        domain: [0, 0],
+        padding: 0
+      });
+
+  const xScale = isVerticalBar
+    ? scaleBand({
+        domain: [0, 0],
+        padding: 0
+      })
+    : scaleLinear({
+        domain: [0, total]
+      });
+
+  const keys = pluck('label', data);
+
+  const colorsRange = pluck('color', data);
+
+  const colorScale = scaleOrdinal({
+    domain: keys,
+    range: colorsRange
+  });
+
+  const legendScale = {
+    domain: data.map(({ value }) => getValueByUnit({ total, unit, value })),
+    range: colorsRange
+  };
+
+  const xMax = barSize.width;
+  const yMax = barSize.height;
+
+  xScale.rangeRound([0, xMax]);
+  yScale.range([yMax, 0]);
+
+  const input = data.reduce((acc, { label, value }) => {
+    acc[label] = value;
+
+    return acc;
+  }, {});
+
+  return {
+    barSize,
+    colorScale,
+    input,
+    isVerticalBar,
+    keys,
+    legendScale,
+    svgContainerSize,
+    svgWrapperWidth,
+    total,
+    xScale,
+    yScale
+  };
+};
+
+export default useResponsiveBarStack;