@dxc-technology/halstack-react 0.0.0-42c3aef → 0.0.0-435515

package/tag/Tag.stories.tsx

@@ -0,0 +1,152 @@
+import React from "react";
+import { userEvent, within } from "@storybook/testing-library";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DxcTag from "./Tag";
+import { HalstackProvider } from "../HalstackContext";
+
+export default {
+  title: "Tag",
+  component: DxcTag,
+};
+
+const icon = (
+  <svg viewBox="0 0 24 24" fill="currentColor">
+    <path d="M0 0h24v24H0z" fill="none" />
+    <path d="M12 21.35l-1.45-1.32C5.4 15.36 2 12.28 2 8.5 2 5.42 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.09C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.42 22 8.5c0 3.78-3.4 6.86-8.55 11.54L12 21.35z" />
+  </svg>
+);
+
+const largeIcon = (
+  <svg xmlns="http://www.w3.org/2000/svg" height="48px" viewBox="0 0 24 24" width="48px" fill="currentColor">
+    <path d="M0 0h24v24H0V0z" fill="none" />
+    <path d="M11.99 2C6.47 2 2 6.48 2 12s4.47 10 9.99 10C17.52 22 22 17.52 22 12S17.52 2 11.99 2zM12 20c-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8-3.58 8-8 8zm.5-13H11v6l5.25 3.15.75-1.23-4.5-2.67z" />
+  </svg>
+);
+
+const opinionatedTheme = {
+  tag: {
+    fontColor: "#000000",
+    iconColor: "#ffffff",
+  },
+};
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="With icon" theme="light" level={4} />
+      <DxcTag icon={icon} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With large icon" theme="light" level={4} />
+      <DxcTag icon={largeIcon} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With label" theme="light" level={4} />
+      <DxcTag label="Tag" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With label and icon" theme="light" level={4} />
+      <DxcTag label="Tag" icon="person" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With right icon" theme="light" level={4} />
+      <DxcTag label="Tag" icon="group" labelPosition="before" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Icon background color" theme="light" level={4} />
+      <DxcTag label="Tag" icon={icon} iconBgColor="#fabada" />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-focus">
+      <Title title="With link focused" theme="light" level={4} />
+      <DxcTag icon={icon} label="Tag" linkHref="https://www.dxc.com" />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-focus">
+      <Title title="With action focused" theme="light" level={4} />
+      <DxcTag
+        icon="done"
+        label="Tag"
+        onClick={() => {
+          console.log("click");
+        }}
+      />
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcTag label="Xxsmall" margin="xxsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcTag label="Xsmall" margin="xsmall" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcTag label="Small" margin="small" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcTag label="Medium" margin="medium" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcTag label="Large" margin="large" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcTag label="Xlarge" margin="xlarge" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcTag label="Xxlarge" margin="xxlarge" />
+    </ExampleContainer>
+    <Title title="Sizes" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Small size" theme="light" level={4} />
+      <DxcTag label="Small" size="small" icon={icon} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium size" theme="light" level={4} />
+      <DxcTag label="Medium size medium s" size="medium" icon="person" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium size with ellipsis" theme="light" level={4} />
+      <DxcTag label="Medium size medium si medium" size="medium" icon={icon} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large size" theme="light" level={4} />
+      <DxcTag label="Large size large size large size large size large size" size="large" icon={icon} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large size with ellipsis" theme="light" level={4} />
+      <DxcTag label="Large size large size large size large size large size large size" size="large" icon={icon} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="FillParent size" theme="light" level={4} />
+      <DxcTag label="FillParent" size="fillParent" icon={icon} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="FitContent size" theme="light" level={4} />
+      <DxcTag label="FitContent" size="fitContent" icon={icon} />
+    </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcTag label="Tag" icon={icon} />
+      </HalstackProvider>
+    </ExampleContainer>
+  </>
+);
+
+const LinkTag = () => (
+  <ExampleContainer expanded>
+    <Title title="Hover link tag" theme="light" level={4} />
+    <DxcTag label="Tag" icon={icon} linkHref="https://www.dxc.com" />
+  </ExampleContainer>
+);
+
+export const HoverLinkTag = LinkTag.bind({});
+HoverLinkTag.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  await userEvent.hover(canvas.getByText("Tag"));
+};

package/tag/Tag.test.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _Tag = _interopRequireDefault(require("./Tag.tsx"));
+describe("Tag component tests", function () {
+  test("Tag renders with correct label", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tag["default"], {
+        label: "tag-test"
+      })),
+      getByText = _render.getByText;
+    expect(getByText("tag-test")).toBeTruthy();
+  });
+  test("Tag renders with correct label before", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tag["default"], {
+        label: "tag-test",
+        labelPosition: "before"
+      })),
+      getByText = _render2.getByText;
+    expect(getByText("tag-test")).toBeTruthy();
+  });
+  test("Tag renders with link href", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tag["default"], {
+        label: "tag-test",
+        linkHref: "/test/page"
+      })),
+      getByRole = _render3.getByRole;
+    expect(getByRole("link").getAttribute("href")).toBe("/test/page");
+  });
+  test("Call correct function on click", function () {
+    var onClick = jest.fn();
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tag["default"], {
+        label: "tag-test",
+        onClick: onClick
+      })),
+      getByText = _render4.getByText;
+    _react2.fireEvent.click(getByText("tag-test"));
+    expect(onClick).toHaveBeenCalled();
+  });
+});

package/tag/types.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="react" />
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+type TagCommonProps = {
+    /**
+     * 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;
+    /**
+     * If defined, the tag will be displayed as a button. This function will
+     * be called when the user clicks the tag. Component will show some
+     * visual feedback on hover.
+     */
+    onClick?: () => void;
+    /**
+     * Background color of the icon section of the tag.
+     */
+    iconBgColor?: string;
+    /**
+     * Whether the label should appear after or before the icon.
+     */
+    labelPosition?: "before" | "after";
+    /**
+     * If true, the page is opened in a new browser tab.
+     */
+    newWindow?: 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;
+    /**
+     * Size of the component.
+     */
+    size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+type TagLabelProps = TagCommonProps & {
+    /**
+     * Material Symbol name or SVG element used as the icon that will be placed next to the label.
+     */
+    icon?: string | SVG;
+    /**
+     * Text to be placed next inside the tag.
+     */
+    label: string;
+};
+type TagIconProps = TagCommonProps & {
+    /**
+     * Material Symbol name or SVG element used as the icon that will be placed next to the label.
+     */
+    icon: string | SVG;
+    /**
+     * Text to be placed next inside the tag.
+     */
+    label?: string;
+};
+type Props = TagLabelProps | TagIconProps;
+export default Props;

package/tag/types.js

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

package/text-input/Suggestion.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SuggestionProps } from "./types";
+declare const _default: React.MemoExoticComponent<({ id, value, onClick, suggestion, isLast, visuallyFocused, highlighted, }: SuggestionProps) => JSX.Element>;
+export default _default;

package/text-input/Suggestion.js

@@ -0,0 +1,67 @@
+"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 = _interopRequireWildcard(require("react"));
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+var _templateObject, _templateObject2;
+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 && {}.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 transformSpecialChars = function transformSpecialChars(str) {
+  var specialCharsRegex = /[\\*()\[\]{}+?/]/;
+  var value = str;
+  if (specialCharsRegex.test(value)) {
+    var regexAsString = specialCharsRegex.toString().split("");
+    var uniqueSpecialChars = regexAsString.filter(function (item, index) {
+      return regexAsString.indexOf(item) === index;
+    });
+    uniqueSpecialChars.forEach(function (specialChar) {
+      if (str.includes(specialChar)) value = value.replace(specialChar, "\\" + specialChar);
+    });
+  }
+  return value;
+};
+var Suggestion = function Suggestion(_ref) {
+  var id = _ref.id,
+    value = _ref.value,
+    _onClick = _ref.onClick,
+    suggestion = _ref.suggestion,
+    isLast = _ref.isLast,
+    visuallyFocused = _ref.visuallyFocused,
+    highlighted = _ref.highlighted;
+  var matchedSuggestion = (0, _react.useMemo)(function () {
+    var regEx = new RegExp(transformSpecialChars(value), "i");
+    return {
+      matchedWords: suggestion.match(regEx),
+      noMatchedWords: suggestion.replace(regEx, "")
+    };
+  }, [value, suggestion]);
+  return /*#__PURE__*/_react["default"].createElement(SuggestionContainer, {
+    id: id,
+    onClick: function onClick() {
+      _onClick(suggestion);
+    },
+    visuallyFocused: visuallyFocused,
+    role: "option",
+    "aria-selected": visuallyFocused ? true : undefined
+  }, /*#__PURE__*/_react["default"].createElement(StyledSuggestion, {
+    isLast: isLast,
+    visuallyFocused: visuallyFocused
+  }, highlighted ? /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, /*#__PURE__*/_react["default"].createElement("strong", null, matchedSuggestion.matchedWords), matchedSuggestion.noMatchedWords) : suggestion));
+};
+var SuggestionContainer = _styledComponents["default"].li(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  padding: 0 0.5rem;\n  line-height: 1.715em;\n  cursor: pointer;\n  box-shadow: inset 0 0 0 2px\n    ", ";\n\n  &:hover {\n    background-color: ", ";\n  }\n  &:active {\n    background-color: ", ";\n  }\n"])), function (props) {
+  return props.visuallyFocused ? props.theme.focusListOptionBorderColor : "transparent";
+}, function (props) {
+  return props.theme.hoverListOptionBackgroundColor;
+}, function (props) {
+  return props.theme.activeListOptionBackgroundColor;
+});
+var StyledSuggestion = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  width: 100%;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  padding: 0.25rem 0.5rem 0.188rem 0.5rem;\n  ", ";\n"])), function (props) {
+  return props.isLast || props.visuallyFocused ? "border-bottom: 1px solid transparent" : "border-bottom: 1px solid ".concat(props.theme.listOptionDividerColor);
+});
+var _default = exports["default"] = /*#__PURE__*/_react["default"].memo(Suggestion);

package/text-input/Suggestions.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SuggestionsProps } from "./types";
+declare const _default: React.MemoExoticComponent<({ id, value, suggestions, visualFocusIndex, highlightedSuggestions, searchHasErrors, isSearching, suggestionOnClick, styles, }: SuggestionsProps) => JSX.Element>;
+export default _default;

package/text-input/Suggestions.js

@@ -0,0 +1,94 @@
+"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 = _interopRequireWildcard(require("react"));
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+var _useTranslatedLabels = _interopRequireDefault(require("../useTranslatedLabels"));
+var _Suggestion = _interopRequireDefault(require("./Suggestion"));
+var _Icon = _interopRequireDefault(require("../icon/Icon"));
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
+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 && {}.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 Suggestions = function Suggestions(_ref) {
+  var id = _ref.id,
+    value = _ref.value,
+    suggestions = _ref.suggestions,
+    visualFocusIndex = _ref.visualFocusIndex,
+    highlightedSuggestions = _ref.highlightedSuggestions,
+    searchHasErrors = _ref.searchHasErrors,
+    isSearching = _ref.isSearching,
+    suggestionOnClick = _ref.suggestionOnClick,
+    styles = _ref.styles;
+  var translatedLabels = (0, _useTranslatedLabels["default"])();
+  var listboxRef = (0, _react.useRef)(null);
+  (0, _react.useEffect)(function () {
+    var _listboxRef$current, _visualFocusedOptionE;
+    var visualFocusedOptionEl = listboxRef === null || listboxRef === void 0 ? void 0 : (_listboxRef$current = listboxRef.current) === null || _listboxRef$current === void 0 ? void 0 : _listboxRef$current.querySelectorAll("[role='option']")[visualFocusIndex];
+    visualFocusedOptionEl === null || visualFocusedOptionEl === void 0 ? void 0 : (_visualFocusedOptionE = visualFocusedOptionEl.scrollIntoView) === null || _visualFocusedOptionE === void 0 ? void 0 : _visualFocusedOptionE.call(visualFocusedOptionEl, {
+      block: "nearest",
+      inline: "start"
+    });
+  }, [visualFocusIndex]);
+  return /*#__PURE__*/_react["default"].createElement(SuggestionsContainer, {
+    id: id,
+    error: searchHasErrors ? true : false,
+    onMouseDown: function onMouseDown(event) {
+      event.preventDefault();
+    },
+    ref: listboxRef,
+    role: "listbox",
+    style: styles,
+    "aria-label": "Suggestions"
+  }, !isSearching && !searchHasErrors && suggestions.length > 0 && suggestions.map(function (suggestion, index) {
+    return /*#__PURE__*/_react["default"].createElement(_Suggestion["default"], {
+      key: "".concat(id, "-suggestion-").concat(index),
+      id: "".concat(id, "-suggestion-").concat(index),
+      value: value,
+      onClick: suggestionOnClick,
+      suggestion: suggestion,
+      isLast: index === suggestions.length - 1,
+      visuallyFocused: visualFocusIndex === index,
+      highlighted: highlightedSuggestions
+    });
+  }), isSearching && /*#__PURE__*/_react["default"].createElement(SuggestionsSystemMessage, {
+    role: "option"
+  }, translatedLabels.textInput.searchingMessage), searchHasErrors && /*#__PURE__*/_react["default"].createElement("span", {
+    role: "option"
+  }, /*#__PURE__*/_react["default"].createElement(SuggestionsError, {
+    role: "alert",
+    "aria-live": "assertive"
+  }, /*#__PURE__*/_react["default"].createElement(SuggestionsErrorIcon, null, /*#__PURE__*/_react["default"].createElement(_Icon["default"], {
+    icon: "filled_error"
+  })), translatedLabels.textInput.fetchingDataErrorMessage)));
+};
+var SuggestionsContainer = _styledComponents["default"].ul(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  box-sizing: border-box;\n  max-height: 304px;\n  overflow-y: auto;\n  margin: 0;\n  padding: 0.25rem 0;\n  background-color: ", ";\n  border: 1px solid\n    ", ";\n\n  border-radius: 0.25rem;\n  box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1);\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n"])), function (props) {
+  return props.error ? props.theme.errorListDialogBackgroundColor : props.theme.listDialogBackgroundColor;
+}, function (props) {
+  return props.error ? props.theme.errorListDialogBorderColor : props.theme.listDialogBorderColor;
+}, function (props) {
+  return props.theme.listOptionFontColor;
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.listOptionFontSize;
+}, function (props) {
+  return props.theme.listOptionFontStyle;
+}, function (props) {
+  return props.theme.listOptionFontWeight;
+});
+var SuggestionsSystemMessage = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  padding: 0.25rem 1rem;\n  color: ", ";\n  line-height: 1.715em;\n"])), function (props) {
+  return props.theme.systemMessageFontColor;
+});
+var SuggestionsErrorIcon = _styledComponents["default"].span(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-wrap: wrap;\n  align-content: center;\n  margin-right: 0.5rem;\n  height: 18px;\n  width: 18px;\n  font-size: 18px;\n  color: ", ";\n"])), function (props) {
+  return props.theme.errorIconColor;
+});
+var SuggestionsError = _styledComponents["default"].span(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  padding: 0.25rem 1rem;\n  align-items: center;\n  line-height: 1.715em;\n  color: ", ";\n"])), function (props) {
+  return props.theme.errorListDialogFontColor;
+});
+var _default = exports["default"] = /*#__PURE__*/_react["default"].memo(Suggestions);