@dxc-technology/halstack-react 0.0.0-59b9187 → 0.0.0-5a4d834

package/container/types.d.ts

@@ -43,27 +43,129 @@ type Overflow = OverflowValues | {
     y?: OverflowValues;
 };
 type Props = {
+    /**
+     * Based on the CSS property background allows configuring all properties related to the background of a container.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/background
+     */
+    background?: Background;
+    /**
+     * Based on the CSS property border allows configuring all properties related to the border of a container.
+     */
+    border?: Border;
+    /**
+     * Sets the border-radius CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius
+     */
+    borderRadius?: string;
+    /**
+     * Sets the box-shadow CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/box-shadow
+     */
+    boxShadow?: string;
+    /**
+     * Sets the box-sizing CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/box-sizing
+     */
     boxSizing?: "border-box" | "content-box";
+    /**
+     * Custom content inside the container.
+     */
+    children: React.ReactNode;
+    /**
+     * Sets the display CSS property.
+     * The set of values is limited to the ones related to the outer display type.
+     * If you want to apply any pattern from the inner box and how the children are laid out,
+     * we recommend you to use the Flex and Grid components.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/display
+     */
     display?: "block" | "inline-block" | "inline" | "none";
-    width?: string;
+    /**
+     * Sets the float CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/float
+     */
+    float?: "left" | "right" | "none";
+    /**
+     * Sets the height CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/height
+     */
     height?: string;
+    /**
+     * Based on the CSS property inset this prop is a shorthand that corresponds
+     * to the top, right, bottom, and/or left properties.
+     */
+    inset?: Inset;
+    /**
+     * 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;
+    /**
+     * Sets the max-height CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/max-height
+     */
     maxWidth?: string;
+    /**
+     * Sets the max-width CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/max-width
+     */
     maxHeight?: string;
+    /**
+     * Sets the min-height CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/min-height
+     */
     minWidth?: string;
+    /**
+     * Sets the min-width CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/min-width
+     */
     minHeight?: string;
-    padding?: Space;
-    border?: Border;
-    borderRadius?: string;
-    margin?: Space;
+    /**
+     * Based on the CSS property outline allows configuring all properties related
+     * to the outline of a container.
+     */
+    outline?: Outline;
+    /**
+     * Sets the overflow CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/overflow
+     */
     overflow?: Overflow;
+    /**
+     * 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.
+     */
+    padding?: Space;
+    /**
+     * Sets the position CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/position
+     */
     position?: "static" | "relative" | "absolute" | "fixed" | "sticky";
-    inset?: Inset;
-    float?: "left" | "right" | "none";
+    /**
+     * Sets the width CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/width
+     */
+    width?: string;
+    /**
+     * Sets the z-index CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/z-index
+     */
     zIndex?: "auto" | number;
-    background?: Background;
-    boxShadow?: string;
-    outline?: Outline;
-    children: React.ReactNode;
 };
 export type StyledProps = Omit<Props, "display" | "width" | "height" | "opacity" | "overflow"> & {
     $display?: "block" | "inline-block" | "inline" | "none";

package/contextual-menu/ContextualMenu.accessibility.test.d.ts

@@ -0,0 +1 @@
+export {};

package/contextual-menu/ContextualMenu.accessibility.test.js

@@ -5,8 +5,20 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _react = _interopRequireDefault(require("react"));
 var _react2 = require("@testing-library/react");
-var _jestAxe = require("jest-axe");
+var _axeHelper = require("../../test/accessibility/axe-helper.js");
 var _ContextualMenu = _interopRequireDefault(require("./ContextualMenu"));
+var _Badge = _interopRequireDefault(require("../badge/Badge"));
+var _disabledRules = require("../../test/accessibility/rules/specific/contextual-menu/disabledRules.js");
+// TODO: REMOVE
+
+var disabledRules = {
+  rules: _disabledRules.disabledRules.reduce(function (rulesObj, rule) {
+    rulesObj[rule] = {
+      enabled: false
+    };
+    return rulesObj;
+  }, {})
+};
 var badge_icon = /*#__PURE__*/_react["default"].createElement("svg", {
   width: "24",
   height: "24",
@@ -40,7 +52,7 @@ var fav_icon = /*#__PURE__*/_react["default"].createElement("svg", {
 }));
 var itemsWithTruncatedText = [{
   label: "Item with a very long label that should be truncated",
-  slot: /*#__PURE__*/_react["default"].createElement(_ContextualMenu["default"].Badge, {
+  slot: /*#__PURE__*/_react["default"].createElement(_Badge["default"], {
     color: "blue",
     mode: "contextual",
     label: "Label",
@@ -73,7 +85,7 @@ describe("Context menu accessibility tests", function () {
             items: itemsWithTruncatedText
           })), container = _render.container;
           _context.next = 3;
-          return (0, _jestAxe.axe)(container);
+          return (0, _axeHelper.axe)(container, disabledRules);
         case 3:
           results = _context.sent;
           expect(results).toHaveNoViolations();

package/contextual-menu/ContextualMenu.d.ts

@@ -1,7 +1,5 @@
 import React from "react";
-import MenuPropsType, { BadgeProps as BadgePropsType } from "./types";
-declare const DxcContextualMenu: {
-    ({ items, defaultSelectedItemIndex }: MenuPropsType): React.JSX.Element;
-    Badge(props: BadgePropsType): React.JSX.Element;
-};
+import ContextualMenuPropsType, { ContextualMenuContextProps } from "./types";
+export declare const ContextualMenuContext: React.Context<ContextualMenuContextProps>;
+declare const DxcContextualMenu: ({ items }: ContextualMenuPropsType) => React.JSX.Element;
 export default DxcContextualMenu;

package/contextual-menu/ContextualMenu.js

@@ -5,67 +5,132 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = void 0;
+exports["default"] = exports.ContextualMenuContext = void 0;
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireWildcard(require("react"));
-var _styledComponents = _interopRequireDefault(require("styled-components"));
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
 var _coreTokens = _interopRequireDefault(require("../common/coreTokens"));
-var _Badge = _interopRequireDefault(require("../badge/Badge"));
-var _MenuItemAction = _interopRequireDefault(require("./MenuItemAction"));
-var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
+var _Divider = _interopRequireDefault(require("../divider/Divider"));
+var _Inset = _interopRequireDefault(require("../inset/Inset"));
+var _MenuItem = _interopRequireDefault(require("./MenuItem"));
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+var _templateObject, _templateObject2, _templateObject3;
 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; }
+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; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var ContextualMenuContext = exports.ContextualMenuContext = /*#__PURE__*/(0, _react.createContext)(null);
+var isGroupItem = function isGroupItem(item) {
+  return "items" in item;
+};
+var isSection = function isSection(item) {
+  return "items" in item && !("label" in item);
+};
+var addIdToItems = function addIdToItems(items) {
+  var accId = 0;
+  var innerAddIdToItems = function innerAddIdToItems(items) {
+    return items.map(function (item) {
+      return isSection(item) ? _objectSpread(_objectSpread({}, item), {}, {
+        items: innerAddIdToItems(item.items)
+      }) : isGroupItem(item) ? _objectSpread(_objectSpread({}, item), {}, {
+        items: innerAddIdToItems(item.items)
+      }) : _objectSpread(_objectSpread({}, item), {}, {
+        id: accId++
+      });
+    });
+  };
+  return innerAddIdToItems(items);
+};
 var DxcContextualMenu = function DxcContextualMenu(_ref) {
-  var items = _ref.items,
-    _ref$defaultSelectedI = _ref.defaultSelectedItemIndex,
-    defaultSelectedItemIndex = _ref$defaultSelectedI === void 0 ? -1 : _ref$defaultSelectedI;
-  var _useState = (0, _react.useState)(defaultSelectedItemIndex),
+  var items = _ref.items;
+  var _useState = (0, _react.useState)(-1),
     _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
-    selectedItemIndex = _useState2[0],
-    setSelectedItemIndex = _useState2[1];
-  var renderSingleItem = function renderSingleItem(item, index) {
-    return /*#__PURE__*/_react["default"].createElement(Li, {
-      key: "option-".concat(index),
-      role: "menuitem"
-    }, /*#__PURE__*/_react["default"].createElement(_MenuItemAction["default"], (0, _extends2["default"])({}, item, {
-      selected: selectedItemIndex === index,
-      onSelect: function onSelect() {
-        var _item$onSelect;
-        setSelectedItemIndex(index);
-        (_item$onSelect = item.onSelect) === null || _item$onSelect === void 0 ? void 0 : _item$onSelect.call(item);
-      }
-    })));
-  };
-  var accLength = 0;
-  var renderSection = function renderSection(section, currentSectionIndex, items) {
-    var startingIndex = accLength;
-    accLength += section.items.length;
+    selectedItemId = _useState2[0],
+    setSelectedItemId = _useState2[1];
+  var contextualMenuRef = (0, _react.useRef)(null);
+  var itemsWithId = (0, _react.useMemo)(function () {
+    return addIdToItems(items);
+  }, [items]);
+  var colorsTheme = (0, _useTheme["default"])();
+  var renderSection = function renderSection(section, currentSectionIndex, length) {
     return /*#__PURE__*/_react["default"].createElement(_react.Fragment, {
-      key: "separator-".concat(currentSectionIndex)
-    }, /*#__PURE__*/_react["default"].createElement(Li, {
-      role: "group"
-    }, section.title != null && /*#__PURE__*/_react["default"].createElement(Title, null, section.title), /*#__PURE__*/_react["default"].createElement(Section, null, section.items.map(function (item, index) {
-      return renderSingleItem(item, startingIndex + index);
-    }))), currentSectionIndex !== items.length - 1 && /*#__PURE__*/_react["default"].createElement(Divider, {
-      "aria-hidden": true
-    }));
+      key: "section-".concat(currentSectionIndex)
+    }, /*#__PURE__*/_react["default"].createElement("li", {
+      role: "group",
+      "aria-labelledby": section.title
+    }, section.title != null && /*#__PURE__*/_react["default"].createElement(Title, {
+      id: section.title
+    }, section.title), /*#__PURE__*/_react["default"].createElement(SectionList, null, section.items.map(function (item, index) {
+      return /*#__PURE__*/_react["default"].createElement(_MenuItem["default"], {
+        item: item,
+        key: "".concat(item.label, "-").concat(index)
+      });
+    }))), currentSectionIndex !== length - 1 && /*#__PURE__*/_react["default"].createElement(_Inset["default"], {
+      top: "0.25rem",
+      bottom: "0.25rem"
+    }, /*#__PURE__*/_react["default"].createElement(_Divider["default"], {
+      color: "lightGrey"
+    })));
   };
-  return /*#__PURE__*/_react["default"].createElement(Menu, {
-    role: "menu"
-  }, items.map(function (item, index, items) {
-    return "items" in item ? renderSection(item, index, items) : renderSingleItem(item, index);
-  }));
-};
-var Menu = _styledComponents["default"].ul(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  box-sizing: border-box;\n  margin: 0;\n  border: 1px solid ", ";\n  border-radius: 0.25rem;\n  padding: ", " ", ";\n\n  display: grid;\n  gap: ", ";\n  min-width: 248px;\n  max-height: 100%;\n  background-color: ", ";\n\n  overflow-y: auto;\n  &::-webkit-scrollbar {\n    width: 8px;\n    height: 8px;\n  }\n  &::-webkit-scrollbar-thumb {\n    background-color: ", ";\n    border-radius: 0.25rem;\n  }\n  &::-webkit-scrollbar-track {\n    background-color: ", ";\n    border-radius: 0.25rem;\n  }\n"])), _coreTokens["default"].color_grey_200, _coreTokens["default"].spacing_16, _coreTokens["default"].spacing_8, _coreTokens["default"].spacing_4, _coreTokens["default"].color_white, _coreTokens["default"].color_grey_700, _coreTokens["default"].color_grey_300);
-var Li = _styledComponents["default"].li(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: grid;\n"])));
-var Section = _styledComponents["default"].ul(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  list-style: none;\n  margin: 0;\n  padding: 0;\n  display: grid;\n  gap: ", ";\n"])), _coreTokens["default"].spacing_4);
-var Title = _styledComponents["default"].h2(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  margin: 0 0 ", " 0;\n  padding: ", ";\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-weight: ", ";\n  line-height: 24px;\n\n  & + ul > li > button {\n    padding-left: ", " !important;\n  }\n"])), _coreTokens["default"].spacing_4, _coreTokens["default"].spacing_4, _coreTokens["default"].color_grey_900, _coreTokens["default"].type_sans, _coreTokens["default"].type_scale_03, _coreTokens["default"].type_semibold, _coreTokens["default"].spacing_12);
-var Divider = _styledComponents["default"].hr(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  margin: ", " 0;\n  border: none;\n  height: 1px;\n  background: ", ";\n"])), _coreTokens["default"].spacing_4, _coreTokens["default"].color_grey_200);
-DxcContextualMenu.Badge = function (props) {
-  return /*#__PURE__*/_react["default"].createElement(_Badge["default"], (0, _extends2["default"])({}, props, {
-    size: "small"
-  }));
+  var _useState3 = (0, _react.useState)(true),
+    _useState4 = (0, _slicedToArray2["default"])(_useState3, 2),
+    firstUpdate = _useState4[0],
+    setFirstUpdate = _useState4[1];
+  (0, _react.useLayoutEffect)(function () {
+    if (selectedItemId !== -1 && firstUpdate) {
+      var _contextualMenuEl$scr;
+      var contextualMenuEl = contextualMenuRef === null || contextualMenuRef === void 0 ? void 0 : contextualMenuRef.current;
+      var selectedItemEl = contextualMenuEl === null || contextualMenuEl === void 0 ? void 0 : contextualMenuEl.querySelector("[aria-selected='true']");
+      contextualMenuEl === null || contextualMenuEl === void 0 ? void 0 : (_contextualMenuEl$scr = contextualMenuEl.scrollTo) === null || _contextualMenuEl$scr === void 0 ? void 0 : _contextualMenuEl$scr.call(contextualMenuEl, {
+        top: (selectedItemEl === null || selectedItemEl === void 0 ? void 0 : selectedItemEl.offsetTop) - (contextualMenuEl === null || contextualMenuEl === void 0 ? void 0 : contextualMenuEl.clientHeight) / 2
+      });
+      setFirstUpdate(false);
+    }
+  }, [firstUpdate, selectedItemId]);
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.contextualMenu
+  }, /*#__PURE__*/_react["default"].createElement(ContextualMenu, {
+    role: "menu",
+    ref: contextualMenuRef
+  }, /*#__PURE__*/_react["default"].createElement(ContextualMenuContext.Provider, {
+    value: {
+      selectedItemId: selectedItemId,
+      setSelectedItemId: setSelectedItemId
+    }
+  }, itemsWithId.map(function (item, index) {
+    return "items" in item && !("label" in item) ? renderSection(item, index, itemsWithId.length) : /*#__PURE__*/_react["default"].createElement(_MenuItem["default"], {
+      item: item,
+      key: "".concat(item.label, "-").concat(index)
+    });
+  }))));
 };
+var ContextualMenu = _styledComponents["default"].ul(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  box-sizing: border-box;\n  margin: 0;\n  border: 1px solid ", ";\n  border-radius: 0.25rem;\n  padding: ", " ", ";\n  display: grid;\n  gap: ", ";\n  min-width: 248px;\n  max-height: 100%;\n  background-color: ", ";\n  overflow-y: auto;\n  &::-webkit-scrollbar {\n    width: 8px;\n    height: 8px;\n  }\n  &::-webkit-scrollbar-thumb {\n    background-color: ", ";\n    border-radius: 0.25rem;\n  }\n  &::-webkit-scrollbar-track {\n    background-color: ", ";\n    border-radius: 0.25rem;\n  }\n"])), function (_ref2) {
+  var theme = _ref2.theme;
+  return theme.borderColor;
+}, _coreTokens["default"].spacing_16, _coreTokens["default"].spacing_8, _coreTokens["default"].spacing_4, function (_ref3) {
+  var theme = _ref3.theme;
+  return theme.backgroundColor;
+}, _coreTokens["default"].color_grey_700, _coreTokens["default"].color_grey_300);
+var SectionList = _styledComponents["default"].ul(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  list-style: none;\n  margin: 0;\n  padding: 0;\n  display: grid;\n  gap: ", ";\n"])), _coreTokens["default"].spacing_4);
+var Title = _styledComponents["default"].h2(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  margin: 0 0 ", " 0;\n  padding: ", ";\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: ", ";\n"])), _coreTokens["default"].spacing_4, _coreTokens["default"].spacing_4, function (_ref4) {
+  var theme = _ref4.theme;
+  return theme.sectionTitleFontColor;
+}, function (_ref5) {
+  var theme = _ref5.theme;
+  return theme.fontFamily;
+}, function (_ref6) {
+  var theme = _ref6.theme;
+  return theme.sectionTitleFontSize;
+}, function (_ref7) {
+  var theme = _ref7.theme;
+  return theme.sectionTitleFontStyle;
+}, function (_ref8) {
+  var theme = _ref8.theme;
+  return theme.sectionTitleFontWeight;
+}, function (_ref9) {
+  var theme = _ref9.theme;
+  return theme.sectionTitleLineHeight;
+});
 var _default = exports["default"] = DxcContextualMenu;