@dxc-technology/halstack-react 0.0.0-b9523dd → 0.0.0-b98c25c

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, within } from "@storybook/testing-library";
+import { userEvent } from "@storybook/testing-library";
 
 export default {
   title: "Checkbox",
@@ -13,128 +13,124 @@ export default {
 
 const Checkbox = () => (
   <>
-    <>
-      <ExampleContainer>
-        <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" checked />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Required" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" required />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Disabled and checked" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" disabled checked />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Disabled and required" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" disabled required />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Disabled, required and checked" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" disabled required checked />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Label after" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" labelPosition="after" />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Checked with label after" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" checked labelPosition="after" />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Required with label after" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" required labelPosition="after" />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Disabled and checked with label after" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" disabled checked labelPosition="after" />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Disabled and required with label after" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" disabled required labelPosition="after" />
-      </ExampleContainer>
-      <ExampleContainer>
-        <Title title="Disabled, required and checked with label after" theme="light" level={4} />
-        <DxcCheckbox label="Checkbox" disabled required checked 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" checked />
-      </ExampleContainer>
-    </>
+    <ExampleContainer>
+      <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 />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled and checked" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" disabled defaultChecked />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled and optional" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" disabled optional />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled, optional and checked" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" disabled optional defaultChecked />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Label after" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" labelPosition="after" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Checked with label after" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" defaultChecked labelPosition="after" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <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 />
+    </ExampleContainer>
     <BackgroundColorProvider color="#333333">
       <DarkContainer>
-        <>
-          <ExampleContainer>
-            <Title title="Default" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Checked" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" checked />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Required" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" required />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Disabled and checked" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" disabled checked />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Disabled and required" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" disabled required />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Disabled, required and checked" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" disabled required checked />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Label after" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" labelPosition="after" />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Checked with label after" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" checked labelPosition="after" />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Required with label after" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" required labelPosition="after" />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Disabled and checked with label after" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" disabled checked labelPosition="after" />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Disabled and required with label after" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" disabled required labelPosition="after" />
-          </ExampleContainer>
-          <ExampleContainer>
-            <Title title="Disabled, required and checked with label after" theme="dark" level={4} />
-            <DxcCheckbox label="Checkbox" disabled required checked 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" checked />
-          </ExampleContainer>
-        </>
+        <ExampleContainer>
+          <Title title="Default" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Checked" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" defaultChecked />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Optional" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" optional />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled and checked" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" disabled defaultChecked />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled and optional" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" disabled optional />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled, optional and checked" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" disabled optional defaultChecked />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Label after" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" labelPosition="after" />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Checked with label after" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" defaultChecked labelPosition="after" />
+        </ExampleContainer>
+        <ExampleContainer>
+          <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 />
+        </ExampleContainer>
       </DarkContainer>
     </BackgroundColorProvider>
     <Title title="Sizes" theme="light" level={2} />
@@ -156,31 +152,31 @@ const Checkbox = () => (
     <Title title="Margins" theme="light" level={2} />
     <ExampleContainer>
       <Title title="Xxsmall" theme="light" level={4} />
-      <DxcCheckbox label="Xxsmall" margin={"xxsmall"} />
+      <DxcCheckbox label="Xxsmall" margin="xxsmall" />
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Xsmall" theme="light" level={4} />
-      <DxcCheckbox label="Xsmall" margin={"xsmall"} />
+      <DxcCheckbox label="Xsmall" margin="xsmall" />
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Small" theme="light" level={4} />
-      <DxcCheckbox label="Small" margin={"small"} />
+      <DxcCheckbox label="Small" margin="small" />
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Medium" theme="light" level={4} />
-      <DxcCheckbox label="Medium" margin={"medium"} />
+      <DxcCheckbox label="Medium" margin="medium" />
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Large" theme="light" level={4} />
-      <DxcCheckbox label="Large" margin={"large"} />
+      <DxcCheckbox label="Large" margin="large" />
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Xlarge" theme="light" level={4} />
-      <DxcCheckbox label="Xlarge" margin={"xlarge"} />
+      <DxcCheckbox label="Xlarge" margin="xlarge" />
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Xxlarge" theme="light" level={4} />
-      <DxcCheckbox label="Xxlarge" margin={"xxlarge"} />
+      <DxcCheckbox label="Xxlarge" margin="xxlarge" />
     </ExampleContainer>
   </>
 );

package/checkbox/Checkbox.test.js

@@ -0,0 +1,155 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+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 aria-labelledby and aria-required", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox"
+    })),
+        getByText = _render.getByText,
+        getByRole = _render.getByRole;
+
+    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 _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox",
+      onChange: onChange
+    })),
+        getByText = _render3.getByText;
+
+    _react2.fireEvent.click(getByText("Checkbox"));
+
+    expect(onChange).toHaveBeenCalled();
+  });
+  test("Uncontrolled checkbox", function () {
+    var onChange = jest.fn();
+    var component = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox",
+      onChange: onChange,
+      name: "test"
+    }));
+    var visibleCheckbox = component.getByText("Checkbox");
+    var input = component.getByRole("checkbox");
+    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.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,
+      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.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 _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Default label",
+      defaultChecked: true,
+      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 = _render5.getByRole,
+        getByText = _render5.getByText,
+        container = _render5.container;
+
+    var input = getByRole("checkbox");
+    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,11 +1,15 @@
-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;
     right?: Space;
 };
 declare type Props = {
+    /**
+     * Initial state of the checkbox, only when it is uncontrolled.
+     */
+    defaultChecked?: boolean;
     /**
      * If true, the component is checked. If undefined the component will be
      * uncontrolled and the value will be managed internally by the component.
@@ -19,7 +23,7 @@ declare type Props = {
     /**
      * Text to be placed next to the checkbox.
      */
-    label: string;
+    label?: string;
     /**
      * Whether the label should appear after or before the checkbox.
      */
@@ -33,14 +37,14 @@ declare type Props = {
      */
     disabled?: boolean;
     /**
-     * If true, the checkbox will change its appearence, showing that the value is required.
+     * If true, the component will display '(Optional)' next to the label.
      */
-    required?: boolean;
+    optional?: boolean;
     /**
      * This function will be called when the user clicks the checkbox.
      * The new value will be passed as a parameter.
      */
-    onChange?: (val: boolean) => void;
+    onChange?: (value: boolean) => void;
     /**
      * Size of the margin to be applied to the component
      * ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
@@ -49,7 +53,7 @@ declare type Props = {
      */
     margin?: Space | Margin;
     /**
-     * Size of the component ('small' | 'medium' | 'large' | 'fillParent' | 'fitContent').
+     * Size of the component.
      */
     size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
     /**

package/chip/Chip.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import ChipPropsType from "./types";
+declare const DxcChip: ({ label, suffixIcon, prefixIcon, onClickSuffix, onClickPrefix, disabled, margin, tabIndex, }: ChipPropsType) => JSX.Element;
+export default DxcChip;