@centreon/ui 26.12.7 → 26.12.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centreon/ui",
-  "version": "26.12.7",
+  "version": "26.12.9",
   "description": "Centreon UI Components",
   "scripts": {
     "update:deps": "pnpx npm-check-updates -i --format group",

package/src/Form/Form.stories.tsx

@@ -1,7 +1,7 @@
 import { object } from 'yup';
 
 import { Form, GroupDirection } from './Form';
-import { InputType } from './Inputs/models';
+import { type InputProps, InputType } from './Inputs/models';
 import {
   type BasicForm,
   basicFormGroups,
@@ -149,3 +149,65 @@ export const segmentedButtons = (): JSX.Element => (
     validationSchema={object()}
   />
 );
+
+const getSeparatedFields = (count: number): Array<InputProps> =>
+  Array.from({ length: count }, (_, index) => ({
+    fieldName: `field${index + 1}`,
+    group: '',
+    label: `Field ${index + 1}`,
+    type: InputType.Text
+  }));
+
+const getSeparatedGrid = ({
+  className,
+  count,
+  name
+}: {
+  className: string;
+  count: number;
+  name: string;
+}): InputProps => ({
+  fieldName: name,
+  grid: {
+    className,
+    columnSeparator: true,
+    columns: getSeparatedFields(count).map(({ group, ...field }) => ({
+      ...field,
+      fieldName: `${name}-${field.fieldName}`
+    }))
+  },
+  group: '',
+  label: name,
+  type: InputType.Grid
+});
+
+// The grids of this story show 1, 2 or 3 columns as the panel is resized (drag
+// its bottom right corner): the lines only come between columns, on every row.
+export const columnSeparators = (): JSX.Element => (
+  <div className="@container resize-x overflow-auto border border-dashed p-4">
+    <Form
+      initialValues={{}}
+      inputs={[
+        getSeparatedGrid({
+          className: 'grid-cols-1 gap-x-8 @[500px]:grid-cols-2',
+          count: 2,
+          name: 'two-columns'
+        }),
+        getSeparatedGrid({
+          className:
+            'grid-cols-1 gap-x-8 @[500px]:grid-cols-2 @[900px]:grid-cols-3',
+          count: 3,
+          name: 'three-columns'
+        }),
+        getSeparatedGrid({
+          className:
+            'grid-cols-1 gap-x-8 @[500px]:grid-cols-2 @[900px]:grid-cols-3',
+          count: 5,
+          name: 'wrapping-rows'
+        })
+      ]}
+      submit={submit}
+      validationSchema={object()}
+    />
+  </div>
+);

package/src/Form/Inputs/Grid.browser.test.tsx

@@ -0,0 +1,186 @@
+import { rs } from '@rstest/core';
+import { render } from '@test-setup/render';
+import { screen } from '@testing-library/react';
+import { object } from 'yup';
+
+import { Form } from '../Form';
+import { type InputProps, InputType } from './models';
+
+const getField = (
+  name: string,
+  extra: Partial<InputProps> = {}
+): Omit<InputProps, 'group'> => ({
+  fieldName: name,
+  label: name,
+  type: InputType.Text,
+  ...extra
+});
+
+interface InitializeProps {
+  columnSeparator?: boolean;
+  // The tracks of the grid: what makes the number of columns follow the width.
+  columns: string;
+  fields: Array<Omit<InputProps, 'group'>>;
+  width: number;
+}
+
+const initialize = ({
+  columns,
+  columnSeparator,
+  fields,
+  width
+}: InitializeProps): void => {
+  render(
+    <div style={{ padding: 40, width }}>
+      <Form
+        initialValues={{}}
+        inputs={[
+          {
+            fieldName: 'layout',
+            grid: {
+              columnSeparator,
+              columns: fields,
+              gridTemplateColumns: columns
+            },
+            group: '',
+            label: 'layout',
+            type: InputType.Grid
+          }
+        ]}
+        submit={rs.fn()}
+        validationSchema={object()}
+      />
+    </div>
+  );
+};
+
+// The lines the grid draws, one for each of its items.
+const getLines = (): Array<HTMLElement> =>
+  Array.from(document.querySelectorAll('[data-column-separator]'));
+
+// A line is seen when what is painted at its place is the line itself: outside
+// the grid, where it is clipped, there is something else.
+const getVisibleLines = (): Array<boolean> =>
+  getLines().map((line) => {
+    const { left, top } = line.getBoundingClientRect();
+
+    return document.elementFromPoint(left + 0.5, top + 10) === line;
+  });
+
+const threeFields = ['one', 'two', 'three'].map((name) => getField(name));
+
+describe('Grid column separator', () => {
+  beforeEach(() => {
+    expect.hasAssertions();
+  });
+
+  it('draws nothing unless asked to', async () => {
+    initialize({
+      columns: 'repeat(2, 1fr)',
+      fields: threeFields,
+      width: 800
+    });
+
+    await screen.findByLabelText('one');
+
+    expect(document.querySelectorAll('[data-column-separator]')).toHaveLength(
+      0
+    );
+  });
+
+  it('draws a dashed line between two columns, not left of the first', async () => {
+    initialize({
+      columnSeparator: true,
+      columns: 'repeat(2, 1fr)',
+      fields: [getField('one'), getField('two')],
+      width: 800
+    });
+
+    await screen.findByLabelText('one');
+
+    expect(getVisibleLines()).toEqual([false, true]);
+
+    const line = getComputedStyle(getLines()[1]);
+
+    expect(line.borderLeftStyle).toBe('dashed');
+    expect(line.borderLeftWidth).toBe('1px');
+  });
+
+  it('draws nothing when the layout has a single column', async () => {
+    initialize({
+      columnSeparator: true,
+      columns: 'repeat(auto-fill, minmax(500px, 1fr))',
+      fields: [getField('one'), getField('two')],
+      width: 400
+    });
+
+    await screen.findByLabelText('one');
+
+    expect(getVisibleLines()).toEqual([false, false]);
+  });
+
+  it('follows the number of columns the layout shows', async () => {
+    initialize({
+      columnSeparator: true,
+      columns: 'repeat(auto-fill, minmax(300px, 1fr))',
+      fields: threeFields,
+      width: 1100
+    });
+
+    await screen.findByLabelText('one');
+
+    expect(getVisibleLines()).toEqual([false, true, true]);
+  });
+
+  it('draws the lines of every row when the items wrap', async () => {
+    initialize({
+      columnSeparator: true,
+      columns: 'repeat(3, 1fr)',
+      fields: ['a', 'b', 'c', 'd', 'e'].map((name) => getField(name)),
+      width: 1100
+    });
+
+    await screen.findByLabelText('a');
+
+    expect(getVisibleLines()).toEqual([false, true, true, false, true]);
+  });
+
+  it('spans the height of the row, not of the item', async () => {
+    initialize({
+      columnSeparator: true,
+      columns: 'repeat(2, 1fr)',
+      fields: [
+        getField('short'),
+        getField('tall', { text: { multilineRows: 6 } })
+      ],
+      width: 800
+    });
+
+    await screen.findByLabelText('short');
+
+    const [short, tall] = getLines().map(
+      (item) => item.getBoundingClientRect().height
+    );
+
+    expect(tall).toBeGreaterThan(100);
+    expect(short).toBeCloseTo(tall, 0);
+  });
+
+  it('leaves no line for a hidden item and follows the items left', async () => {
+    initialize({
+      columnSeparator: true,
+      columns: 'repeat(2, 1fr)',
+      fields: [
+        getField('one'),
+        getField('hidden', { hideInput: () => true }),
+        getField('three')
+      ],
+      width: 800
+    });
+
+    await screen.findByLabelText('one');
+
+    expect(getLines()).toHaveLength(2);
+    expect(getVisibleLines()).toEqual([false, true]);
+  });
+});

package/src/Form/Inputs/Grid.tsx

@@ -2,10 +2,36 @@ import { Box, Typography } from '@mui/material';
 
 import { type FormikValues, useFormikContext } from 'formik';
 import { isNotEmpty, isNotNil } from 'ramda';
+import type { CSSProperties } from 'react';
 
 import { getInput } from '.';
 import type { InputPropsWithoutGroup } from './models';
 
+// The line is drawn left of every item, in the middle of the gap, and the grid
+// clips what falls out of it: the items of the first column lose theirs, so it
+// never shows in a single column nor left of the first one, whatever the number
+// of columns, without knowing it. The clip keeps 4px around the grid so that
+// nothing the items draw outside their box is cut.
+const columnGap = 'calc(var(--spacing) * 8)';
+
+const columnSeparatorGridStyle = {
+  '--form-grid-column-gap': columnGap,
+  columnGap: 'var(--form-grid-column-gap)',
+  overflowClipMargin: '4px',
+  overflowX: 'clip'
+} as CSSProperties;
+
+// The dashed line of an item: half a gap to its left, over the height of its
+// content.
+const ColumnSeparator = (): JSX.Element => (
+  <span
+    aria-hidden
+    className="absolute inset-y-0 border-l border-dashed border-divider"
+    data-column-separator
+    style={{ left: 'calc(var(--form-grid-column-gap) / -2)' }}
+  />
+);
+
 const Grid = ({
   grid,
   hideInput
@@ -17,6 +43,7 @@ const Grid = ({
   }
 
   const className = grid?.className || '';
+  const hasColumnSeparator = grid?.columnSeparator ?? false;
 
   return (
     <div
@@ -26,7 +53,8 @@ const Grid = ({
         gridTemplateColumns: className
           ? grid?.gridTemplateColumns || undefined
           : grid?.gridTemplateColumns ||
-            `repeat(${grid?.columns.length || 1}, 1fr)`
+            `repeat(${grid?.columns.length || 1}, 1fr)`,
+        ...(hasColumnSeparator && columnSeparatorGridStyle)
       }}
     >
       {grid?.columns.map((field) => {
@@ -41,17 +69,37 @@ const Grid = ({
           return null;
         }
 
+        const title = field.additionalLabel && (
+          <Typography
+            className={`mb-1 text-base font-bold text-text-primary ${field?.additionalLabelClassName || ''}`}
+            variant="h6"
+          >
+            {field.additionalLabel}
+          </Typography>
+        );
+
+        if (!hasColumnSeparator) {
+          return (
+            <Box key={key as string} sx={{ width: '100%' }}>
+              {title}
+              <Input {...field} />
+            </Box>
+          );
+        }
+
+        // The item stretches to the height of its row and its content fills
+        // what its title leaves, so the line spans the whole row.
         return (
-          <Box key={key as string} sx={{ width: '100%' }}>
-            {field.additionalLabel && (
-              <Typography
-                className={`mb-1 text-base font-bold text-text-primary ${field?.additionalLabelClassName || ''}`}
-                variant="h6"
-              >
-                {field.additionalLabel}
-              </Typography>
-            )}
-            <Input {...field} />
+          <Box
+            className="flex flex-col self-stretch"
+            key={key as string}
+            sx={{ width: '100%' }}
+          >
+            {title}
+            <div className="relative flex-1">
+              <ColumnSeparator />
+              <Input {...field} />
+            </div>
           </Box>
         );
       })}

package/src/Form/Inputs/SegmentedButtons.tsx

@@ -32,7 +32,9 @@ const SegmentedButtons = ({
   return useMemoComponent({
     Component: (
       <FormGroup>
-        <FormLabel className="font-bold">{t(label)}</FormLabel>
+        {!segmentedButtons?.hideLabel && (
+          <FormLabel className="font-bold">{t(label)}</FormLabel>
+        )}
         {/* In a column narrower than the three minimum widths, the group scrolls
             inside it rather than overflowing into what is next to it. */}
         <div className="max-w-full self-start overflow-x-auto">

package/src/Form/Inputs/models.ts

@@ -146,6 +146,10 @@ export interface InputProps {
   grid?: {
     alignItems?: string;
     className?: string;
+    // A dashed vertical line in the gap between two columns, never left of
+    // the first one, whatever the number of columns the layout shows. To set
+    // on the grids that place groups of fields side by side.
+    columnSeparator?: boolean;
     columns: Array<Omit<InputProps, 'group'>>;
     gridTemplateColumns?: string;
   };
@@ -171,6 +175,8 @@ export interface InputProps {
   };
   required?: boolean;
   segmentedButtons?: {
+    // Leaves the label out of the display; it stays the group's accessible name.
+    hideLabel?: boolean;
     options: Array<{
       label: string;
       value: string;