fix(Modal): Prevent auto aria-labelledby if aria-label is passed (#11012

) * fix(Modal): Prevent auto aria-labelledby if aria-label is passed * Fix logic and remove now unneeded console log * update labelledby logic to support it and aria-label, remove now unneeded test
patternfly · Sep 19, 2024 · 5bb4c1f · 5bb4c1f
1 parent 137a546
commit 5bb4c1f
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 35 deletions.
diff --git a/packages/react-core/src/components/Modal/Modal.tsx b/packages/react-core/src/components/Modal/Modal.tsx
@@ -114,12 +114,7 @@ class Modal extends React.Component<ModalProps, ModalState> {
   isEmpty = (value: string | null | undefined) => value === null || value === undefined || value === '';
 
   componentDidMount() {
-    const {
-      appendTo,
-      'aria-describedby': ariaDescribedby,
-      'aria-label': ariaLabel,
-      'aria-labelledby': ariaLabelledby
-    } = this.props;
+    const { appendTo } = this.props;
     const target: HTMLElement = this.getElement(appendTo);
     const container = document.createElement('div');
     this.setState({ container });
@@ -131,11 +126,6 @@ class Modal extends React.Component<ModalProps, ModalState> {
     } else {
       target.classList.remove(css(styles.backdropOpen));
     }
-
-    if (!ariaDescribedby && !ariaLabel && !ariaLabelledby) {
-      // eslint-disable-next-line no-console
-      console.error('Modal: Specify at least one of: aria-describedby, aria-label, aria-labelledby.');
-    }
   }
 
   componentDidUpdate() {

diff --git a/packages/react-core/src/components/Modal/ModalContent.tsx b/packages/react-core/src/components/Modal/ModalContent.tsx
@@ -70,19 +70,14 @@ export const ModalContent: React.FunctionComponent<ModalContentProps> = ({
     return null;
   }
 
-  const ariaLabelledbyFormatted = (): string => {
-    const idRefList: string[] = [];
-    if (ariaLabel && boxId) {
-      idRefList.push(ariaLabel && boxId);
-    }
+  const getAriaLabelledBy = (): string | undefined => {
     if (ariaLabelledby) {
-      idRefList.push(ariaLabelledby);
+      return ariaLabelledby;
     }
-    if (idRefList.length === 0) {
+    if (ariaLabel) {
       return undefined;
-    } else {
-      return idRefList.join(' ');
     }
+    return boxId;
   };
 
   const modalBox = (
@@ -92,7 +87,7 @@ export const ModalContent: React.FunctionComponent<ModalContentProps> = ({
       position={position}
       positionOffset={positionOffset}
       aria-label={ariaLabel}
-      aria-labelledby={ariaLabelledbyFormatted()}
+      aria-labelledby={getAriaLabelledBy()}
       aria-describedby={ariaDescribedby}
       {...getOUIAProps(ModalContent.displayName, ouiaId, ouiaSafe)}
       style={

diff --git a/packages/react-core/src/components/Modal/__tests__/Modal.test.tsx b/packages/react-core/src/components/Modal/__tests__/Modal.test.tsx
@@ -83,20 +83,6 @@ describe('Modal', () => {
     expect(screen.queryByRole('button', { name: 'Close' })).toBeNull();
   });
 
-  test('modal generates console error when no accessible name is provided', () => {
-    const props = {
-      onClose: jest.fn(),
-      isOpen: true,
-      children: 'modal content'
-    };
-    const consoleErrorMock = jest.fn();
-    global.console = { error: consoleErrorMock } as any;
-
-    render(<Modal {...props} />);
-
-    expect(consoleErrorMock).toHaveBeenCalled();
-  });
-
   test('modal adds aria-hidden attribute to its siblings when open', () => {
     render(<ModalWithSiblings />, { container: document.body.appendChild(target) });
 

diff --git a/packages/react-core/src/components/Modal/__tests__/__snapshots__/ModalContent.test.tsx.snap b/packages/react-core/src/components/Modal/__tests__/__snapshots__/ModalContent.test.tsx.snap
@@ -9,6 +9,7 @@ exports[`Modal Content Test description 1`] = `
       class="pf-v6-l-bullseye"
     >
       <div
+        aria-labelledby="boxId"
         aria-modal="true"
         class="pf-v6-c-modal-box"
         data-ouia-component-type="PF6/ModalContent"
@@ -34,6 +35,7 @@ exports[`Modal Content Test isOpen 1`] = `
       class="pf-v6-l-bullseye"
     >
       <div
+        aria-labelledby="boxId"
         aria-modal="true"
         class="pf-v6-c-modal-box"
         data-ouia-component-type="PF6/ModalContent"
@@ -59,6 +61,7 @@ exports[`Modal Content Test only body 1`] = `
       class="pf-v6-l-bullseye"
     >
       <div
+        aria-labelledby="boxId"
         aria-modal="true"
         class="pf-v6-c-modal-box"
         data-ouia-component-type="PF6/ModalContent"
@@ -84,6 +87,7 @@ exports[`Modal Content Test with onclose 1`] = `
       class="pf-v6-l-bullseye"
     >
       <div
+        aria-labelledby="boxId"
         aria-modal="true"
         class="pf-v6-c-modal-box pf-m-lg"
         data-ouia-component-type="PF6/ModalContent"