@dxc-technology/halstack-react 0.0.0-b3e1a2f → 0.0.0-b3e2de9

package/checkbox/Checkbox.stories.tsx

@@ -1,142 +1,89 @@
 import React from "react";
 import DxcCheckbox from "./Checkbox";
-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 styled from "styled-components";
+import { HalstackProvider } from "../HalstackContext";
 
 export default {
   title: "Checkbox",
   component: DxcCheckbox,
 };
 
+const opinionatedTheme = {
+  checkbox: {
+    baseColor: "#0067b3",
+    checkColor: "#ffffff",
+    fontColor: "#000000",
+  },
+};
+
 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>
-    </>
-    <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>
-        </>
-      </DarkContainer>
-    </BackgroundColorProvider>
+    <ExampleContainer>
+      <Title title="Default" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Checked" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" defaultChecked />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" disabled />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled, checked and optional" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" disabled defaultChecked optional />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Read-only" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" readOnly />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered read-only" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" readOnly />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Read-only, checked and optional" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" readOnly defaultChecked optional />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered read-only and checked" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" readOnly defaultChecked optional />
+    </ExampleContainer>
+    <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="Optional" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" optional />
+    </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 optional with label after" theme="light" level={4} />
+      <DxcCheckbox label="Checkbox" disabled labelPosition="after" optional />
+    </ExampleContainer>
     <Title title="Sizes" theme="light" level={2} />
     <ExampleContainer>
       <DxcCheckbox label="Small" size="small" />
@@ -156,37 +103,120 @@ 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>
+    <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>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Default" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcCheckbox label="Checkbox" />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Checked" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcCheckbox label="Checkbox" defaultChecked />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcCheckbox label="Checkbox" disabled />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled checked" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcCheckbox label="Checkbox" defaultChecked disabled />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-focus">
+      <Title title="Focused" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcCheckbox label="Focused" />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcCheckbox label="Hovered" />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered and checked" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcCheckbox label="Hovered" defaultChecked />
+      </HalstackProvider>
     </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

@@ -0,0 +1,199 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+var _Checkbox = _interopRequireDefault(require("./Checkbox.tsx"));
+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");
+    expect(getByRole("checkbox").getAttribute("aria-readonly")).toBe("false");
+    expect(getByRole("checkbox").getAttribute("aria-disabled")).toBe("false");
+  });
+  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 onChange", 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("Read-only checkbox does not trigger onChange function", function () {
+    var onChange = jest.fn();
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Checkbox",
+        onChange: onChange,
+        readOnly: true
+      })),
+      getByRole = _render4.getByRole;
+    var checkbox = getByRole("checkbox");
+    expect(checkbox.getAttribute("aria-readonly")).toBe("true");
+    _react2.fireEvent.click(checkbox);
+    expect(onChange).not.toHaveBeenCalled();
+  });
+  test("Read-only checkbox sends its value on submit", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var handlerOnSubmit, _render5, getByText, submit;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          handlerOnSubmit = jest.fn(function (e) {
+            e.preventDefault();
+            var formData = new FormData(e.target);
+            var formProps = Object.fromEntries(formData);
+            expect(formProps).toStrictEqual({
+              data: "checked"
+            });
+          });
+          _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement("form", {
+            onSubmit: handlerOnSubmit
+          }, /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+            label: "Checkbox",
+            name: "data",
+            value: "checked",
+            readOnly: true,
+            defaultChecked: true
+          }), /*#__PURE__*/_react["default"].createElement("button", {
+            type: "submit"
+          }, "Submit"))), getByText = _render5.getByText;
+          submit = getByText("Submit");
+          _context.next = 5;
+          return _userEvent["default"].click(submit);
+        case 5:
+          expect(handlerOnSubmit).toHaveBeenCalled();
+        case 6:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+  test("Read-only checkbox doesn't change its value with Space key", function () {
+    var onChange = jest.fn();
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Checkbox",
+        onChange: onChange,
+        readOnly: true
+      })),
+      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).not.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 _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Default label",
+        defaultChecked: true,
+        value: "test-defaultChecked",
+        name: "test"
+      })),
+      getByRole = _render7.getByRole,
+      container = _render7.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 _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Checkbox",
+        onChange: onChange,
+        disabled: true,
+        name: "test"
+      })),
+      getByRole = _render8.getByRole,
+      getByText = _render8.getByText,
+      container = _render8.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 _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Checkbox",
+        name: "test",
+        onChange: onChange
+      })),
+      getByRole = _render9.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 = {
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
     top?: Space;
     bottom?: Space;
     left?: Space;
     right?: Space;
 };
-declare type Props = {
+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.
@@ -33,14 +37,18 @@ 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.
+     */
+    optional?: boolean;
+    /**
+     * If true, the component will not be mutable, meaning the user can not edit the control.
      */
-    required?: boolean;
+    readOnly?: 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').
@@ -57,4 +65,8 @@ declare type Props = {
      */
     tabIndex?: number;
 };
+/**
+ * Reference to the component.
+ */
+export type RefType = HTMLDivElement;
 export default Props;