Rename closeButtonLabel prop

sumup-oss · Jun 22, 2021 · b23b472 · b23b472
1 parent eb2daf3
commit b23b472
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/packages/circuit-ui/components/Modal/Modal.docs.mdx b/packages/circuit-ui/components/Modal/Modal.docs.mdx
@@ -57,7 +57,7 @@ export function SayHello({ name }) {
     setModal({
       children: <Body>Hello {name}</Body>,
       variant: 'immersive',
-      labelCloseButton: 'Close modal',
+      closeButtonLabel: 'Close modal',
     });
   };
 

diff --git a/packages/circuit-ui/components/Modal/Modal.spec.tsx b/packages/circuit-ui/components/Modal/Modal.spec.tsx
@@ -21,7 +21,7 @@ describe('Modal', () => {
   const defaultModal: ModalProps = {
     variant: 'immersive',
     isOpen: true,
-    labelCloseButton: 'Close modal',
+    closeButtonLabel: 'Close modal',
     onClose: jest.fn(),
     // eslint-disable-next-line react/prop-types, react/display-name
     children: () => <p data-testid="children">Hello world!</p>,

diff --git a/packages/circuit-ui/components/Modal/Modal.tsx b/packages/circuit-ui/components/Modal/Modal.tsx
@@ -58,7 +58,7 @@ export interface ModalProps extends BaseModalProps {
    * Text label for the close button for screen readers.
    * Important for accessibility.
    */
-  labelCloseButton: string;
+  closeButtonLabel: string;
   /**
    * Allow user to close the modal by clicking/tapping the overlay or pressing
    * the escape key. Default true.
@@ -80,7 +80,7 @@ export const Modal: ModalComponent<ModalProps> = ({
   onClose,
   variant,
   dismissible = true,
-  labelCloseButton,
+  closeButtonLabel,
   tracking = {},
   className,
   ...props
@@ -206,7 +206,7 @@ export const Modal: ModalComponent<ModalProps> = ({
             {dismissible && (
               <CloseButton
                 onClick={onClose}
-                label={labelCloseButton}
+                label={closeButtonLabel}
                 css={closeButtonStyles}
               />
             )}