@dxc-technology/halstack-react 0.0.0-b92e300 → 0.0.0-b94d9fc

package/box/Box.stories.tsx

@@ -0,0 +1,119 @@
+import React from "react";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DxcBox from "./Box";
+import DxcInset from "../inset/Inset";
+import { HalstackProvider } from "../HalstackContext";
+
+export default {
+  title: "Box ",
+  component: DxcBox,
+};
+
+const opinionatedTheme = {
+  box: {
+    baseColor: "#ffffff",
+  },
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Display flex" theme="light" level={2} />
+    <ExampleContainer>
+      <DxcBox display="flex">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <Title title="ShadowDepth" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="ShadowDepth 0" theme="light" level={4} />
+      <DxcBox shadowDepth={0} margin="medium">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="ShadowDepth 1" theme="light" level={4} />
+      <DxcBox shadowDepth={1} margin="medium">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="ShadowDepth 2" theme="light" level={4} />
+      <DxcBox shadowDepth={2} margin="medium">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcBox margin="xxsmall">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcBox margin="xsmall">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcBox margin="small">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcBox margin="medium">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcBox margin="large">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcBox margin="xlarge">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcBox margin="xxlarge">
+        <DxcInset space="2rem">Box</DxcInset>
+      </DxcBox>
+    </ExampleContainer>
+    <Title title="Sizes" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Small size" theme="light" level={4} />
+      <DxcBox size="small">Box</DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium size" theme="light" level={4} />
+      <DxcBox size="medium">Box</DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large size" theme="light" level={4} />
+      <DxcBox size="large">Box</DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="FillParent size" theme="light" level={4} />
+      <DxcBox size="fillParent">Box</DxcBox>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="FitContent" theme="light" level={4} />
+      <DxcBox size="fitContent">Box</DxcBox>
+    </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcBox display="flex">
+          <DxcInset space="2rem">Box</DxcInset>
+        </DxcBox>
+      </HalstackProvider>
+    </ExampleContainer>
+  </>
+);

package/box/Box.test.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _Card = _interopRequireDefault(require("../card/Card.tsx"));
+describe("Box component tests", function () {
+  test("Box renders with correct text", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], null, "test-box")),
+      getByText = _render.getByText;
+    expect(getByText("test-box")).toBeTruthy();
+  });
+});

package/box/types.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="react" />
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+type Props = {
+    /**
+     * The size of the shadow to be displayed around the box.
+     */
+    shadowDepth?: 0 | 1 | 2;
+    /**
+     * Changes the display CSS property of the box div.
+     */
+    display?: string;
+    /**
+     * Custom content that will be placed in the box component.
+     */
+    children: React.ReactNode;
+    /**
+     * 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";
+};
+export default Props;

package/box/types.js

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

package/bulleted-list/BulletedList.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import BulletedListPropsType, { BulletedListItemPropsType } from "./types";
+declare const DxcBulletedList: {
+    ({ children, type, icon }: BulletedListPropsType): JSX.Element;
+    Item: ({ children }: BulletedListItemPropsType) => JSX.Element;
+};
+export default DxcBulletedList;

package/bulleted-list/BulletedList.js

@@ -0,0 +1,89 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _react = _interopRequireDefault(require("react"));
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+var _Flex = _interopRequireDefault(require("../flex/Flex"));
+var _Typography = _interopRequireDefault(require("../typography/Typography"));
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9;
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
+var BulletedListItem = function BulletedListItem(_ref) {
+  var children = _ref.children;
+  return /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, children);
+};
+var DxcBulletedList = function DxcBulletedList(_ref2) {
+  var children = _ref2.children,
+    _ref2$type = _ref2.type,
+    type = _ref2$type === void 0 ? "disc" : _ref2$type,
+    _ref2$icon = _ref2.icon,
+    icon = _ref2$icon === void 0 ? "" : _ref2$icon;
+  var colorsTheme = (0, _useTheme["default"])();
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.bulletedList
+  }, /*#__PURE__*/_react["default"].createElement(ListContainer, null, /*#__PURE__*/_react["default"].createElement(_Flex["default"], {
+    direction: "column",
+    as: type === "number" ? "ol" : "ul",
+    gap: "0.125rem"
+  }, _react["default"].Children.map(children, function (child, index) {
+    return /*#__PURE__*/_react["default"].createElement(ListItem, null, /*#__PURE__*/_react["default"].createElement(GeneralContent, null, type === "number" ? /*#__PURE__*/_react["default"].createElement(Number, null, /*#__PURE__*/_react["default"].createElement(_Typography["default"], {
+      color: colorsTheme.bulletedList.fontColor
+    }, index + 1, ".")) : type === "square" ? /*#__PURE__*/_react["default"].createElement(Bullet, null, /*#__PURE__*/_react["default"].createElement(Square, null)) : type === "circle" ? /*#__PURE__*/_react["default"].createElement(Bullet, null, /*#__PURE__*/_react["default"].createElement(Circle, null)) : type === "icon" ? /*#__PURE__*/_react["default"].createElement(Bullet, null, /*#__PURE__*/_react["default"].createElement(Icon, null, typeof icon === "string" ? /*#__PURE__*/_react["default"].createElement("img", {
+      src: icon
+    }) : icon)) : /*#__PURE__*/_react["default"].createElement(Bullet, null, /*#__PURE__*/_react["default"].createElement(Disc, null)), /*#__PURE__*/_react["default"].createElement(_Typography["default"], {
+      color: colorsTheme.bulletedList.fontColor
+    }, child)));
+  }))));
+};
+DxcBulletedList.Item = BulletedListItem;
+var ListContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  ul,\n  ol {\n    padding: 0;\n    margin: 0;\n  }\n"])));
+var Bullet = _styledComponents["default"].div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  align-self: flex-start;\n  align-items: center;\n  height: 1.5rem;\n"])));
+var GeneralContent = _styledComponents["default"].div(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: grid;\n  grid-template-columns: auto 1fr;\n  align-items: center;\n"])));
+var Icon = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  height: 1.5rem;\n  width: auto;\n  margin-right: ", ";\n  align-content: center;\n  color: ", ";\n\n  svg,\n  img {\n    height: ", ";\n    width: ", ";\n  }\n"])), function (props) {
+  return props.theme.bulletMarginRight;
+}, function (props) {
+  return props.theme.fontColor;
+}, function (props) {
+  return props.theme.bulletIconHeight;
+}, function (props) {
+  return props.theme.bulletIconWidth;
+});
+var Number = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  user-select: none;\n  margin-right: ", ";\n  display: flex;\n  box-sizing: border-box;\n  align-self: flex-start;\n  min-width: 0;\n"])), function (props) {
+  return props.theme.bulletMarginRight;
+});
+var Square = _styledComponents["default"].div(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["\n  background-color: ", ";\n  height: ", ";\n  width: ", ";\n  margin-right: ", ";\n"])), function (props) {
+  return props.theme.fontColor;
+}, function (props) {
+  return props.theme.bulletHeight;
+}, function (props) {
+  return props.theme.bulletWidth;
+}, function (props) {
+  return props.theme.bulletMarginRight;
+});
+var Circle = _styledComponents["default"].div(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2["default"])(["\n  height: ", ";\n  width: ", ";\n  border-radius: 50%;\n  border: 1px solid;\n  border-color: ", ";\n  margin-right: ", ";\n"])), function (props) {
+  return props.theme.bulletHeight;
+}, function (props) {
+  return props.theme.bulletWidth;
+}, function (props) {
+  return props.theme.fontColor;
+}, function (props) {
+  return props.theme.bulletMarginRight;
+});
+var Disc = _styledComponents["default"].div(_templateObject8 || (_templateObject8 = (0, _taggedTemplateLiteral2["default"])(["\n  background-color: ", ";\n  height: ", ";\n  width: ", ";\n  border-radius: 50%;\n  margin-right: ", ";\n"])), function (props) {
+  return props.theme.fontColor;
+}, function (props) {
+  return props.theme.bulletHeight;
+}, function (props) {
+  return props.theme.bulletWidth;
+}, function (props) {
+  return props.theme.bulletMarginRight;
+});
+var ListItem = _styledComponents["default"].li(_templateObject9 || (_templateObject9 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  margin: 0px;\n  padding: 0px;\n  list-style: none;\n  font-size: 1em;\n"])));
+var _default = exports["default"] = DxcBulletedList;

package/bulleted-list/BulletedList.stories.tsx

@@ -0,0 +1,115 @@
+import React from "react";
+import styled from "styled-components";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DxcBulletedList from "./BulletedList";
+
+export default {
+  title: "Bulleted List",
+  component: DxcBulletedList,
+};
+
+const icon = (
+  <svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 0 24 24" width="24px" fill="currentColor">
+    <path d="M0 0h24v24H0V0z" fill="none" />
+    <path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z" />
+  </svg>
+);
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Icon list (SVG)" level={4} />
+      <DxcBulletedList type="icon" icon={icon}>
+        <DxcBulletedList.Item>Code</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Usage</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Specifications</DxcBulletedList.Item>
+      </DxcBulletedList>
+      <Title title="Icon list (path)" level={4} />
+      <DxcBulletedList type="icon" icon="https://upload.wikimedia.org/wikipedia/commons/e/e0/Check_green_icon.svg">
+        <DxcBulletedList.Item>Code</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Usage</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Specifications</DxcBulletedList.Item>
+      </DxcBulletedList>
+      <Title title="Number list" level={4} />
+      <DxcBulletedList type="number">
+        <DxcBulletedList.Item>Code</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Usage</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Specifications</DxcBulletedList.Item>
+      </DxcBulletedList>
+      <Title title="Square" level={4} />
+      <DxcBulletedList type="square">
+        <DxcBulletedList.Item>Code</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Usage</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Specifications</DxcBulletedList.Item>
+      </DxcBulletedList>
+      <Title title="Circle" level={4} />
+      <DxcBulletedList type="circle">
+        <DxcBulletedList.Item>Code</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Usage</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Specifications</DxcBulletedList.Item>
+      </DxcBulletedList>
+      <Title title="Disc" level={4} />
+      <DxcBulletedList>
+        <DxcBulletedList.Item>Code</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Usage</DxcBulletedList.Item>
+        <DxcBulletedList.Item>Specifications</DxcBulletedList.Item>
+      </DxcBulletedList>
+      <Title title="Multiple lines" level={4} />
+      <Container>
+        <Title title="Number" level={4} />
+        <DxcBulletedList type="number">
+          <DxcBulletedList.Item>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
+            dolore magna aliqua.
+          </DxcBulletedList.Item>
+          <DxcBulletedList.Item>Text 2.</DxcBulletedList.Item>
+        </DxcBulletedList>
+      </Container>
+      <Container>
+        <Title title="Square" level={4} />
+        <DxcBulletedList type="square">
+          <DxcBulletedList.Item>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
+            dolore magna aliqua.
+          </DxcBulletedList.Item>
+          <DxcBulletedList.Item>Text 2.</DxcBulletedList.Item>
+        </DxcBulletedList>
+      </Container>
+      <Container>
+        <Title title="Circle" level={4} />
+        <DxcBulletedList type="circle">
+          <DxcBulletedList.Item>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
+            dolore magna aliqua.
+          </DxcBulletedList.Item>
+          <DxcBulletedList.Item>Text 2.</DxcBulletedList.Item>
+        </DxcBulletedList>
+      </Container>
+      <Title title="Disc" level={4} />
+      <Container>
+        <DxcBulletedList>
+          <DxcBulletedList.Item>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
+            dolore magna aliqua.
+          </DxcBulletedList.Item>
+          <DxcBulletedList.Item>Text 2.</DxcBulletedList.Item>
+        </DxcBulletedList>
+      </Container>
+      <Container>
+        <Title title="Icon" level={4} />
+        <DxcBulletedList type="icon" icon={icon}>
+          <DxcBulletedList.Item>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et
+            dolore magna aliqua.
+          </DxcBulletedList.Item>
+          <DxcBulletedList.Item>Text 2.</DxcBulletedList.Item>
+        </DxcBulletedList>
+      </Container>
+    </ExampleContainer>
+  </>
+);
+
+const Container = styled.div`
+  width: 400px;
+`;

package/bulleted-list/types.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="react" />
+type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+type IconProps = {
+    /**
+     * Defines the style of the bullet point in the list.
+     */
+    type: "icon";
+    /**
+     * Icon to display as bullet.
+     */
+    icon: string | SVG;
+    /**
+     * Text to be shown in the list.
+     */
+    children: React.ReactNode;
+};
+type OtherProps = {
+    /**
+     * Defines the style of the bullet point in the list.
+     */
+    type?: "disc" | "circle" | "square" | "number";
+    /**
+     * Icon to display as bullet.
+     */
+    icon?: never;
+    /**
+     * Text to be shown in the list.
+     */
+    children: React.ReactNode;
+};
+type Props = IconProps | OtherProps;
+export default Props;
+export type BulletedListItemPropsType = {
+    /**
+     * Text to be shown in the list.
+     */
+    children?: React.ReactNode;
+};

package/bulleted-list/types.js

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

package/button/Button.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="react" />
 import ButtonPropsType from "./types";
-declare const DxcButton: ({ label, mode, disabled, iconPosition, type, iconSrc, icon, onClick, margin, size, tabIndex, }: ButtonPropsType) => JSX.Element;
+declare const DxcButton: ({ label, mode, disabled, iconPosition, title, type, icon, onClick, margin, size, tabIndex, }: ButtonPropsType) => JSX.Element;
 export default DxcButton;