feat(Collapse): set a11y attributes and props

kiwicom · Jan 9, 2025 · 2e0e87e · 2e0e87e
1 parent 9c4e6b2
commit 2e0e87e
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 37 deletions.
diff --git a/packages/orbit-components/src/Collapse/Collapse.stories.tsx b/packages/orbit-components/src/Collapse/Collapse.stories.tsx
@@ -213,6 +213,12 @@ export const Uncontrolled: Story = {
   args: {
     expanded: undefined,
   },
+
+  parameters: {
+    controls: {
+      exclude: "expanded",
+    },
+  },
 };
 
 export const Rtl: Story = {

diff --git a/packages/orbit-components/src/Collapse/__tests__/index.test.tsx b/packages/orbit-components/src/Collapse/__tests__/index.test.tsx
@@ -4,10 +4,7 @@ import userEvent from "@testing-library/user-event";
 import { render, screen } from "../../test-utils";
 import Collapse from "..";
 
-const toggleButtons = [
-  [0, "label"],
-  [1, "icon button"],
-];
+const toggleTriggers = ["div", "button"];
 
 describe("Collapse", () => {
   const user = userEvent.setup();
@@ -31,27 +28,34 @@ describe("Collapse", () => {
     expect(screen.getByText("customLabel")).toBeInTheDocument();
   });
 
-  it.each(toggleButtons)("should trigger click handler when clicking on %s", async buttonIndex => {
+  it.each(toggleTriggers)("should trigger click handler when clicking on %s", async trigger => {
     const onClick = jest.fn();
     render(
       <Collapse label="Collapse" onClick={onClick}>
         <div>children</div>
       </Collapse>,
     );
-    const toggleButton = screen.getAllByRole("button", { name: "Collapse" })[buttonIndex];
+
+    const toggleButton =
+      trigger === "div" ? screen.getByText("Collapse") : screen.getByRole(trigger);
+
     await user.click(toggleButton);
     expect(onClick).toHaveBeenCalled();
   });
 
   describe("uncontrolled", () => {
-    it.each(toggleButtons)("should expand/collapse when clicking on %s", async buttonIndex => {
+    it.each(toggleTriggers)("should expand/collapse when clicking on %s", async trigger => {
       render(
         <Collapse label="Collapse">
           <article>children</article>
         </Collapse>,
       );
-      const toggleButton = screen.getAllByRole("button", { name: "Collapse" })[buttonIndex];
-      // with ByRole we can test whether the content is visible because of aria-hidden
+
+      const toggleButton =
+        // We need to distinguish between div and button on the next line
+        // eslint-disable-next-line jest/no-if
+        trigger === "div" ? screen.getByText("Collapse") : screen.getByRole("button");
+
       expect(screen.queryByRole("article")).not.toBeInTheDocument();
       await user.click(toggleButton);
       expect(screen.getByRole("article")).toBeInTheDocument();

diff --git a/packages/orbit-components/src/Collapse/index.tsx b/packages/orbit-components/src/Collapse/index.tsx
@@ -64,36 +64,39 @@ const Collapse = ({
       data-test={dataTest}
       id={id}
     >
-      {/* eslint-disable-next-line jsx-a11y/click-events-have-key-events */}
-      <div
-        className="block w-full cursor-pointer"
-        onClick={handleClick}
-        role="button"
-        tabIndex={-1}
-        id={labelID}
-      >
-        <Stack justify="between" align="center">
-          {label && !customLabel && <Heading type="title4">{label}</Heading>}
-          {customLabel}
-          <Stack inline grow={false} align="center" spacing="300">
-            {/* eslint-disable-next-line jsx-a11y/click-events-have-key-events, jsx-a11y/no-static-element-interactions */}
-            <div
-              className="flex items-center"
-              onClick={ev => {
-                ev.stopPropagation();
-              }}
-            >
+      <div className="flex items-center justify-between">
+        <div
+          className="flex w-full cursor-pointer self-stretch"
+          id={labelID}
+          role="button"
+          tabIndex={0}
+          onClick={handleClick}
+          onKeyDown={e => {
+            if (e.key === "Enter" || e.key === " ") {
+              handleClick(e);
+            }
+          }}
+        >
+          <Stack justify="between" align="center">
+            {label && !customLabel && <Heading type="title4">{label}</Heading>}
+            {customLabel}
+          </Stack>
+        </div>
+        <Stack inline grow={false} align="center" spacing="none">
+          {actions && (
+            <div aria-labelledby={labelID} className="mx-300 flex items-center">
               {actions}
             </div>
-            <ButtonLink
-              iconLeft={<AnimatedIcon expanded={expanded} />}
-              size="small"
-              type="secondary"
-              ariaLabelledby={labelID}
-              ariaExpanded={expanded}
-              ariaControls={slideID}
-            />
-          </Stack>
+          )}
+          <ButtonLink
+            iconLeft={<AnimatedIcon expanded={expanded} />}
+            size="small"
+            type="secondary"
+            onClick={handleClick}
+            ariaLabelledby={labelID}
+            ariaExpanded={expanded}
+            ariaControls={slideID}
+          />
         </Stack>
       </div>
       <Slide maxHeight={height} expanded={expanded} id={slideID} ariaLabelledBy={labelID}>