@dxc-technology/halstack-react 0.0.0-8b133ff → 0.0.0-8b61ced

package/checkbox/Checkbox.stories.tsx

@@ -4,7 +4,7 @@ import { BackgroundColorProvider } from "../BackgroundColorContext";
 import Title from "../../.storybook/components/Title";
 import ExampleContainer from "../../.storybook/components/ExampleContainer";
 import DarkContainer from "../../.storybook/components/DarkSection";
-import { userEvent } from "@storybook/testing-library";
+import styled from "styled-components";
 
 export default {
   title: "Checkbox",
@@ -17,29 +17,33 @@ const Checkbox = () => (
       <Title title="Default" theme="light" level={4} />
       <DxcCheckbox label="Checkbox" />
     </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Focused" theme="light" level={4} />
-      <DxcCheckbox label="Focused" />
-    </ExampleContainer>
     <ExampleContainer>
       <Title title="Checked" theme="light" level={4} />
       <DxcCheckbox label="Checkbox" defaultChecked />
     </ExampleContainer>
     <ExampleContainer>
-      <Title title="Optional" theme="light" level={4} />
-      <DxcCheckbox label="Checkbox" optional />
+      <Title title="Disabled" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" disabled />
     </ExampleContainer>
     <ExampleContainer>
-      <Title title="Disabled and checked" theme="light" level={4} />
-      <DxcCheckbox label="Checkbox" disabled defaultChecked />
+      <Title title="Disabled, checked and optional" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" disabled defaultChecked optional />
     </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Disabled and optional" theme="light" level={4} />
-      <DxcCheckbox label="Checkbox" disabled optional />
+    <ExampleContainer pseudoState="pseudo-focus">
+      <Title title="Focused" theme="light" level={4} />
+      <DxcCheckbox label="Focused" />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered" theme="light" level={4} />
+      <DxcCheckbox label="Hovered" />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered and checked" theme="light" level={4} />
+      <DxcCheckbox label="Hovered" defaultChecked />
     </ExampleContainer>
     <ExampleContainer>
-      <Title title="Disabled, optional and checked" theme="light" level={4} />
-      <DxcCheckbox label="Checkbox" disabled optional defaultChecked />
+      <Title title="Optional" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" optional />
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Label after" theme="light" level={4} />
@@ -53,25 +57,9 @@ const Checkbox = () => (
       <Title title="Optional with label after" theme="light" level={4} />
       <DxcCheckbox label="Checkbox" optional labelPosition="after" />
     </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Disabled and checked with label after" theme="light" level={4} />
-      <DxcCheckbox label="Checkbox" disabled defaultChecked labelPosition="after" />
-    </ExampleContainer>
     <ExampleContainer>
       <Title title="Disabled and optional with label after" theme="light" level={4} />
-      <DxcCheckbox label="Checkbox" disabled optional labelPosition="after" />
-    </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Disabled, optional and checked with label after" theme="light" level={4} />
-      <DxcCheckbox label="Checkbox" disabled optional defaultChecked labelPosition="after" />
-    </ExampleContainer>
-    <ExampleContainer pseudoState="pseudo-hover">
-      <Title title="Hovered" theme="light" level={4} />
-      <DxcCheckbox label="Hovered" />
-    </ExampleContainer>
-    <ExampleContainer pseudoState="pseudo-hover">
-      <Title title="Hovered and checked" theme="light" level={4} />
-      <DxcCheckbox label="Hovered" defaultChecked />
+      <DxcCheckbox label="Checkbox" disabled labelPosition="after" optional />
     </ExampleContainer>
     <BackgroundColorProvider color="#333333">
       <DarkContainer>
@@ -84,20 +72,28 @@ const Checkbox = () => (
           <DxcCheckbox label="Checkbox" defaultChecked />
         </ExampleContainer>
         <ExampleContainer>
-          <Title title="Optional" theme="dark" level={4} />
-          <DxcCheckbox label="Checkbox" optional />
+          <Title title="Disabled" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" disabled />
         </ExampleContainer>
         <ExampleContainer>
-          <Title title="Disabled and checked" theme="dark" level={4} />
-          <DxcCheckbox label="Checkbox" disabled defaultChecked />
+          <Title title="Disabled, checked and optional" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" disabled defaultChecked optional />
         </ExampleContainer>
-        <ExampleContainer>
-          <Title title="Disabled and optional" theme="dark" level={4} />
-          <DxcCheckbox label="Checkbox" disabled optional />
+        <ExampleContainer pseudoState="pseudo-focus">
+          <Title title="Focused" theme="dark" level={4} />
+          <DxcCheckbox label="Focused" />
+        </ExampleContainer>
+        <ExampleContainer pseudoState="pseudo-hover">
+          <Title title="Hovered" theme="dark" level={4} />
+          <DxcCheckbox label="Hovered" />
+        </ExampleContainer>
+        <ExampleContainer pseudoState="pseudo-hover">
+          <Title title="Hovered and checked" theme="dark" level={4} />
+          <DxcCheckbox label="Hovered" defaultChecked />
         </ExampleContainer>
         <ExampleContainer>
-          <Title title="Disabled, optional and checked" theme="dark" level={4} />
-          <DxcCheckbox label="Checkbox" disabled optional defaultChecked />
+          <Title title="Optional" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" optional />
         </ExampleContainer>
         <ExampleContainer>
           <Title title="Label after" theme="dark" level={4} />
@@ -111,25 +107,9 @@ const Checkbox = () => (
           <Title title="Optional with label after" theme="dark" level={4} />
           <DxcCheckbox label="Checkbox" optional labelPosition="after" />
         </ExampleContainer>
-        <ExampleContainer>
-          <Title title="Disabled and checked with label after" theme="dark" level={4} />
-          <DxcCheckbox label="Checkbox" disabled defaultChecked labelPosition="after" />
-        </ExampleContainer>
         <ExampleContainer>
           <Title title="Disabled and optional with label after" theme="dark" level={4} />
-          <DxcCheckbox label="Checkbox" disabled optional labelPosition="after" />
-        </ExampleContainer>
-        <ExampleContainer>
-          <Title title="Disabled, optional and checked with label after" theme="dark" level={4} />
-          <DxcCheckbox label="Checkbox" disabled optional defaultChecked labelPosition="after" />
-        </ExampleContainer>
-        <ExampleContainer pseudoState="pseudo-hover">
-          <Title title="Hovered" theme="dark" level={4} />
-          <DxcCheckbox label="Hovered" />
-        </ExampleContainer>
-        <ExampleContainer pseudoState="pseudo-hover">
-          <Title title="Hovered and checked" theme="dark" level={4} />
-          <DxcCheckbox label="Hovered" defaultChecked />
+          <DxcCheckbox label="Checkbox" disabled labelPosition="after" optional />
         </ExampleContainer>
       </DarkContainer>
     </BackgroundColorProvider>
@@ -178,11 +158,51 @@ const Checkbox = () => (
       <Title title="Xxlarge" theme="light" level={4} />
       <DxcCheckbox label="Xxlarge" margin="xxlarge" />
     </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Overflow container" theme="light" level={4} />
+      <ScrollableContainer id="scroll-container">
+        <DxcCheckbox label="Checkbox" defaultChecked />
+        <DxcCheckbox label="Checkbox" defaultChecked />
+        <DxcCheckbox label="Checkbox" />
+        <DxcCheckbox label="Checkbox" defaultChecked />
+        <DxcCheckbox label="Checkbox" />
+        <DxcCheckbox label="Checkbox" />
+        <DxcCheckbox label="Checkbox" />
+        <DxcCheckbox label="Checkbox" defaultChecked />
+      </ScrollableContainer>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Label overflow" theme="light" level={4} />
+      <SmallContainer>
+        <DxcCheckbox label="Very long label to check its overflowing" defaultChecked />
+        <DxcCheckbox label="Very long label to check its overflowing" labelPosition="after" />
+      </SmallContainer>
+    </ExampleContainer>
   </>
 );
 
 export const Chromatic = Checkbox.bind({});
+
 Chromatic.play = async () => {
-  await userEvent.tab();
-  await userEvent.tab();
+  const listEl = document.getElementById("scroll-container");
+  listEl?.scrollTo?.({ top: 50 });
 };
+
+const ScrollableContainer = styled.div`
+  display: flex;
+  flex-direction: column;
+  gap: 14px;
+  width: 200px;
+  height: 200px;
+  border: 1px solid #000;
+  padding: 14px;
+  overflow: auto;
+`;
+
+const SmallContainer = styled.div`
+  display: flex;
+  flex-direction: column;
+  gap: 14px;
+  width: 150px;
+  height: 150px;
+`;

package/checkbox/Checkbox.test.js

@@ -6,25 +6,39 @@ var _react = _interopRequireDefault(require("react"));
 
 var _react2 = require("@testing-library/react");
 
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+
 var _Checkbox = _interopRequireDefault(require("./Checkbox"));
 
 describe("Checkbox component tests", function () {
-  test("Checkbox renders with correct text", function () {
+  test("Checkbox renders with correct aria-labelledby and aria-required", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
       label: "Checkbox"
     })),
-        getByText = _render.getByText;
+        getByText = _render.getByText,
+        getByRole = _render.getByRole;
 
-    expect(getByText("Checkbox")).toBeTruthy();
+    var labelId = getByText("Checkbox").getAttribute("id");
+    expect(getByRole("checkbox").getAttribute("aria-labelledby")).toBe(labelId);
+    expect(getByRole("checkbox").getAttribute("aria-required")).toBe("true");
+  });
+  test("Optional checkbox renders with correct aria-required", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox",
+      optional: true
+    })),
+        getByRole = _render2.getByRole;
+
+    expect(getByRole("checkbox").getAttribute("aria-required")).toBe("false");
   });
   test("Calls correct function on click", function () {
     var onChange = jest.fn();
 
-    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
       label: "Checkbox",
       onChange: onChange
     })),
-        getByText = _render2.getByText;
+        getByText = _render3.getByText;
 
     _react2.fireEvent.click(getByText("Checkbox"));
 
@@ -34,45 +48,108 @@ describe("Checkbox component tests", function () {
     var onChange = jest.fn();
     var component = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
       label: "Checkbox",
-      onChange: onChange
+      onChange: onChange,
+      name: "test"
     }));
     var visibleCheckbox = component.getByText("Checkbox");
     var input = component.getByRole("checkbox");
-    expect(input.checked).toBe(false);
+    var submitInput = component.container.querySelector("input[name=\"test\"]");
+    expect(input.getAttribute("aria-checked")).toBe("false");
+    expect(submitInput.checked).toBe(false);
 
     _react2.fireEvent.click(visibleCheckbox);
 
     expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith(true);
-    expect(input.checked).toBe(true);
+    expect(input.getAttribute("aria-checked")).toBe("true");
+    expect(submitInput.checked).toBe(true);
   });
   test("Controlled checkbox", function () {
     var onChange = jest.fn();
     var component = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
       label: "Checkbox",
       checked: false,
-      onChange: onChange
+      onChange: onChange,
+      name: "test"
     }));
     var input = component.getByRole("checkbox");
     var visibleCheckbox = component.getByText("Checkbox");
+    var submitInput = component.container.querySelector("input[name=\"test\"]");
 
     _react2.fireEvent.click(visibleCheckbox);
 
     expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith(true);
-    expect(input.checked).toBe(false);
+    expect(input.getAttribute("aria-checked")).toBe("false");
+    expect(submitInput.checked).toBe(false);
   });
   test("Renders with correct initial value and initial state when it is uncontrolled", function () {
-    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
       label: "Default label",
       defaultChecked: true,
-      value: "test-defaultChecked"
+      value: "test-defaultChecked",
+      name: "test"
+    })),
+        getByRole = _render4.getByRole,
+        container = _render4.container;
+
+    var checkbox = getByRole("checkbox");
+    var submitInput = container.querySelector("input[name=\"test\"]");
+    expect(submitInput.value).toBe("test-defaultChecked");
+    expect(checkbox.getAttribute("aria-checked")).toBe("true");
+    expect(submitInput.checked).toBe(true);
+  });
+  test("Test disable keyboard and mouse interactions", function () {
+    var onChange = jest.fn();
+
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox",
+      onChange: onChange,
+      disabled: true,
+      name: "test"
     })),
-        getByRole = _render3.getByRole;
+        getByRole = _render5.getByRole,
+        getByText = _render5.getByText,
+        container = _render5.container;
 
     var input = getByRole("checkbox");
-    expect(input.checked).toBe(true);
-    expect(input.value).toBe("test-defaultChecked");
-    expect(input.getAttribute("aria-checked")).toBe("true");
+    var visibleCheckbox = getByText("Checkbox");
+    var submitInput = container.querySelector("input[name=\"test\"]");
+
+    _react2.fireEvent.click(visibleCheckbox);
+
+    expect(onChange).toHaveBeenCalledTimes(0);
+    expect(input.getAttribute("aria-checked")).toBe("false");
+    expect(input.getAttribute("aria-disabled")).toBe("true");
+    expect(submitInput.checked).toBe(false);
+
+    _userEvent["default"].tab();
+
+    expect(document.activeElement === input).toBeFalsy();
+  });
+  test("Test keyboard interactions", function () {
+    var onChange = jest.fn();
+
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox",
+      name: "test",
+      onChange: onChange
+    })),
+        getByRole = _render6.getByRole;
+
+    var checkbox = getByRole("checkbox");
+
+    _userEvent["default"].tab();
+
+    expect(document.activeElement === checkbox).toBeTruthy();
+
+    _react2.fireEvent.keyDown(checkbox, {
+      key: " ",
+      code: "Space",
+      keyCode: 32,
+      charCode: 32
+    });
+
+    expect(onChange).toHaveBeenCalledWith(true);
   });
 });

package/checkbox/types.d.ts

@@ -1,5 +1,5 @@
-declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-declare type Margin = {
+export declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+export declare type Margin = {
     top?: Space;
     bottom?: Space;
     left?: Space;
@@ -61,4 +61,8 @@ declare type Props = {
      */
     tabIndex?: number;
 };
+/**
+ * Reference to the component.
+ */
+export declare type RefType = HTMLDivElement;
 export default Props;

package/chip/types.d.ts

@@ -6,7 +6,7 @@ declare type Margin = {
     left?: Space;
     right?: Space;
 };
-declare type SVG = React.SVGProps<SVGSVGElement>;
+declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
 declare type Props = {
     /**
      * Text to be placed on the chip.