@centreon/ui 24.4.21 → 24.4.22

package/src/PopoverMenu/index.tsx

@@ -1,4 +1,4 @@
-import { useState, useEffect } from 'react';
+import { Dispatch, SetStateAction, useEffect, useState } from 'react';
 
 import { makeStyles } from 'tss-react/mui';
 
@@ -9,6 +9,7 @@ import {
   PopperPlacementType,
   useTheme
 } from '@mui/material';
+import { PopperProps } from '@mui/material/Popper';
 
 import { IconButton } from '..';
 
@@ -19,15 +20,22 @@ const useStyles = makeStyles()(() => ({
   }
 }));
 
+interface PopoverData {
+  anchorEl: HTMLElement | undefined;
+  setAnchorEl: Dispatch<SetStateAction<HTMLElement | undefined>>;
+}
+
 interface Props {
   canOpen?: boolean;
   children: (props?) => JSX.Element;
   className?: string;
   dataTestId?: string;
+  getPopoverData?: (data: PopoverData) => void;
   icon: JSX.Element;
   onClose?: () => void;
   onOpen?: () => void;
   popperPlacement?: PopperPlacementType;
+  popperProps?: Partial<PopperProps>;
   title?: string;
 }
 
@@ -40,20 +48,21 @@ const PopoverMenu = ({
   onClose,
   canOpen = true,
   className,
-  dataTestId
+  dataTestId,
+  getPopoverData,
+  popperProps
 }: Props): JSX.Element => {
   const theme = useTheme();
   const { classes, cx } = useStyles();
   const [anchorEl, setAnchorEl] = useState<HTMLElement | undefined>();
-
   const isOpen = Boolean(anchorEl);
 
   const close = (reason?): void => {
     const isClosedByInputClick = reason?.type === 'mousedown';
-
     if (isClosedByInputClick) {
       return;
     }
+
     onClose?.();
     setAnchorEl(undefined);
   };
@@ -75,6 +84,10 @@ const PopoverMenu = ({
     }
   }, [canOpen]);
 
+  useEffect(() => {
+    getPopoverData?.({ anchorEl, setAnchorEl });
+  }, [anchorEl]);
+
   return (
     <>
       <IconButton
@@ -97,6 +110,7 @@ const PopoverMenu = ({
             style={{ zIndex: theme.zIndex.tooltip }}
             onResize={(): undefined => undefined}
             onResizeCapture={(): undefined => undefined}
+            {...popperProps}
           >
             <Paper>{children({ close })}</Paper>
           </Popper>

package/src/RichTextEditor/ContentEditable.tsx

@@ -9,17 +9,17 @@ import { Typography } from '@mui/material';
 
 interface StyleProps {
   editable: boolean;
+  error?: string;
   minInputHeight: number;
 }
 
 const useStyles = makeStyles<StyleProps>()(
-  (theme, { minInputHeight, editable }) => ({
+  (theme, { minInputHeight, editable, error }) => ({
     container: {
-      '& p': {
-        margin: 0
-      },
       backgroundColor: theme.palette.background.paper,
-      border: '1px solid transparent',
+      border: error
+        ? `1px solid ${theme.palette.error.main}`
+        : '1px solid transparent',
       borderRadius: theme.shape.borderRadius,
       padding: theme.spacing(0.5, 1)
     },
@@ -31,27 +31,45 @@ const useStyles = makeStyles<StyleProps>()(
       outline: '0px solid transparent'
     },
     inputFocused: {
-      border: `1px solid ${theme.palette.primary.main}`
+      border: error
+        ? `1px solid ${theme.palette.error.main}`
+        : `1px solid ${theme.palette.primary.main}`
+    },
+    notEditable: {
+      backgroundColor: 'transparent'
     },
     placeholder: {
       color: theme.palette.grey[500],
       pointerEvents: 'none'
+    },
+    root: {
+      '& p,h1,h2,h3,h4,h5,h6,span': {
+        margin: 0
+      }
     }
   })
 );
 
 interface Props {
+  className?: string;
+  disabled?: boolean;
   editable: boolean;
   editorState?: string;
+  error?: string;
   hasInitialTextContent?: boolean;
   initialEditorState?: string;
+  initialize?: (editor) => void;
   inputClassname?: string;
   minInputHeight: number;
   namespace: string;
+  onBlur?: (e: string) => void;
   placeholder: string;
   resetEditorToInitialStateCondition?: () => boolean;
 }
 
+const defaultState =
+  '{"root":{"children":[{"children":[],"direction":null,"format":"","indent":0,"type":"paragraph","version":1}],"direction":null,"format":"","indent":0,"type":"root","version":1}}';
+
 const ContentEditable = ({
   minInputHeight,
   inputClassname,
@@ -61,13 +79,17 @@ const ContentEditable = ({
   editorState,
   namespace,
   resetEditorToInitialStateCondition,
-  initialEditorState
+  initialEditorState,
+  error,
+  onBlur,
+  className,
+  disabled,
+  initialize
 }: Props): JSX.Element => {
-  const { classes, cx } = useStyles({ editable, minInputHeight });
+  const { classes, cx } = useStyles({ editable, error, minInputHeight });
   const { t } = useTranslation();
 
   const [editor] = useLexicalComposerContext();
-  const [isEditable, setEditable] = useState(false);
   const [isFocused, setFocused] = useState(false);
   const [root, setRoot] = useState('');
 
@@ -79,17 +101,13 @@ const ContentEditable = ({
   );
 
   useLayoutEffect(() => {
-    setEditable(editor.isEditable());
-
-    if (editorState && !editable) {
-      const newEditorState = editor.parseEditorState(editorState);
+    if (!editable) {
+      const newEditorState = editor.parseEditorState(
+        editorState || defaultState
+      );
 
       editor.setEditorState(newEditorState);
     }
-
-    return editor.registerEditableListener((currentIsEditable) => {
-      setEditable(currentIsEditable);
-    });
   }, [editor, editorState]);
 
   useEffect(() => {
@@ -108,21 +126,49 @@ const ContentEditable = ({
     const shouldResetEditorToInitialState =
       resetEditorToInitialStateCondition?.();
 
-    if (!shouldResetEditorToInitialState || isNil(initialEditorState)) {
+    if (!shouldResetEditorToInitialState) {
       return;
     }
 
-    const newEditorState = editor.parseEditorState(initialEditorState);
+    const newEditorState = editor.parseEditorState(
+      initialEditorState || defaultState
+    );
 
     editor.setEditorState(newEditorState);
   }, [editorState]);
 
-  const isTextEmpty = isEmpty(root);
+  const isTextEmpty =
+    isEmpty(root) &&
+    !editor.getEditorState().toJSON().root.children?.[0]?.children?.length;
+
+  const handleBlur = (event: React.FocusEvent<HTMLInputElement>): void => {
+    setFocused(false);
+    onBlur?.(event);
+  };
+
+  const isEditable = editor.isEditable();
+
+  useEffect(() => {
+    if (isNil(disabled)) {
+      return;
+    }
+
+    editor.setEditable(!disabled);
+  }, [disabled]);
+
+  useEffect(() => {
+    initialize?.(editor);
+  }, []);
 
   return (
     <div
-      className={cx(classes.container, isFocused && classes.inputFocused)}
-      id={namespace}
+      className={cx(
+        classes.root,
+        editable && classes.container,
+        !isEditable && !disabled && classes.notEditable,
+        className,
+        isFocused && classes.inputFocused
+      )}
     >
       {editable && isTextEmpty && (
         <Typography className={classes.placeholder}>
@@ -132,14 +178,14 @@ const ContentEditable = ({
       <div
         aria-label={namespace}
         className={cx(
-          isTextEmpty && classes.emptyInput,
+          editable && isTextEmpty && classes.emptyInput,
           classes.input,
           inputClassname
         )}
         contentEditable={isEditable}
         data-testid={namespace}
         ref={ref}
-        onBlur={(): void => setFocused(false)}
+        onBlur={handleBlur}
         onFocus={(): void => setFocused(true)}
       />
     </div>

package/src/RichTextEditor/RichTextEditor.cypress.spec.tsx

@@ -0,0 +1,408 @@
+import RichTextEditor from './RichTextEditor';
+import { standardMacros } from './plugins/ToolbarPlugin/MacrosButton';
+import { labelAlignPicker } from './translatedLabels';
+
+interface CheckElementStyleOnRichTextEditorProps {
+  check: boolean;
+  element: HTMLElement;
+}
+
+const mockInititalStateToEditor =
+  '{"root": {"children": [{"children": [{"detail": 0,"format": 0,"mode": "normal","style": "","text": "test Cypress","type": "text","version": 1}],"direction": "ltr","format": "","indent": 0,"type": "paragraph","version": 1}],"direction": "ltr","format": "","indent": 0,"type": "root","version": 1}}';
+
+const checkElementStyleOnRichTextEditor = ({
+  element,
+  check
+}: CheckElementStyleOnRichTextEditorProps): void => {
+  cy.wrap(element).should('be.visible');
+
+  if (check) {
+    cy.wrap(element)
+      .contains('strong', 'cypress test')
+      .should('have.css', 'font-style')
+      .and('match', /italic/);
+
+    cy.wrap(element)
+      .contains('strong', 'cypress test')
+      .should('have.css', 'text-decoration')
+      .and('match', /underline line-through/);
+  } else {
+    cy.wrap(element)
+      .contains('p', 'cypress test')
+      .invoke('css', 'font-style')
+      .and('not.match', /italic/);
+
+    cy.wrap(element)
+      .contains('p', 'cypress test')
+      .invoke('css', 'text-decoration')
+      .and('not.match', /underline line-through/);
+  }
+};
+
+describe('Rich Text Editor', () => {
+  describe('Editable Rich Text Editor', () => {
+    beforeEach(() => {
+      cy.mount({ Component: <RichTextEditor editable /> });
+    });
+
+    it('displays all elements when RichTextEditor is called with required props', () => {
+      cy.findByLabelText('Undo').should('be.visible');
+      cy.findByLabelText('Redo').should('be.visible');
+      cy.findByLabelText('align picker').should('be.visible');
+      cy.findByLabelText('block').should('be.visible');
+      cy.findByLabelText('format').should('be.visible');
+      cy.findByLabelText('link').should('be.visible');
+      cy.findByLabelText('list').should('be.visible');
+
+      cy.findByLabelText('RichTextEditor')
+        .should('be.visible')
+        .and('have.value', '');
+
+      cy.findByLabelText('RichTextEditor').parent().contains('Type here...');
+
+      cy.makeSnapshot();
+    });
+
+    it('displays all format actions when the format button is clicked', () => {
+      cy.findByLabelText('format').click();
+
+      cy.findByLabelText('bold').should('be.visible');
+      cy.findByLabelText('italic').should('be.visible');
+      cy.findByLabelText('underline').should('be.visible');
+      cy.findByLabelText('strikethrough').should('be.visible');
+
+      cy.makeSnapshot();
+    });
+
+    it('displays changes with undo redo buttons', () => {
+      cy.get('[data-testid="RichTextEditor"]').type('cypress test');
+      cy.get('[data-testid="RichTextEditor"]').should(
+        'have.text',
+        'cypress test'
+      );
+
+      cy.findByLabelText('Undo').click();
+
+      cy.get('[data-testid="RichTextEditor"]').should('have.text', '');
+
+      cy.findByLabelText('Redo').click();
+
+      cy.get('[data-testid="RichTextEditor"]').should(
+        'have.text',
+        'cypress test'
+      );
+    });
+
+    it('displays changes with bold, italic, underline and strikethrough buttons', () => {
+      cy.get('[data-testid="RichTextEditor"]').type('cypress test');
+
+      cy.get('[data-testid="RichTextEditor"]').focus().type('{selectAll}');
+
+      cy.findByLabelText('format').click();
+      cy.findByLabelText('bold').click();
+
+      cy.findByLabelText('format').click();
+      cy.findByLabelText('italic').click();
+
+      cy.findByLabelText('format').click();
+      cy.findByLabelText('underline').click();
+
+      cy.findByLabelText('format').click();
+      cy.findByLabelText('strikethrough').click();
+
+      cy.findByTestId('RichTextEditor').then((element: HTMLElement) => {
+        checkElementStyleOnRichTextEditor({ check: true, element });
+      });
+
+      cy.findByLabelText('format').click();
+      cy.findByLabelText('bold').click();
+
+      cy.findByLabelText('format').click();
+      cy.findByLabelText('italic').click();
+
+      cy.findByLabelText('format').click();
+      cy.findByLabelText('underline').click();
+
+      cy.findByLabelText('format').click();
+      cy.findByLabelText('strikethrough').click();
+
+      cy.findByTestId('RichTextEditor').then((element: HTMLElement) => {
+        checkElementStyleOnRichTextEditor({ check: false, element });
+      });
+    });
+
+    it('adds link with an url when link button is clicked', () => {
+      cy.get('[data-testid="RichTextEditor"]').type('cypress');
+      cy.get('[data-testid="RichTextEditor"]').focus().type('{selectAll}');
+
+      cy.findByLabelText('link').click();
+
+      cy.findByLabelText('Saved link').should('have.text', 'https://');
+
+      cy.findByLabelText('Edit link').click();
+      cy.get('#InputLinkField').type('www.centreon.com').type('{enter}');
+
+      cy.findByText('cypress')
+        .parent()
+        .then((element: HTMLElement) => {
+          cy.wrap(element)
+            .should('have.attr', 'href')
+            .and('match', /^https:\/\/www.centreon.com/);
+
+          cy.wrap(element)
+            .should('have.attr', 'rel')
+            .and('match', /^noreferrer/);
+
+          cy.wrap(element)
+            .should('have.attr', 'target')
+            .and('match', /_blank/);
+        });
+
+      cy.get('[data-testid="RichTextEditor"]').focus().type('{selectAll}');
+
+      cy.findByLabelText('link').click();
+
+      cy.findByText('cypress')
+        .parent()
+        .then((element: HTMLElement) => {
+          cy.wrap(element)
+            .contains('p', 'cypress')
+            .should('not.have.attr', 'href');
+
+          cy.wrap(element).should('not.have.attr', 'rel');
+
+          cy.wrap(element).should('not.have.attr', 'target');
+        });
+    });
+
+    it('does not allow to open links in a new tab', () => {
+      cy.mount({
+        Component: <RichTextEditor editable openLinkInNewTab={false} />
+      });
+
+      cy.get('[data-testid="RichTextEditor"]').type('cypress');
+      cy.get('[data-testid="RichTextEditor"]').focus().type('{selectAll}');
+
+      cy.findByLabelText('link').click();
+
+      cy.findByLabelText('Saved link').should('have.text', 'https://');
+
+      cy.findByLabelText('Edit link').click();
+      cy.get('#InputLinkField').type('www.centreon.com').type('{enter}');
+
+      cy.findByText('cypress').parent().should('not.have.attr', 'target');
+
+      cy.get('[data-testid="RichTextEditor"]').focus().clear();
+
+      cy.get('[data-testid="RichTextEditor"]')
+        .focus()
+        .type('https://centreon.com');
+
+      cy.findByText('https://centreon.com')
+        .parent()
+        .should('not.have.attr', 'target');
+    });
+  });
+
+  describe('Rich Text Editor not editable', () => {
+    beforeEach(() => {
+      cy.mount({
+        Component: (
+          <RichTextEditor
+            editable={false}
+            initialEditorState={mockInititalStateToEditor}
+          />
+        )
+      });
+    });
+
+    it('displays editor when editable props is false and an initialState exist', () => {
+      cy.findByLabelText('Undo').should('not.exist');
+      cy.findByLabelText('Redo').should('not.exist');
+      cy.findByLabelText(labelAlignPicker).should('not.exist');
+      cy.findByLabelText('block').should('not.exist');
+      cy.findByLabelText('format').should('not.exist');
+      cy.findByLabelText('link').should('not.exist');
+      cy.findByLabelText('list').should('not.exist');
+    });
+  });
+
+  describe('Rich Text Editor is disabled', () => {
+    beforeEach(() => {
+      cy.mount({
+        Component: (
+          <RichTextEditor
+            disabled
+            editable
+            initialEditorState={mockInititalStateToEditor}
+          />
+        )
+      });
+    });
+
+    it('displays editor when editable props is false and an initialState exist', () => {
+      cy.findByLabelText('Undo').should('be.disabled');
+      cy.findByLabelText('Redo').should('be.disabled');
+      cy.findByLabelText(labelAlignPicker).should('be.disabled');
+      cy.findByLabelText('block').should('be.disabled');
+      cy.findByLabelText('format').should('be.disabled');
+      cy.findByLabelText('link').should('be.disabled');
+      cy.findByLabelText('list').should('be.disabled');
+    });
+  });
+
+  describe('Custom style editable rich text editor ', () => {
+    beforeEach(() => {
+      cy.mount({
+        Component: (
+          <RichTextEditor
+            editable
+            minInputHeight={200}
+            namespace="CypressComponentTest"
+            placeholder="Type Cypress test..."
+          />
+        )
+      });
+    });
+    it('displays editor with custom namespace', () => {
+      cy.get('[data-testid="CypressComponentTest"] > p').should('be.exist');
+      cy.get('[data-testid="CypressComponentTest"]').should('be.exist');
+    });
+
+    it('displays editor with custom placeholder', () => {
+      cy.get('[data-testid="CypressComponentTest"]')
+        .parent()
+        .contains('Type Cypress test...');
+    });
+
+    it('displays editor with custom minimum input height', () => {
+      cy.get('[data-testid="CypressComponentTest"]').should(
+        'have.css',
+        'min-height',
+        '200px'
+      );
+    });
+  });
+
+  describe('Rich Text Editor with Macros Plugin', () => {
+    beforeEach(() => {
+      cy.mount({
+        Component: <RichTextEditor displayMacrosButton editable />
+      });
+    });
+
+    it('displays the Macros button when the "displayMacrosButton" prop is set to true', () => {
+      cy.findByLabelText('Macros').click();
+
+      standardMacros.forEach((macro) => {
+        cy.findByText(macro).should('be.visible');
+      });
+    });
+
+    it('ensures that the selected macro is inserted into the RichTextEditor', () => {
+      cy.get('[data-testid="RichTextEditor"]').type('macro : ');
+
+      standardMacros.forEach((macro) => {
+        cy.findByLabelText('Macros').click();
+        cy.findByText(macro).click();
+
+        cy.get('[data-testid="RichTextEditor"]').should('contain', macro);
+      });
+    });
+  });
+
+  describe('Block type', () => {
+    beforeEach(() => {
+      cy.mount({
+        Component: <RichTextEditor editable />
+      });
+    });
+
+    const testCases = [
+      {
+        blockType: 'Huge',
+        tag: 'h3'
+      },
+      {
+        blockType: 'Large',
+        tag: 'h5'
+      },
+      {
+        blockType: 'Normal',
+        tag: 'p'
+      },
+      {
+        blockType: 'Small',
+        tag: 'h6'
+      }
+    ];
+
+    testCases.forEach(({ blockType, tag }) => {
+      it(`displays ${blockType} when the corresponding block type button is selected`, () => {
+        cy.get('[data-testid="RichTextEditor"]').type('Example');
+        cy.findByLabelText('block').click();
+        cy.findByText(blockType).click();
+
+        cy.get('[data-testid="RichTextEditor"]').find(tag).should('be.visible');
+
+        cy.makeSnapshot();
+      });
+    });
+  });
+
+  describe('List type', () => {
+    beforeEach(() => {
+      cy.mount({
+        Component: <RichTextEditor editable />
+      });
+    });
+
+    const testCases = [
+      {
+        listType: 'Unordered List',
+        tag: 'ul'
+      },
+      {
+        listType: 'Ordered List',
+        tag: 'ol'
+      }
+    ];
+
+    testCases.forEach(({ listType, tag }) => {
+      it(`displays ${listType} when the corresponding list type button is selected`, () => {
+        cy.get('[data-testid="RichTextEditor"]').type('Example');
+        cy.findByLabelText('list').click();
+        cy.findByLabelText(listType).click();
+
+        cy.get('[data-testid="RichTextEditor"]').find(tag).should('be.visible');
+
+        cy.makeSnapshot();
+      });
+    });
+  });
+
+  describe('Aligns', () => {
+    beforeEach(() => {
+      cy.mount({
+        Component: <RichTextEditor editable />
+      });
+    });
+
+    const testCases = ['Center', 'Right', 'Left'];
+
+    testCases.forEach((label) => {
+      it(`aligns the text to the ${label} when the corresponding button was clicked`, () => {
+        cy.get('[data-testid="RichTextEditor"]').type('Example');
+
+        cy.findByLabelText(labelAlignPicker).click();
+        cy.findByLabelText(label).click();
+
+        cy.findByText('Example')
+          .parent()
+          .should('have.css', 'text-align', label.toLowerCase());
+
+        cy.makeSnapshot();
+      });
+    });
+  });
+});