@dxc-technology/halstack-react 0.0.0-d20b360 → 0.0.0-d3554d7

package/heading/Heading.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import HeadingPropsType from "./types";
+declare const DxcHeading: ({ level, text, as, weight, margin }: HeadingPropsType) => JSX.Element;
+export default DxcHeading;

package/heading/Heading.js

@@ -9,8 +9,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 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"));
@@ -19,11 +17,9 @@ var _react = _interopRequireDefault(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _variables = require("../common/variables.js");
 
-var _useTheme = _interopRequireDefault(require("../useTheme.js"));
+var _useTheme = _interopRequireDefault(require("../useTheme"));
 
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6;
 
@@ -37,8 +33,7 @@ var DxcHeading = function DxcHeading(_ref) {
       _ref$text = _ref.text,
       text = _ref$text === void 0 ? "" : _ref$text,
       as = _ref.as,
-      _ref$weight = _ref.weight,
-      weight = _ref$weight === void 0 ? "" : _ref$weight,
+      weight = _ref.weight,
       margin = _ref.margin;
   var colorsTheme = (0, _useTheme["default"])();
 
@@ -51,19 +46,19 @@ var DxcHeading = function DxcHeading(_ref) {
   }, /*#__PURE__*/_react["default"].createElement(HeadingContainer, {
     margin: margin
   }, level === 1 ? /*#__PURE__*/_react["default"].createElement(HeadingLevel1, {
-    as: checkValidAs(as),
+    as: checkValidAs(),
     weight: weight
   }, text) : level === 2 ? /*#__PURE__*/_react["default"].createElement(HeadingLevel2, {
-    as: checkValidAs(as),
+    as: checkValidAs(),
     weight: weight
   }, text) : level === 3 ? /*#__PURE__*/_react["default"].createElement(HeadingLevel3, {
-    as: checkValidAs(as),
+    as: checkValidAs(),
     weight: weight
   }, text) : level === 4 ? /*#__PURE__*/_react["default"].createElement(HeadingLevel4, {
-    as: checkValidAs(as),
+    as: checkValidAs(),
     weight: weight
   }, text) : /*#__PURE__*/_react["default"].createElement(HeadingLevel5, {
-    as: checkValidAs(as),
+    as: checkValidAs(),
     weight: weight
   }, text)));
 };
@@ -160,17 +155,5 @@ var HeadingLevel5 = _styledComponents["default"].h5(_templateObject6 || (_templa
   return props.theme.level5FontColor;
 });
 
-DxcHeading.propTypes = {
-  level: _propTypes["default"].number,
-  text: _propTypes["default"].string,
-  as: _propTypes["default"].oneOf(["h1", "h2", "h3", "h4", "h5"]),
-  weight: _propTypes["default"].oneOf(["light", "normal", "bold", ""]),
-  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)))])
-};
 var _default = DxcHeading;
 exports["default"] = _default;

package/heading/Heading.stories.tsx

@@ -0,0 +1,54 @@
+import React from "react";
+import DxcHeading from "./Heading";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+
+export default {
+  title: "Heading",
+  component: DxcHeading,
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Levels" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Level 1" theme="light" level={4} />
+      <DxcHeading text="Heading for sections within the page" />
+      <Title title="Level 2" theme="light" level={4} />
+      <DxcHeading text="Heading for sections within the page" level={2} />
+      <Title title="Level 3" theme="light" level={4} />
+      <DxcHeading text="Heading for sections within the page" level={3} />
+      <Title title="Level 4" theme="light" level={4} />
+      <DxcHeading text="Heading for sections within the page" level={4} />
+      <Title title="Level 5" theme="light" level={4} />
+      <DxcHeading text="Heading for sections within the page" level={5} />
+    </ExampleContainer>
+    <Title title="Weights" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="'light' Weight" theme="light" level={4} />
+      <DxcHeading text="Heading for sections within the page" level={2} weight="light" />
+      <Title title="'normal' Weight" theme="light" level={4} />
+      <DxcHeading text="Heading for sections within the page" level={2} weight="normal" />
+      <Title title="'bold' Weight" theme="light" level={4} />
+      <DxcHeading text="Heading for sections within the page" level={2} weight="bold" />
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall" theme="light" level={4} />
+      <DxcHeading text="Xxsmall" margin="xxsmall" />
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcHeading text="Xsmall" margin="xsmall" />
+      <Title title="Small" theme="light" level={4} />
+      <DxcHeading text="Small" margin="small" />
+      <Title title="Medium" theme="light" level={4} />
+      <DxcHeading text="Medium" margin="medium" />
+      <Title title="Large" theme="light" level={4} />
+      <DxcHeading text="Large" margin="large" />
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcHeading text="Xlarge" margin="xlarge" />
+      <Title title="Xxlarge" theme="light" level={4} />
+      <DxcHeading text="Xxlarge" margin="xxlarge" />
+      <hr />
+    </ExampleContainer>
+  </>
+);

package/heading/Heading.test.js

@@ -0,0 +1,186 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _Heading = _interopRequireDefault(require("./Heading"));
+
+describe("Heading component tests", function () {
+  test("Heading renders with default level", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test"
+    })),
+        getByText = _render.getByText,
+        getByRole = _render.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 1
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 1", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 1
+    })),
+        getByText = _render2.getByText,
+        getByRole = _render2.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 1
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 2", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 2
+    })),
+        getByText = _render3.getByText,
+        getByRole = _render3.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 2
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 3", function () {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 3
+    })),
+        getByText = _render4.getByText,
+        getByRole = _render4.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 3
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 4", function () {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 4
+    })),
+        getByText = _render5.getByText,
+        getByRole = _render5.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 4
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 5", function () {
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 5
+    })),
+        getByText = _render6.getByText,
+        getByRole = _render6.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 5
+    })).toBeTruthy();
+  });
+  test("Heading renders with default level and as h5", function () {
+    var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      as: "h5"
+    })),
+        getByText = _render7.getByText,
+        getByRole = _render7.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 5
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 1 and as h5", function () {
+    var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 1,
+      as: "h5"
+    })),
+        getByText = _render8.getByText,
+        getByRole = _render8.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 5
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 2 and as h4", function () {
+    var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 2,
+      as: "h4"
+    })),
+        getByText = _render9.getByText,
+        getByRole = _render9.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 4
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 3 and as h2", function () {
+    var _render10 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 3,
+      as: "h2"
+    })),
+        getByText = _render10.getByText,
+        getByRole = _render10.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 2
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 4 and as h3", function () {
+    var _render11 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 4,
+      as: "h3"
+    })),
+        getByText = _render11.getByText,
+        getByRole = _render11.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 3
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 5 as h4", function () {
+    var _render12 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 5,
+      as: "h4"
+    })),
+        getByText = _render12.getByText,
+        getByRole = _render12.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 4
+    })).toBeTruthy();
+  });
+  test("Heading renders with level 5 and invalid as", function () {
+    var _render13 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+      text: "my-heading-test",
+      level: 5,
+      as: "h4afdssf"
+    })),
+        getByText = _render13.getByText,
+        getByRole = _render13.getByRole;
+
+    expect(getByText("my-heading-test")).toBeTruthy();
+    expect(getByRole("heading", {
+      level: 5
+    })).toBeTruthy();
+  });
+});

package/heading/types.d.ts

@@ -0,0 +1,33 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * Defines the heading level from 1 to 5. The styles of the heading are applied according to the level.
+     * The html tag of the heading will be the one specified in the 'as' prop.
+     * If 'as' is not specified, the html tag of the heading is the one specified in the 'level' prop.
+     */
+    level?: 1 | 2 | 3 | 4 | 5;
+    /**
+     * Heading text.
+     */
+    text: string;
+    /**
+     * Specifies the html tag of the heading.
+     */
+    as?: "h1" | "h2" | "h3" | "h4" | "h5";
+    /**
+     * Modifies the default weight of the heading.
+     */
+    weight?: "light" | "normal" | "bold";
+    /**
+     * 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;
+};
+export default Props;

package/heading/types.js

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

package/inset/Inset.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import InsetPropsType from "./types";
+export default function Inset({ space, horizontal, vertical, top, right, bottom, left, children, }: InsetPropsType): JSX.Element;

package/inset/Inset.js

@@ -0,0 +1,84 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = Inset;
+
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+
+var _templateObject;
+
+function Inset(_ref) {
+  var space = _ref.space,
+      horizontal = _ref.horizontal,
+      vertical = _ref.vertical,
+      top = _ref.top,
+      right = _ref.right,
+      bottom = _ref.bottom,
+      left = _ref.left,
+      children = _ref.children;
+  return /*#__PURE__*/_react["default"].createElement(StyledInset, {
+    space: space,
+    horizontal: horizontal,
+    vertical: vertical,
+    top: top,
+    right: right,
+    bottom: bottom,
+    left: left
+  }, children);
+}
+
+function getSpacingValue(spacingName) {
+  switch (spacingName) {
+    case "none":
+      return "0rem";
+
+    case "xxxsmall":
+      return "0.125rem";
+
+    case "xxsmall":
+      return "0.25rem";
+
+    case "xsmall":
+      return "0.5rem";
+
+    case "small":
+      return "1rem";
+
+    case "medium":
+      return "1.5rem";
+
+    case "large":
+      return "2rem";
+
+    case "xlarge":
+      return "3rem";
+
+    case "xxlarge":
+      return "4rem";
+
+    case "xxxlarge":
+      return "5rem";
+
+    default:
+      return "0rem";
+  }
+}
+
+var StyledInset = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  ", "\n"])), function (_ref2) {
+  var space = _ref2.space,
+      horizontal = _ref2.horizontal,
+      vertical = _ref2.vertical,
+      top = _ref2.top,
+      right = _ref2.right,
+      bottom = _ref2.bottom,
+      left = _ref2.left;
+  return "\n  padding: ".concat(getSpacingValue(top || vertical || space), " ").concat(getSpacingValue(right || horizontal || space), "\n    ").concat(getSpacingValue(bottom || vertical || space), " ").concat(getSpacingValue(left || horizontal || space), ";\n");
+});

package/inset/Inset.stories.tsx

@@ -0,0 +1,229 @@
+import React from "react";
+import Title from "../../.storybook/components/Title";
+import styled from "styled-components";
+import DxcStack from "./../stack/Stack";
+import DxcInset from "./Inset";
+
+export default {
+  title: "Inset",
+  component: DxcInset,
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Default" level={4} />
+    <Container>
+      <DxcInset>
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = none" level={4} />
+    <Container>
+      <DxcInset space="none">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = xxxsmall" level={4} />
+    <Container>
+      <DxcInset space="xxxsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = xxsmall" level={4} />
+    <Container>
+      <DxcInset space="xxsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = xsmall" level={4} />
+    <Container>
+      <DxcInset space="xsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = small" level={4} />
+    <Container>
+      <DxcInset space="small">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = medium" level={4} />
+    <Container>
+      <DxcInset space="medium">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = large" level={4} />
+    <Container>
+      <DxcInset space="large">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = xlarge" level={4} />
+    <Container>
+      <DxcInset space="xlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = xxlarge" level={4} />
+    <Container>
+      <DxcInset space="xxlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="space = xxxlarge" level={4} />
+    <Container>
+      <DxcInset space="xxxlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = none" level={4} />
+    <Container>
+      <DxcInset horizontal="none">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = xxxsmall" level={4} />
+    <Container>
+      <DxcInset horizontal="xxxsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = xxsmall" level={4} />
+    <Container>
+      <DxcInset horizontal="xxsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = xsmall" level={4} />
+    <Container>
+      <DxcInset horizontal="xsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = small" level={4} />
+    <Container>
+      <DxcInset horizontal="small">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = medium" level={4} />
+    <Container>
+      <DxcInset horizontal="medium">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = large" level={4} />
+    <Container>
+      <DxcInset horizontal="large">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = xlarge" level={4} />
+    <Container>
+      <DxcInset horizontal="xlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = xxlarge" level={4} />
+    <Container>
+      <DxcInset horizontal="xxlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="horizontal = xxxlarge" level={4} />
+    <Container>
+      <DxcInset horizontal="xxxlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = none" level={4} />
+    <Container>
+      <DxcInset vertical="none">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = xxxsmall" level={4} />
+    <Container>
+      <DxcInset vertical="xxxsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = xxsmall" level={4} />
+    <Container>
+      <DxcInset vertical="xxsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = xsmall" level={4} />
+    <Container>
+      <DxcInset vertical="xsmall">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = small" level={4} />
+    <Container>
+      <DxcInset vertical="small">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = medium" level={4} />
+    <Container>
+      <DxcInset vertical="medium">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = large" level={4} />
+    <Container>
+      <DxcInset vertical="large">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = xlarge" level={4} />
+    <Container>
+      <DxcInset vertical="xlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = xxlarge" level={4} />
+    <Container>
+      <DxcInset vertical="xxlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="vertical = xxxlarge" level={4} />
+    <Container>
+      <DxcInset vertical="xxxlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="top = xxsmall, right= medium, bottom = large and left = xxlarge" level={4} />
+    <Container>
+      <DxcInset top="xxsmall" right="medium" bottom="large" left="xxlarge">
+        <Placeholder></Placeholder>
+      </DxcInset>
+    </Container>
+    <Title title="Inside a stack" level={4} />
+    <Container>
+      <DxcStack gutter="medium" divider>
+        <Placeholder></Placeholder>
+        <DxcInset top="xxsmall" right="medium" bottom="large" left="xxlarge">
+          <Placeholder></Placeholder>
+        </DxcInset>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+  </>
+);
+
+const Container = styled.div`
+  background: #f2eafa;
+  margin: 2.5rem;
+`;
+
+const Placeholder = styled.div`
+  min-height: 40px;
+  min-width: 120px;
+  border: 1px solid #a46ede;
+  background-color: #e5d5f6;
+`;