From b23b472d86dbf6cd24cb82880b90ddc0125f7e2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Connor=20B=C3=A4r?= Date: Tue, 22 Jun 2021 17:23:32 +0200 Subject: [PATCH] Rename closeButtonLabel prop --- packages/circuit-ui/components/Modal/Modal.docs.mdx | 2 +- packages/circuit-ui/components/Modal/Modal.spec.tsx | 2 +- packages/circuit-ui/components/Modal/Modal.tsx | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/circuit-ui/components/Modal/Modal.docs.mdx b/packages/circuit-ui/components/Modal/Modal.docs.mdx index 9650ca8aba..f295cef0e4 100644 --- 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: Hello {name}, 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 index 6e310d1719..73a58ee0df 100644 --- 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: () =>

Hello world!

, diff --git a/packages/circuit-ui/components/Modal/Modal.tsx b/packages/circuit-ui/components/Modal/Modal.tsx index d8eec79ea5..b04ad797e4 100644 --- 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 = ({ onClose, variant, dismissible = true, - labelCloseButton, + closeButtonLabel, tracking = {}, className, ...props @@ -206,7 +206,7 @@ export const Modal: ModalComponent = ({ {dismissible && ( )}