@dxc-technology/halstack-react 0.0.0-beebecd → 0.0.0-bfdc357

package/card/types.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="react" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Size = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * URL of the image that will be placed in the card component.
+     * In case of omission, the image container will not appear and
+     * the content will occupy its space.
+     */
+    imageSrc?: string;
+    /**
+     * Color of the image background.
+     */
+    imageBgColor?: string;
+    /**
+     * Size of the padding to be applied to the image section of the
+     * component. You can pass an object with 'top', 'bottom', 'left'
+     * and 'right' properties in order to specify different padding sizes.
+     */
+    imagePadding?: Space | Size;
+    /**
+     * Whether the image should appear in relation to the content.
+     */
+    imagePosition?: "before" | "after";
+    /**
+     * If defined, the tag will be displayed as an anchor, using this prop
+     * as "href". Component will show some visual feedback on hover.
+     */
+    linkHref?: string;
+    /**
+     * This function will be called when the user clicks the card. Component
+     * will show some visual feedback on hover.
+     */
+    onClick?: () => void;
+    /**
+     * Whether the image must cover the whole image area of the card.
+     */
+    imageCover?: boolean;
+    /**
+     * Size of the margin to be applied to the component. You can pass
+     * an object with 'top', 'bottom', 'left' and 'right' properties
+     * in order to specify different margin sizes.
+     */
+    margin?: Space | Size;
+    /**
+     * Size of the padding to be applied to the content area. You can pass
+     * an object with 'top', 'bottom', 'left' and 'right' properties in
+     * order to specify different padding sizes.
+     */
+    contentPadding?: Space | Size;
+    /**
+     * Value of the tabindex given when there is an href.
+     */
+    tabIndex?: number;
+    /**
+     * Whether the card must be outlined.
+     */
+    outlined?: boolean;
+    /**
+     * Custom content that will be placed in the card component.
+     */
+    children?: React.ReactNode;
+};
+export default Props;

package/card/types.js

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

package/checkbox/Checkbox.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import CheckboxPropsType from "./types";
+declare const DxcCheckbox: ({ checked, value, label, labelPosition, name, disabled, onChange, required, margin, size, tabIndex, }: CheckboxPropsType) => JSX.Element;
+export default DxcCheckbox;

package/{dist/checkbox → checkbox}/Checkbox.js

@@ -1,16 +1,14 @@
 "use strict";
 
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
-
 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 _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
@@ -23,8 +21,6 @@ var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
 var _Checkbox = _interopRequireDefault(require("@material-ui/core/Checkbox"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _RequiredComponent = _interopRequireDefault(require("../common/RequiredComponent"));
 
 var _variables = require("../common/variables.js");
@@ -35,35 +31,11 @@ var _useTheme = _interopRequireDefault(require("../useTheme.js"));
 
 var _BackgroundColorContext = _interopRequireDefault(require("../BackgroundColorContext.js"));
 
-function _templateObject3() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  background-color: ", ";\n  width: 16px;\n  height: 16px;\n  position: absolute;\n  left: ", ";\n  right: ", ";\n  z-index: 0;\n  margin-left: ", ";\n  margin-right: ", ";\n"]);
+var _templateObject, _templateObject2, _templateObject3;
 
-  _templateObject3 = function _templateObject3() {
-    return data;
-  };
-
-  return data;
-}
-
-function _templateObject2() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n  width: ", ";\n  display: inline-flex;\n  align-items: center;\n  cursor: ", ";\n  position: relative;\n  flex-direction: ", ";\n  .MuiCheckbox-colorSecondary {\n    .MuiIconButton-label {\n      & > .MuiSvgIcon-root {\n        color: ", ";\n      }\n    }\n    &.Mui-disabled {\n      .MuiIconButton-label {\n        & > .MuiSvgIcon-root {\n          color: ", ";\n          opacity: 0.34;\n        }\n      }\n    }\n    &.Mui-checked {\n      .MuiIconButton-label {\n        & > .MuiSvgIcon-root {\n          color: ", ";\n        }\n      }\n\n      &:hover {\n        background-color: transparent;\n        .MuiIconButton-label {\n          & > .MuiSvgIcon-root {\n            background-color: transparent;\n            color: ", ";\n          }\n        }\n      }\n    }\n    .MuiIconButton-label {\n      & > .MuiSvgIcon-root {\n        width: 24px;\n        height: 24px;\n      }\n    }\n  }\n\n  .MuiIconButton-colorSecondary {\n    &:hover {\n      background-color: transparent;\n    }\n  }\n  .MuiButtonBase-root {\n    &:hover {\n      .MuiIconButton-label {\n        & > .MuiSvgIcon-root {\n          color: ", ";\n        }\n      }\n    }\n\n    &.Mui-focusVisible {\n      .MuiIconButton-label {\n        box-shadow: 0 0 0 2px\n          ", ";\n      }\n    }\n    z-index: 1;\n    margin: ", ";\n    margin-left: ", ";\n    margin-right: ", ";\n    padding: 0px;\n    left: ", ";\n    right: ", ";\n  }\n"]);
-
-  _templateObject2 = function _templateObject2() {
-    return data;
-  };
+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); }
 
-  return data;
-}
-
-function _templateObject() {
-  var data = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  cursor: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-weight: ", ";\n"]);
-
-  _templateObject = function _templateObject() {
-    return data;
-  };
-
-  return data;
-}
+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 DxcCheckbox = function DxcCheckbox(_ref) {
   var checked = _ref.checked,
@@ -117,18 +89,19 @@ var DxcCheckbox = function DxcCheckbox(_ref) {
     setIsLabelHovered(!isLabelHovered);
   };
 
-  return _react["default"].createElement(_styledComponents.ThemeProvider, {
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
     theme: colorsTheme.checkbox
-  }, _react["default"].createElement(CheckboxContainer, {
+  }, /*#__PURE__*/_react["default"].createElement(CheckboxContainer, {
     id: name,
     brightness: _variables.componentTokens,
+    label: label,
     labelPosition: labelPosition,
     disabled: disabled,
     margin: margin,
     size: size,
     backgroundType: backgroundType,
     isLabelHovered: isLabelHovered
-  }, _react["default"].createElement(_Checkbox["default"], {
+  }, /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
     checked: checked != undefined ? checked : innerChecked,
     inputProps: {
       name: name,
@@ -142,12 +115,12 @@ var DxcCheckbox = function DxcCheckbox(_ref) {
     disableRipple: true,
     className: "test",
     tabIndex: tabIndex
-  }), _react["default"].createElement(CheckboxBlackBack, {
+  }), /*#__PURE__*/_react["default"].createElement(CheckboxBlackBack, {
     labelPosition: labelPosition,
     disabled: disabled,
     checked: checked != undefined ? checked : innerChecked,
     backgroundType: backgroundType
-  }), required && _react["default"].createElement(_RequiredComponent["default"], null), label && _react["default"].createElement(LabelContainer, {
+  }), required && /*#__PURE__*/_react["default"].createElement(_RequiredComponent["default"], null), label && /*#__PURE__*/_react["default"].createElement(LabelContainer, {
     labelPosition: labelPosition,
     onClick: disabled === true ? function (e) {} : handlerCheckboxChange,
     disabled: disabled,
@@ -214,7 +187,7 @@ var getNotDisabledColor = function getNotDisabledColor(props, element) {
   }
 };
 
-var LabelContainer = _styledComponents["default"].span(_templateObject(), function (props) {
+var LabelContainer = _styledComponents["default"].span(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  cursor: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-weight: ", ";\n"])), function (props) {
   return props.disabled ? getDisabledColor(props, "label") : getNotDisabledColor(props, "label");
 }, function (props) {
   return props.disabled ? "not-allowed" : "pointer";
@@ -226,7 +199,7 @@ var LabelContainer = _styledComponents["default"].span(_templateObject(), functi
   return props.theme.fontWeight;
 });
 
-var CheckboxContainer = _styledComponents["default"].span(_templateObject2(), function (props) {
+var CheckboxContainer = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n  width: ", ";\n  display: inline-flex;\n  align-items: center;\n  cursor: ", ";\n  position: relative;\n  flex-direction: ", ";\n  .MuiCheckbox-colorSecondary {\n    .MuiIconButton-label {\n      & > .MuiSvgIcon-root {\n        color: ", ";\n      }\n    }\n    &.Mui-disabled {\n      .MuiIconButton-label {\n        & > .MuiSvgIcon-root {\n          color: ", ";\n          opacity: 0.34;\n        }\n      }\n    }\n    &.Mui-checked {\n      .MuiIconButton-label {\n        & > .MuiSvgIcon-root {\n          color: ", ";\n        }\n      }\n\n      &:hover {\n        background-color: transparent;\n        .MuiIconButton-label {\n          & > .MuiSvgIcon-root {\n            background-color: transparent;\n            color: ", ";\n          }\n        }\n      }\n    }\n    .MuiIconButton-label {\n      & > .MuiSvgIcon-root {\n        width: 24px;\n        height: 24px;\n      }\n    }\n  }\n\n  .MuiIconButton-colorSecondary {\n    &:hover {\n      background-color: transparent;\n    }\n  }\n  .MuiButtonBase-root {\n    &:hover {\n      .MuiIconButton-label {\n        & > .MuiSvgIcon-root {\n          color: ", ";\n        }\n      }\n    }\n\n    &.Mui-focusVisible {\n      .MuiIconButton-label {\n        box-shadow: 0 0 0 2px\n          ", ";\n      }\n    }\n    z-index: 1;\n    margin-left: ", ";\n    margin-right: ", ";\n    padding: 0px;\n    left: ", ";\n    right: ", ";\n  }\n"])), 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] : "";
@@ -255,18 +228,16 @@ var CheckboxContainer = _styledComponents["default"].span(_templateObject2(), fu
 }, function (props) {
   return props.backgroundType === "dark" ? props.theme.focusColorOnDark : props.theme.focusColor;
 }, function (props) {
-  return props.theme.checkLabelSpacing;
+  return props.labelPosition === "before" && props.label ? props.theme.checkLabelSpacing : "0";
 }, function (props) {
-  return props.labelPosition === "after" ? "0px" : "";
-}, function (props) {
-  return props.labelPosition === "before" ? "0px" : "";
+  return props.labelPosition === "after" && props.label ? props.theme.checkLabelSpacing : "0";
 }, function (props) {
   return props.labelPosition === "before" ? "unset" : "1px";
 }, function (props) {
   return props.labelPosition === "before" ? "1px" : "unset";
 });
 
-var CheckboxBlackBack = _styledComponents["default"].span(_templateObject3(), function (props) {
+var CheckboxBlackBack = _styledComponents["default"].span(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  background-color: ", ";\n  width: 16px;\n  height: 16px;\n  position: absolute;\n  left: ", ";\n  right: ", ";\n  z-index: 0;\n  margin-left: ", ";\n  margin-right: ", ";\n"])), function (props) {
   return !props.checked ? "transparent" : props.disabled ? getDisabledColor(props, "check") : getNotDisabledColor(props, "check");
 }, function (props) {
   return props.labelPosition === "before" ? "unset" : "5px";
@@ -278,23 +249,5 @@ var CheckboxBlackBack = _styledComponents["default"].span(_templateObject3(), fu
   return props.labelPosition === "before" ? "0px" : "";
 });
 
-DxcCheckbox.propTypes = {
-  checked: _propTypes["default"].bool,
-  value: _propTypes["default"].any,
-  label: _propTypes["default"].string,
-  labelPosition: _propTypes["default"].oneOf(["after", "before", ""]),
-  name: _propTypes["default"].string,
-  disabled: _propTypes["default"].bool,
-  onChange: _propTypes["default"].func,
-  required: _propTypes["default"].bool,
-  size: _propTypes["default"].oneOf((0, _toConsumableArray2["default"])(Object.keys(sizes))),
-  margin: _propTypes["default"].oneOfType([_propTypes["default"].shape({
-    top: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
-    bottom: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
-    left: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
-    right: _propTypes["default"].oneOf(Object.keys(_variables.spaces))
-  }), _propTypes["default"].oneOf((0, _toConsumableArray2["default"])(Object.keys(_variables.spaces)))]),
-  tabIndex: _propTypes["default"].number
-};
 var _default = DxcCheckbox;
 exports["default"] = _default;

package/checkbox/Checkbox.stories.tsx

@@ -0,0 +1,192 @@
+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";
+
+export default {
+  title: "Checkbox",
+  component: DxcCheckbox,
+};
+
+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>
+    <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>
+  </>
+);
+
+export const Chromatic = Checkbox.bind({});
+Chromatic.play = async () => {
+  await userEvent.tab();
+  await userEvent.tab();
+};

package/checkbox/types.d.ts

@@ -0,0 +1,60 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * 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 checkbox will change its appearence, showing that the value is required.
+     */
+    required?: 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;
+    /**
+     * 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 ('small' | 'medium' | 'large' | 'fillParent' | 'fitContent').
+     */
+    size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
+    /**
+     * Value of the tabindex.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/checkbox/types.js

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