@dxc-technology/halstack-react 0.0.0-5908eb4 → 0.0.0-5aa300b

package/checkbox/types.d.ts

@@ -0,0 +1,68 @@
+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.
+     */
+    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 declare type RefType = HTMLDivElement;
+export default Props;

package/checkbox/types.js

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

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;

package/chip/Chip.js

@@ -0,0 +1,149 @@
+"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 _react = _interopRequireDefault(require("react"));
+
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+
+var _variables = require("../common/variables.js");
+
+var _utils = require("../common/utils.js");
+
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+
+var _templateObject, _templateObject2, _templateObject3;
+
+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 DxcChip = function DxcChip(_ref) {
+  var label = _ref.label,
+      suffixIcon = _ref.suffixIcon,
+      prefixIcon = _ref.prefixIcon,
+      onClickSuffix = _ref.onClickSuffix,
+      onClickPrefix = _ref.onClickPrefix,
+      disabled = _ref.disabled,
+      margin = _ref.margin,
+      _ref$tabIndex = _ref.tabIndex,
+      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
+  var colorsTheme = (0, _useTheme["default"])();
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.chip
+  }, /*#__PURE__*/_react["default"].createElement(StyledDxcChip, {
+    disabled: disabled,
+    margin: margin
+  }, prefixIcon && /*#__PURE__*/_react["default"].createElement(IconContainer, {
+    disabled: disabled,
+    prefixIcon: true,
+    label: label,
+    mode: "prefix",
+    tabIndex: typeof onClickPrefix === "function" && !disabled ? tabIndex : -1,
+    onClick: function onClick() {
+      return onClickPrefix && !disabled && onClickPrefix();
+    },
+    interactuable: typeof onClickPrefix === "function" && !disabled
+  }, typeof prefixIcon === "string" ? /*#__PURE__*/_react["default"].createElement("img", {
+    src: prefixIcon
+  }) : prefixIcon), label && /*#__PURE__*/_react["default"].createElement(ChipTextContainer, {
+    disabled: disabled
+  }, label), suffixIcon && /*#__PURE__*/_react["default"].createElement(IconContainer, {
+    disabled: disabled,
+    suffixIcon: true,
+    mode: "suffix",
+    label: label,
+    tabIndex: typeof onClickSuffix === "function" && !disabled ? tabIndex : -1,
+    onClick: function onClick() {
+      return onClickSuffix && !disabled && onClickSuffix();
+    },
+    interactuable: typeof onClickSuffix === "function" && !disabled
+  }, typeof suffixIcon === "string" ? /*#__PURE__*/_react["default"].createElement("img", {
+    src: suffixIcon
+  }) : suffixIcon)));
+};
+
+var getCursor = function getCursor(interactuable, disabled) {
+  if (disabled) return "cursor: not-allowed;";else if (interactuable) return "cursor: pointer;";else return "cursor: default; outline:none;";
+};
+
+var StyledDxcChip = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  align-items: center;\n  min-height: 40px;\n  max-width: ", ";\n  background-color: ", ";\n  border-radius: ", ";\n  border-width: ", ";\n  border-style: ", ";\n  border-color: ", ";\n  padding-top: ", ";\n  padding-bottom: ", ";\n  padding-left: ", ";\n  padding-right: ", ";\n\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n  cursor: ", ";\n"])), function (_ref2) {
+  var margin = _ref2.margin;
+  return "calc(100% - 40px - ".concat((0, _utils.getMargin)(margin, "left"), " - ").concat((0, _utils.getMargin)(margin, "right"), ")");
+}, function (props) {
+  return props.disabled && props.theme.disabledBackgroundColor || props.theme.backgroundColor;
+}, function (props) {
+  return props.theme.borderRadius;
+}, function (props) {
+  return props.theme.borderThickness;
+}, function (props) {
+  return props.theme.borderStyle;
+}, function (props) {
+  return props.theme.borderColor;
+}, function (props) {
+  return props.theme.contentPaddingTop;
+}, function (props) {
+  return props.theme.contentPaddingBottom;
+}, function (props) {
+  return props.theme.contentPaddingLeft;
+}, function (props) {
+  return props.theme.contentPaddingRight;
+}, 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 (_ref3) {
+  var disabled = _ref3.disabled;
+  return disabled && "not-allowed";
+});
+
+var ChipTextContainer = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  font-size: ", ";\n  font-family: ", ";\n  font-weight: ", ";\n  font-style: ", ";\n  color: ", ";\n  cursor: ", ";\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  overflow: hidden;\n"])), function (props) {
+  return props.theme.fontSize;
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.fontWeight;
+}, function (props) {
+  return props.theme.fontStyle;
+}, function (props) {
+  return props.disabled ? props.theme.disabledFontColor : props.theme.fontColor;
+}, function (_ref4) {
+  var disabled = _ref4.disabled;
+  return disabled && "not-allowed" || "default";
+});
+
+var IconContainer = _styledComponents["default"].div(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  ", "\n  color: ", ";\n  ", "\n\n  &:focus {\n    outline-color: ", ";\n    outline-width: 2px;\n    ", "\n  }\n  img,\n  svg {\n    width: ", ";\n    height: ", ";\n  }\n"])), function (props) {
+  return props.prefixIcon ? "margin-right: ".concat((props.label || props.suffixIcon) && props.theme.iconSpacing || props.prefixIcon && "0", ";") : "margin-left: ".concat((props.label || props.prefixIcon) && props.theme.iconSpacing || props.prefixIcon && "0", ";");
+}, function (props) {
+  return props.disabled ? props.theme.disabledIconColor : props.theme.iconColor;
+}, function (props) {
+  return getCursor(props.interactuable, props.disabled);
+}, function (props) {
+  return props.theme.focusColor;
+}, function (props) {
+  return props.disabled && "outline: none;";
+}, function (props) {
+  return props.theme.iconSize;
+}, function (props) {
+  return props.theme.iconSize;
+});
+
+var _default = DxcChip;
+exports["default"] = _default;

package/chip/Chip.stories.tsx

@@ -0,0 +1,151 @@
+import React from "react";
+import { userEvent, within } from "@storybook/testing-library";
+import DxcChip from "./Chip";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+
+export default {
+  title: "Chip",
+  component: DxcChip,
+};
+
+const iconSVG = (
+  <svg
+    version="1.1"
+    id="Capa_1"
+    x="0px"
+    y="0px"
+    width="438.536px"
+    height="438.536px"
+    viewBox="0 0 438.536 438.536"
+    fill="currentColor"
+  >
+    <g>
+      <path
+        d="M414.41,24.123C398.333,8.042,378.963,0,356.315,0H82.228C59.58,0,40.21,8.042,24.126,24.123
+C8.045,40.207,0.003,59.576,0.003,82.225v274.084c0,22.647,8.042,42.018,24.123,58.102c16.084,16.084,35.454,24.126,58.102,24.126
+h274.084c22.648,0,42.018-8.042,58.095-24.126c16.084-16.084,24.126-35.454,24.126-58.102V82.225
+C438.532,59.576,430.49,40.204,414.41,24.123z M373.155,225.548h-49.963V406.84h-74.802V225.548H210.99V163.02h37.401v-37.402
+c0-26.838,6.283-47.107,18.843-60.813c12.559-13.706,33.304-20.555,62.242-20.555h49.963v62.526h-31.401
+c-10.663,0-17.467,1.853-20.417,5.568c-2.949,3.711-4.428,10.23-4.428,19.558v31.119h56.534L373.155,225.548z"
+      />
+    </g>
+  </svg>
+);
+
+const smallIconSVG = (
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" height="20" width="20">
+    <path d="m10 17-1.042-.938q-2.083-1.854-3.437-3.177-1.354-1.323-2.136-2.354Q2.604 9.5 2.302 8.646 2 7.792 2 6.896q0-1.854 1.271-3.125T6.396 2.5q1.021 0 1.979.438.958.437 1.625 1.229.667-.792 1.625-1.229.958-.438 1.979-.438 1.854 0 3.125 1.271T18 6.896q0 .896-.292 1.729-.291.833-1.073 1.854-.781 1.021-2.145 2.365-1.365 1.344-3.49 3.26Zm0-2.021q1.938-1.729 3.188-2.948 1.25-1.219 1.989-2.125.74-.906 1.031-1.614.292-.709.292-1.396 0-1.229-.833-2.063Q14.833 4 13.604 4q-.729 0-1.364.302-.636.302-1.094.844L10.417 6h-.834l-.729-.854q-.458-.542-1.114-.844Q7.083 4 6.396 4q-1.229 0-2.063.833-.833.834-.833 2.063 0 .687.271 1.364.271.678.989 1.573.719.896 1.98 2.125Q8 13.188 10 14.979Zm0-5.5Z" />
+  </svg>
+);
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Basic chip" theme="light" level={4} />
+      <DxcChip label="Default Chip" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Chip with prefix SVG (small icon)" theme="light" level={4} />
+      <DxcChip label="Chip with prefix" prefixIcon={smallIconSVG} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Chip with suffix SVG (large icon)" theme="light" level={4} />
+      <DxcChip label="Chip with suffix" suffixIcon={iconSVG} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Chip with prefix (SVG) and suffix (URL)" theme="light" level={4} />
+      <DxcChip
+        label="Chip with prefix and suffix"
+        prefixIcon={iconSVG}
+        suffixIcon="https://upload.wikimedia.org/wikipedia/commons/e/e0/Check_green_icon.svg"
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled chip" theme="light" level={4} />
+      <DxcChip
+        label="Disabled"
+        disabled
+        prefixIcon={iconSVG}
+        suffixIcon="https://upload.wikimedia.org/wikipedia/commons/e/e0/Check_green_icon.svg"
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Chip with ellipsis" theme="light" level={4} />
+      <DxcChip label="With ellipsis asdfasdf asdf asdfasdf asdf asdfasdf asdfasdf asdf asdf adfasrfasf afsdg afgasfg asdf asdf asdf asdf asdf asdf asdf  afdg asfg asdfg asdf asdf asdf asdfasdf asd fas df asd asdf asdf asdfasd fg ssssssssssss ssss" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Chip with ellipsis and suffix" theme="light" level={4} />
+      <DxcChip
+        suffixIcon={iconSVG}
+        label="With ellipsis asdfasdf asdf asdfasdf asdf asdfasdf asdfasdf asdf asdf adfasrfasf afsdg afgasfg asdf asdf asdf asdf asdf asdf asdf  afdg asfg asdfg asdf asdf asdf asdfasdf asd fas df asd asdf asdf asdfasd fgsss"
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Chip with ellipsis and prefix" theme="light" level={4} />
+      <DxcChip
+        prefixIcon={iconSVG}
+        label="With ellipsis asdfasdf asdf asdfasdf asdf asdfasdf asdfasdf asdf asdf adfasrfasf afsdg afgasfg asdf asdf asdf asdf asdf asdf asdf  afdg asfg asdfg asdf asdf asdf asdfasdf asd fas df asd asdf asdf asdfasd fgsss"
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Chip with ellipsis, suffix and prefix" theme="light" level={4} />
+      <DxcChip
+        prefixIcon={iconSVG}
+        suffixIcon={iconSVG}
+        label="With ellipsis asdfasdf asdf asdfasdf asdf asdfasdf asdfasdf asdf asdf adfasrfasf afsdg afgasfg asdf asdf asdf asdf asdf asdf asdf  afdg asfg asdfg asdf asdf asdf asdfasdf asd fas df asd asdf asdf asdfasdf"
+      />
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcChip label="xxsmall" margin="xxsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcChip label="xsmall" margin="xsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcChip label="small" margin="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcChip label="medium" margin="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcChip label="large" margin="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcChip label="xlarge" margin="xlarge" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcChip label="xxlarge" margin="xxlarge" />
+    </ExampleContainer>
+  </>
+);
+const ChipPrefixFocused = () => (
+  <ExampleContainer>
+    <Title title="Chip with prefix" theme="light" level={4} />
+    <DxcChip label="Chip with prefix" prefixIcon={iconSVG} onClickPrefix={() => {}} />
+  </ExampleContainer>
+);
+const ChipSuffixFocused = () => (
+  <ExampleContainer>
+    <Title title="Chip with suffix" theme="light" level={4} />
+    <DxcChip label="Chip with suffix" suffixIcon={iconSVG} onClickSuffix={() => {}} />
+  </ExampleContainer>
+);
+
+export const PrefixFocused = ChipPrefixFocused.bind({});
+PrefixFocused.play = async ({ canvasElement }) => {
+  await userEvent.tab();
+};
+
+export const SuffixFocused = ChipSuffixFocused.bind({});
+SuffixFocused.play = async ({ canvasElement }) => {
+  await userEvent.tab();
+};

package/chip/Chip.test.js

@@ -0,0 +1,56 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _Chip = _interopRequireDefault(require("./Chip"));
+
+var _invision = _interopRequireDefault(require("../../app/src/images/invision.svg"));
+
+describe("Chip component tests", function () {
+  test("Chip renders with correct text", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Chip["default"], {
+      label: "Chip"
+    })),
+        getByText = _render.getByText;
+
+    expect(getByText("Chip")).toBeTruthy();
+  });
+  test("Calls correct function when clicking on prefix icon", function () {
+    var onClick = jest.fn();
+
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Chip["default"], {
+      label: "Chip",
+      prefixIcon: _invision["default"],
+      onClickPrefix: onClick
+    })),
+        getByText = _render2.getByText,
+        getByRole = _render2.getByRole;
+
+    expect(getByText("Chip")).toBeTruthy();
+
+    _react2.fireEvent.click(getByRole("img"));
+
+    expect(onClick).toHaveBeenCalled();
+  });
+  test("Calls correct function when clicking on suffix icon", function () {
+    var onClick = jest.fn();
+
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Chip["default"], {
+      label: "Chip",
+      suffixIcon: _invision["default"],
+      onClickSuffix: onClick
+    })),
+        getByText = _render3.getByText,
+        getByRole = _render3.getByRole;
+
+    expect(getByText("Chip")).toBeTruthy();
+
+    _react2.fireEvent.click(getByRole("img"));
+
+    expect(onClick).toHaveBeenCalled();
+  });
+});

package/chip/types.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="react" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+declare type Props = {
+    /**
+     * Text to be placed on the chip.
+     */
+    label?: string;
+    /**
+     * Element or path used as icon to be placed after the chip label.
+     */
+    suffixIcon?: string | SVG;
+    /**
+     * Element or path used as icon to be placed before the chip label.
+     */
+    prefixIcon?: string | SVG;
+    /**
+     * This function will be called when the suffix is clicked.
+     */
+    onClickSuffix?: () => void;
+    /**
+     * This function will be called when the prefix is clicked.
+     */
+    onClickPrefix?: () => void;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * 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;
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/chip/types.js

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