From ae746946f79bd17e99c5458d070b6b10561b8483 Mon Sep 17 00:00:00 2001
From: Omar Babativa <obabativa@vmware.com>
Date: Fri, 8 Jul 2022 15:59:33 -0500
Subject: [PATCH] Include aria label for copy button

Signed-off-by: Omar Babativa <obabativa@vmware.com>
---
 .changeset/tender-cycles-shout.md                 |  5 +++++
 .../CopyTextButton/CopyTextButton.stories.tsx     |  7 +++++++
 .../CopyTextButton/CopyTextButton.test.tsx        | 12 +++++++++++-
 .../components/CopyTextButton/CopyTextButton.tsx  | 15 ++++++++++++---
 4 files changed, 35 insertions(+), 4 deletions(-)
 create mode 100644 .changeset/tender-cycles-shout.md

diff --git a/.changeset/tender-cycles-shout.md b/.changeset/tender-cycles-shout.md
new file mode 100644
index 0000000000..aca42f18c7
--- /dev/null
+++ b/.changeset/tender-cycles-shout.md
@@ -0,0 +1,5 @@
+---
+'@backstage/core-components': minor
+---
+
+Improve accessibility for CopyTextButton
diff --git a/packages/core-components/src/components/CopyTextButton/CopyTextButton.stories.tsx b/packages/core-components/src/components/CopyTextButton/CopyTextButton.stories.tsx
index c1834091b5..ac56ad0e30 100644
--- a/packages/core-components/src/components/CopyTextButton/CopyTextButton.stories.tsx
+++ b/packages/core-components/src/components/CopyTextButton/CopyTextButton.stories.tsx
@@ -40,3 +40,10 @@ export const LongerTooltipDelay = () => (
     tooltipDelay={3000}
   />
 );
+
+export const WithAriaLabel = () => (
+  <CopyTextButton
+    text="The text to copy to clipboard"
+    ariaLabel="This is an aria label"
+  />
+);
diff --git a/packages/core-components/src/components/CopyTextButton/CopyTextButton.test.tsx b/packages/core-components/src/components/CopyTextButton/CopyTextButton.test.tsx
index 462bfb36cb..14e5d54cb7 100644
--- a/packages/core-components/src/components/CopyTextButton/CopyTextButton.test.tsx
+++ b/packages/core-components/src/components/CopyTextButton/CopyTextButton.test.tsx
@@ -55,13 +55,14 @@ const apis = [[errorApiRef, mockErrorApi] as const] as const;
 
 describe('<CopyTextButton />', () => {
   it('renders without exploding', async () => {
-    const { getByTitle, queryByText } = await renderInTestApp(
+    const { getByTitle, queryByText, getByLabelText } = await renderInTestApp(
       <TestApiProvider apis={apis}>
         <CopyTextButton {...props} />
       </TestApiProvider>,
     );
     expect(getByTitle('mockTooltip')).toBeInTheDocument();
     expect(queryByText('mockTooltip')).not.toBeInTheDocument();
+    expect(getByLabelText('Copy text')).toBeInTheDocument();
   });
 
   it('displays tooltip and copy the text on click', async () => {
@@ -99,4 +100,13 @@ describe('<CopyTextButton />', () => {
     );
     expect(mockErrorApi.post).toHaveBeenCalledWith(error);
   });
+
+  it('aria-label', async () => {
+    const { getByLabelText } = await renderInTestApp(
+      <TestApiProvider apis={apis}>
+        <CopyTextButton {...props} ariaLabel="text for aria-label" />
+      </TestApiProvider>,
+    );
+    expect(getByLabelText('text for aria-label')).toBeInTheDocument();
+  });
 });
diff --git a/packages/core-components/src/components/CopyTextButton/CopyTextButton.tsx b/packages/core-components/src/components/CopyTextButton/CopyTextButton.tsx
index 670c21f10c..485c389b5d 100644
--- a/packages/core-components/src/components/CopyTextButton/CopyTextButton.tsx
+++ b/packages/core-components/src/components/CopyTextButton/CopyTextButton.tsx
@@ -49,6 +49,10 @@ export interface CopyTextButtonProps {
   tooltipText?: string;
 }
 
+type LabelledCopyTextButtonProps = CopyTextButtonProps & {
+  ariaLabel?: string;
+};
+
 /**
  * Copy text button with visual feedback
  *
@@ -62,13 +66,18 @@ export interface CopyTextButtonProps {
  *
  * @example
  *
- * `<CopyTextButton text="My text that I want to be copied to the clipboard" />`
+ * ```
+ * <CopyTextButton
+ *   text="My text that I want to be copied to the clipboard"
+ *   ariaLabel="Accessible label for this button" />
+ * ```
  */
-export function CopyTextButton(props: CopyTextButtonProps) {
+export function CopyTextButton(props: LabelledCopyTextButtonProps) {
   const {
     text,
     tooltipDelay = 1000,
     tooltipText = 'Text copied to clipboard',
+    ariaLabel = 'Copy text',
   } = props;
   const errorApi = useApi(errorApiRef);
   const [open, setOpen] = useState(false);
@@ -96,7 +105,7 @@ export function CopyTextButton(props: CopyTextButtonProps) {
         onClose={() => setOpen(false)}
         open={open}
       >
-        <IconButton onClick={handleCopyClick}>
+        <IconButton onClick={handleCopyClick} aria-label={ariaLabel}>
           <CopyIcon />
         </IconButton>
       </Tooltip>