@dxc-technology/halstack-react 0.0.0-9b341c0 → 0.0.0-9bd9511

package/checkbox/Checkbox.js

@@ -0,0 +1,206 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof3 = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = _interopRequireWildcard(require("react"));
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+var _variables = require("../common/variables");
+var _utils = require("../common/utils.js");
+var _uuid = require("uuid");
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+var _useTranslatedLabels = _interopRequireDefault(require("../useTranslatedLabels"));
+var _BackgroundColorContext = _interopRequireDefault(require("../BackgroundColorContext"));
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof3(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var checkedIcon = /*#__PURE__*/_react["default"].createElement("svg", {
+  fill: "currentColor",
+  focusable: "false",
+  "aria-hidden": "true",
+  viewBox: "0 0 24 24"
+}, /*#__PURE__*/_react["default"].createElement("path", {
+  d: "M19 3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.11 0 2-.9 2-2V5c0-1.1-.89-2-2-2zm-9 14-5-5 1.41-1.41L10 14.17l7.59-7.59L19 8l-9 9z"
+}));
+var DxcCheckbox = /*#__PURE__*/_react["default"].forwardRef(function (_ref, ref) {
+  var checked = _ref.checked,
+    _ref$defaultChecked = _ref.defaultChecked,
+    defaultChecked = _ref$defaultChecked === void 0 ? false : _ref$defaultChecked,
+    value = _ref.value,
+    _ref$label = _ref.label,
+    label = _ref$label === void 0 ? "" : _ref$label,
+    _ref$labelPosition = _ref.labelPosition,
+    labelPosition = _ref$labelPosition === void 0 ? "before" : _ref$labelPosition,
+    _ref$name = _ref.name,
+    name = _ref$name === void 0 ? "" : _ref$name,
+    _ref$disabled = _ref.disabled,
+    disabled = _ref$disabled === void 0 ? false : _ref$disabled,
+    _ref$optional = _ref.optional,
+    optional = _ref$optional === void 0 ? false : _ref$optional,
+    onChange = _ref.onChange,
+    margin = _ref.margin,
+    _ref$size = _ref.size,
+    size = _ref$size === void 0 ? "fitContent" : _ref$size,
+    _ref$tabIndex = _ref.tabIndex,
+    tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
+  var _useState = (0, _react.useState)("label-checkbox-".concat((0, _uuid.v4)())),
+    _useState2 = (0, _slicedToArray2["default"])(_useState, 1),
+    labelId = _useState2[0];
+  var _useState3 = (0, _react.useState)(defaultChecked),
+    _useState4 = (0, _slicedToArray2["default"])(_useState3, 2),
+    innerChecked = _useState4[0],
+    setInnerChecked = _useState4[1];
+  var checkboxRef = (0, _react.useRef)(null);
+  var colorsTheme = (0, _useTheme["default"])();
+  var backgroundType = (0, _react.useContext)(_BackgroundColorContext["default"]);
+  var translatedLabels = (0, _useTranslatedLabels["default"])();
+  var handleCheckboxChange = function handleCheckboxChange() {
+    var _checkboxRef$current;
+    document.activeElement !== (checkboxRef === null || checkboxRef === void 0 ? void 0 : checkboxRef.current) && (checkboxRef === null || checkboxRef === void 0 ? void 0 : (_checkboxRef$current = checkboxRef.current) === null || _checkboxRef$current === void 0 ? void 0 : _checkboxRef$current.focus());
+    var newChecked = checked !== null && checked !== void 0 ? checked : innerChecked;
+    checked !== null && checked !== void 0 ? checked : setInnerChecked(function (innerChecked) {
+      return !innerChecked;
+    });
+    onChange === null || onChange === void 0 ? void 0 : onChange(!newChecked);
+  };
+  var handleKeyboard = function handleKeyboard(event) {
+    switch (event.key) {
+      case " ":
+        event.preventDefault();
+        handleCheckboxChange();
+    }
+  };
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme["checkbox"]
+  }, /*#__PURE__*/_react["default"].createElement(MainContainer, {
+    disabled: disabled,
+    onClick: disabled ? undefined : handleCheckboxChange,
+    margin: margin,
+    size: size,
+    checked: checked !== null && checked !== void 0 ? checked : innerChecked,
+    backgroundType: backgroundType,
+    ref: ref
+  }, label && labelPosition === "before" && /*#__PURE__*/_react["default"].createElement(LabelContainer, {
+    id: labelId,
+    disabled: disabled,
+    backgroundType: backgroundType
+  }, label, optional && " ".concat(translatedLabels.formFields.optionalLabel)), /*#__PURE__*/_react["default"].createElement(ValueInput, {
+    type: "checkbox",
+    checked: checked !== null && checked !== void 0 ? checked : innerChecked,
+    name: name,
+    "aria-hidden": "true",
+    value: value,
+    disabled: disabled,
+    readOnly: true
+  }), /*#__PURE__*/_react["default"].createElement(CheckboxContainer, null, /*#__PURE__*/_react["default"].createElement(Checkbox, {
+    onKeyDown: handleKeyboard,
+    role: "checkbox",
+    tabIndex: disabled ? -1 : tabIndex,
+    "aria-checked": checked !== null && checked !== void 0 ? checked : innerChecked,
+    "aria-disabled": disabled,
+    "aria-required": !disabled && !optional,
+    "aria-labelledby": labelId,
+    backgroundType: backgroundType,
+    checked: checked !== null && checked !== void 0 ? checked : innerChecked,
+    disabled: disabled,
+    ref: checkboxRef
+  }, (checked !== null && checked !== void 0 ? checked : innerChecked) && checkedIcon)), label && labelPosition === "after" && /*#__PURE__*/_react["default"].createElement(LabelContainer, {
+    id: labelId,
+    disabled: disabled,
+    backgroundType: backgroundType
+  }, optional && "".concat(translatedLabels.formFields.optionalLabel, " "), label)));
+});
+var sizes = {
+  small: "120px",
+  medium: "240px",
+  large: "480px",
+  fillParent: "100%",
+  fitContent: "fit-content"
+};
+var calculateWidth = function calculateWidth(margin, size) {
+  if (size === "fillParent") {
+    return "calc(".concat(sizes[size], " - ").concat((0, _utils.getMargin)(margin, "left"), " - ").concat((0, _utils.getMargin)(margin, "right"), ")");
+  }
+  return sizes[size];
+};
+var getDisabledColor = function getDisabledColor(props, element) {
+  switch (element) {
+    case "check":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.disabledCheckColorOnDark : props.theme.disabledCheckColor;
+    case "background":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.disabledBackgroundColorCheckedOnDark : props.theme.disabledBackgroundColorChecked;
+    case "border":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.disabledBorderColorOnDark : props.theme.disabledBorderColor;
+    case "label":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.disabledFontColorOnDark : props.theme.disabledFontColor;
+  }
+};
+var getEnabledColor = function getEnabledColor(props, element) {
+  switch (element) {
+    case "check":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.checkColorOnDark : props.theme.checkColor;
+    case "background":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.backgroundColorCheckedOnDark : props.theme.backgroundColorChecked;
+    case "hoverBackground":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.hoverBackgroundColorCheckedOnDark : props.theme.hoverBackgroundColorChecked;
+    case "border":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.borderColorOnDark : props.theme.borderColor;
+    case "hoverBorder":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.hoverBorderColorOnDark : props.theme.hoverBorderColor;
+    case "label":
+      return props.backgroundType && props.backgroundType === "dark" ? props.theme.fontColorOnDark : props.theme.fontColor;
+  }
+};
+var LabelContainer = _styledComponents["default"].span(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-weight: ", ";\n"])), function (props) {
+  return props.disabled ? getDisabledColor(props, "label") : getEnabledColor(props, "label");
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.fontSize;
+}, function (props) {
+  return props.theme.fontWeight;
+});
+var ValueInput = _styledComponents["default"].input(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: none;\n"])));
+var CheckboxContainer = _styledComponents["default"].span(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  align-items: center;\n  justify-content: center;\n  height: 24px;\n  width: 24px;\n"])));
+var Checkbox = _styledComponents["default"].span(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  position: relative;\n  box-sizing: border-box;\n  display: flex;\n  align-items: center;\n  justify-content: center;\n  height: 18px;\n  width: 18px;\n  border: 2px solid\n    ", ";\n  border-radius: 2px;\n  background-color: ", ";\n  color: ", ";\n\n  &:focus {\n    outline: 2px solid\n      ", ";\n    outline-offset: 2px;\n  }\n  svg {\n    position: absolute;\n    width: 22px;\n    height: 22px;\n  }\n  ", "\n"])), function (props) {
+  return props.disabled ? getDisabledColor(props, "border") : getEnabledColor(props, "border");
+}, function (props) {
+  return props.checked ? props.disabled ? getDisabledColor(props, "check") : getEnabledColor(props, "check") : "transparent";
+}, function (props) {
+  return props.disabled ? getDisabledColor(props, "background") : getEnabledColor(props, "background");
+}, function (props) {
+  return props.backgroundType === "dark" ? props.theme.focusColorOnDark : props.theme.focusColor;
+}, function (props) {
+  return props.disabled && "pointer-events: none;";
+});
+var MainContainer = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  align-items: center;\n  gap: ", ";\n  width: ", ";\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n\n  cursor: ", ";\n\n  &:hover ", " {\n    border: 2px solid\n      ", ";\n    background-color: ", ";\n    color: ", ";\n  }\n"])), function (props) {
+  return props.theme.checkLabelSpacing;
+}, function (props) {
+  return calculateWidth(props.margin, props.size);
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) !== "object" ? _variables.spaces[props.margin] : "0px";
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.top ? _variables.spaces[props.margin.top] : "";
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.right ? _variables.spaces[props.margin.right] : "";
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.bottom ? _variables.spaces[props.margin.bottom] : "";
+}, function (props) {
+  return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.left ? _variables.spaces[props.margin.left] : "";
+}, function (props) {
+  return props.disabled ? "not-allowed" : "pointer";
+}, Checkbox, function (props) {
+  return props.disabled ? getDisabledColor(props, "border") : getEnabledColor(props, "hoverBorder");
+}, function (props) {
+  return props.checked ? props.disabled ? getDisabledColor(props, "check") : getEnabledColor(props, "check") : "transparent";
+}, function (props) {
+  return props.disabled ? getDisabledColor(props, "background") : getEnabledColor(props, "hoverBackground");
+});
+var _default = DxcCheckbox;
+exports["default"] = _default;

package/checkbox/Checkbox.stories.tsx

@@ -0,0 +1,260 @@
+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 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="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 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>
+    <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" defaultChecked />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" disabled />
+        </ExampleContainer>
+        <ExampleContainer>
+          <Title title="Disabled, checked and optional" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" disabled defaultChecked optional />
+        </ExampleContainer>
+        <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="Optional" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" optional />
+        </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 optional with label after" theme="dark" level={4} />
+          <DxcCheckbox label="Checkbox" disabled labelPosition="after" optional />
+        </ExampleContainer>
+      </DarkContainer>
+    </BackgroundColorProvider>
+    <Title title="Sizes" theme="light" level={2} />
+    <ExampleContainer>
+      <DxcCheckbox label="Small" size="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcCheckbox label="Medium" size="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcCheckbox label="Large" size="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcCheckbox label="FitContent" size="fitContent" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcCheckbox label="FillParent" size="fillParent" />
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall" theme="light" level={4} />
+      <DxcCheckbox label="Xxsmall" margin="xxsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcCheckbox label="Xsmall" margin="xsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcCheckbox label="Small" margin="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcCheckbox label="Medium" margin="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcCheckbox label="Large" margin="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcCheckbox label="Xlarge" margin="xlarge" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <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>
+    <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 () => {
+  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,128 @@
+"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

@@ -0,0 +1,68 @@
+export type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+export type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+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.
+     */
+    checked?: boolean;
+    /**
+     * Will be passed to the value attribute of the html input element.
+     * When inside a form, this value will be only submitted if the checkbox is checked.
+     */
+    value?: string;
+    /**
+     * Text to be placed next to the checkbox.
+     */
+    label?: string;
+    /**
+     * Whether the label should appear after or before the checkbox.
+     */
+    labelPosition?: "before" | "after";
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * If true, the component will display '(Optional)' next to the label.
+     */
+    optional?: boolean;
+    /**
+     * This function will be called when the user clicks the checkbox.
+     * The new value will be passed as a parameter.
+     */
+    onChange?: (value: boolean) => void;
+    /**
+     * Size of the margin to be applied to the component
+     * ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
+     * You can pass an object with 'top', 'bottom', 'left' and 'right' properties
+     * in order to specify different margin sizes.
+     */
+    margin?: Space | Margin;
+    /**
+     * Size of the component.
+     */
+    size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
+    /**
+     * Value of the tabindex.
+     */
+    tabIndex?: number;
+};
+/**
+ * Reference to the component.
+ */
+export type RefType = HTMLDivElement;
+export default Props;

package/checkbox/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});