@pingux/astro 1.27.0-alpha.25 → 1.27.0-alpha.26

package/lib/cjs/components/Breadcrumbs/BreadcrumbItem.js

@@ -0,0 +1,149 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime-corejs3/helpers/typeof");
+
+var _WeakMap = require("@babel/runtime-corejs3/core-js-stable/weak-map");
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+var _Object$defineProperties = require("@babel/runtime-corejs3/core-js-stable/object/define-properties");
+
+var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors");
+
+var _forEachInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/for-each");
+
+var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor");
+
+var _filterInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/filter");
+
+var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols");
+
+var _Object$keys = require("@babel/runtime-corejs3/core-js-stable/object/keys");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports["default"] = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _breadcrumbs = require("@react-aria/breadcrumbs");
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _utils = require("@react-aria/utils");
+
+var _object = require("lodash/object");
+
+var _hooks = require("../../hooks/");
+
+var _index = require("../../index");
+
+var _react2 = require("@emotion/react");
+
+var _excluded = ["children", "elementType", "onAction", "actionKey", "isCurrent"];
+
+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 || _typeof(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; }
+
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context, _context2; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty(_context = ownKeys(Object(source), !0)).call(_context, function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : _forEachInstanceProperty(_context2 = ownKeys(Object(source))).call(_context2, function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+var BreadcrumbItem = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
+  var children = props.children,
+      elementType = props.elementType,
+      onAction = props.onAction,
+      actionKey = props.actionKey,
+      isCurrent = props.isCurrent,
+      others = (0, _objectWithoutProperties2["default"])(props, _excluded);
+  var itemRef = (0, _react.useRef)();
+  (0, _hooks.usePropWarning)(props, 'disabled', 'isDisabled');
+  /* istanbul ignore next */
+
+  (0, _react.useImperativeHandle)(ref, function () {
+    return itemRef.current;
+  });
+
+  var _useBreadcrumbItem = (0, _breadcrumbs.useBreadcrumbItem)(_objectSpread({}, props), itemRef),
+      itemProps = _useBreadcrumbItem.itemProps;
+
+  var ElementType = (0, _react.useMemo)(function () {
+    switch (elementType) {
+      case 'Button':
+        return _index.Button;
+
+      case 'IconButton':
+        return _index.IconButton;
+
+      case 'Text':
+        return _index.Text;
+
+      case 'Link':
+        if (isCurrent) {
+          return _index.Text;
+        }
+
+        return _index.Link;
+
+      case 'Fragment':
+        return _react.Fragment;
+
+      default:
+        return elementType;
+    }
+  }, [elementType]);
+  var onPressHandler = (0, _react.useCallback)(function () {
+    if (onAction) {
+      onAction(actionKey);
+    }
+  }, [onAction, actionKey]);
+  var elementProps = (0, _react.useMemo)(function () {
+    var _ElementType$propType;
+
+    var elementTypeProps = _objectSpread({}, (0, _utils.mergeProps)(itemProps, others));
+
+    if ((_ElementType$propType = ElementType.propTypes) !== null && _ElementType$propType !== void 0 && _ElementType$propType.onPress) {
+      elementTypeProps.onPress = onPressHandler;
+    }
+
+    if (isCurrent) {
+      elementTypeProps.className = elementTypeProps.className ? "".concat(elementTypeProps.className, " is-current") : 'is-current';
+    }
+
+    return (0, _object.omit)(elementTypeProps, 'onClick', 'onKeyDown', 'onKeyUp');
+  }, [elementType, itemProps, others, onPressHandler]);
+  return /*#__PURE__*/_react["default"].cloneElement((0, _react2.jsx)(ElementType, null), _objectSpread(_objectSpread({}, elementProps), {}, {
+    ref: ref
+  }), children);
+});
+BreadcrumbItem.propTypes = {
+  actionKey: _propTypes["default"].string,
+
+  /** Whether the breadcrumb item represents the current page. */
+  isCurrent: _propTypes["default"].bool,
+
+  /** The HTML element used to render the breadcrumb link, e.g. 'a', or 'span'.
+   * Also can be passed 'Button', 'Icon', 'IconButton', 'Text' - will be used
+   * appropriate component from Astro library.
+   * */
+  elementType: _propTypes["default"].elementType,
+
+  /** Whether the breadcrumb item is disabled. */
+  isDisabled: _propTypes["default"].bool,
+  onAction: _propTypes["default"].func
+};
+BreadcrumbItem.defaultProps = {
+  elementType: 'Link'
+};
+BreadcrumbItem.displayName = 'BreadcrumbItem';
+var _default = BreadcrumbItem;
+exports["default"] = _default;

package/lib/cjs/components/Breadcrumbs/Breadcrumbs.js

@@ -0,0 +1,130 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor");
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+var _typeof = require("@babel/runtime-corejs3/helpers/typeof");
+
+var _WeakMap = require("@babel/runtime-corejs3/core-js-stable/weak-map");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports["default"] = void 0;
+
+var _map = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/map"));
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/extends"));
+
+var _filter = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/filter"));
+
+var _isArray = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/array/is-array"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _breadcrumbs = require("@react-aria/breadcrumbs");
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _utils = require("@react-aria/utils");
+
+var _index = require("../../index");
+
+var _hooks = require("../../hooks/");
+
+var _BreadcrumbItem = _interopRequireDefault(require("./BreadcrumbItem"));
+
+var _react2 = require("@emotion/react");
+
+var _excluded = ["children", "icon", "iconProps", "onAction"];
+
+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 || _typeof(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; }
+
+/**
+ * Breadcrumbs component wrapping an array of `BreadcrumbItem` elements and icon,
+ * which will be rendered between each node, sans last-child
+ *
+ * Utilizes [useBreadcrumbs](https://react-spectrum.adobe.com/react-aria/useBreadcrumbs.html) from React-Aria.
+ * */
+var Breadcrumbs = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
+  var children = props.children,
+      icon = props.icon,
+      iconProps = props.iconProps,
+      onAction = props.onAction,
+      others = (0, _objectWithoutProperties2["default"])(props, _excluded); // the following filters undefined values passed as a child
+
+  var filteredChildren = (0, _isArray["default"])(children) ? (0, _filter["default"])(children).call(children, function (child) {
+    return child;
+  }) : children;
+
+  var _useBreadcrumbs = (0, _breadcrumbs.useBreadcrumbs)(props),
+      wrapperProps = _useBreadcrumbs.navProps;
+
+  var breadcrumbsRef = (0, _react.useRef)();
+  (0, _hooks.usePropWarning)(props, 'disabled', 'isDisabled');
+  /* istanbul ignore next */
+
+  (0, _react.useImperativeHandle)(ref, function () {
+    return breadcrumbsRef.current;
+  });
+  var createBreadcrumb = (0, _react.useCallback)(function (child, idx) {
+    var isCurrentItem = (0, _isArray["default"])(filteredChildren) && filteredChildren.length > 1 ? idx === children.length - 1 : true;
+    return (0, _react2.jsx)(_index.Box, {
+      isRow: true,
+      sx: {
+        alignItems: 'center',
+        minHeight: 42
+      },
+      as: "li",
+      key: "li-".concat(child.key)
+    }, (0, _react2.jsx)(_BreadcrumbItem["default"], (0, _extends2["default"])({
+      "data-id": child['data-id'],
+      isCurrent: isCurrentItem,
+      onAction: onAction,
+      actionKey: child.key,
+      variant: "text.breadcrumbLink"
+    }, child.props), child.props.children), icon && !isCurrentItem && (0, _react2.jsx)(_index.Icon, (0, _extends2["default"])({
+      "aria-hidden": "true",
+      icon: icon,
+      mx: 5,
+      size: 16
+    }, iconProps)));
+  }, [children.length, filteredChildren, icon, iconProps, onAction]);
+  return (0, _react2.jsx)("nav", null, (0, _react2.jsx)(_index.Box, (0, _extends2["default"])({
+    ref: breadcrumbsRef,
+    isRow: true,
+    sx: {
+      paddingInlineStart: 'unset'
+    },
+    as: "ol"
+  }, (0, _utils.mergeProps)(wrapperProps, others)), (0, _isArray["default"])(filteredChildren) ? (0, _map["default"])(filteredChildren).call(filteredChildren, createBreadcrumb) : createBreadcrumb(children)));
+});
+Breadcrumbs.propTypes = {
+  /** The icon to render in between each node. */
+  icon: _propTypes["default"].elementType,
+
+  /** Props object passed along to the Icon component. */
+  iconProps: _propTypes["default"].shape({}),
+
+  /** Whether the Breadcrumbs are disabled. */
+  isDisabled: _propTypes["default"].bool,
+
+  /** Defines a string value that labels the current element. */
+  'aria-label': _propTypes["default"].string,
+
+  /** Called when an item is acted upon (usually selection via press). */
+
+  /** (key: Key) => void. */
+  onAction: _propTypes["default"].func
+};
+Breadcrumbs.displayName = 'Breadcrumbs';
+var _default = Breadcrumbs;
+exports["default"] = _default;

package/lib/cjs/components/Breadcrumbs/Breadcrumbs.stories.js

@@ -0,0 +1,98 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports["default"] = exports.WithSpan = exports.Default = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/extends"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _addonActions = require("@storybook/addon-actions");
+
+var _collections = require("@react-stately/collections");
+
+var _ChevronRightIcon = _interopRequireDefault(require("mdi-react/ChevronRightIcon"));
+
+var _Breadcrumbs = _interopRequireDefault(require("./Breadcrumbs"));
+
+var _react2 = require("@emotion/react");
+
+var _default = {
+  title: 'Breadcrumbs',
+  component: _Breadcrumbs["default"],
+  parameters: {
+    docs: {
+      source: {
+        type: 'code'
+      }
+    }
+  },
+  argTypes: {
+    icon: {
+      control: {
+        type: 'none'
+      },
+      defaultValue: _ChevronRightIcon["default"],
+      description: 'The icon to render. List of icons at https://materialdesignicons.com/'
+    },
+    iconProps: {
+      control: {
+        type: 'none'
+      }
+    }
+  }
+};
+exports["default"] = _default;
+
+var Default = function Default(args) {
+  var onAction = function onAction(key) {
+    return (0, _addonActions.action)("onPress ".concat(key));
+  };
+
+  return (0, _react2.jsx)(_Breadcrumbs["default"], (0, _extends2["default"])({
+    onAction: onAction
+  }, args), (0, _react2.jsx)(_collections.Item, {
+    key: "home",
+    "aria-label": "home",
+    variant: "buttons.link",
+    "data-id": "home",
+    href: "https://www.pingidentity.com"
+  }, "Home"), (0, _react2.jsx)(_collections.Item, {
+    key: "trendy",
+    "aria-label": "trendy",
+    variant: "buttons.link",
+    "data-id": "trendy",
+    href: "https://www.pingidentity.com"
+  }, "Trendy"), (0, _react2.jsx)(_collections.Item, {
+    key: "march 2020 assets",
+    "aria-label": "march-2020-assets",
+    variant: "buttons.link",
+    "data-id": "march",
+    href: "https://www.pingidentity.com"
+  }, "March 2020 Assets"));
+};
+
+exports.Default = Default;
+
+var WithSpan = function WithSpan() {
+  return (0, _react2.jsx)(_Breadcrumbs["default"], {
+    icon: _ChevronRightIcon["default"]
+  }, (0, _react2.jsx)(_collections.Item, {
+    key: "Parent",
+    "aria-label": "parent",
+    elementType: "span"
+  }, "Parent"), (0, _react2.jsx)(_collections.Item, {
+    key: "FonsVernall",
+    "aria-label": "fons-vernall",
+    elementType: "span"
+  }, "Fons Vernall"));
+};
+
+exports.WithSpan = WithSpan;

package/lib/cjs/components/Breadcrumbs/Breadcrumbs.test.js

@@ -0,0 +1,121 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/extends"));
+
+var _map = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/map"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _utils = require("@react-aria/utils");
+
+var _CreateIcon = _interopRequireDefault(require("mdi-react/CreateIcon"));
+
+var _collections = require("@react-stately/collections");
+
+var _ChevronRightIcon = _interopRequireDefault(require("mdi-react/ChevronRightIcon"));
+
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+
+var _Breadcrumbs = _interopRequireDefault(require("./Breadcrumbs"));
+
+var _testAxe = _interopRequireDefault(require("../../utils/testUtils/testAxe"));
+
+var _testWrapper = require("../../utils/testUtils/testWrapper");
+
+var _react2 = require("@emotion/react");
+
+var testId = 'test-breadcrumbs';
+var testItemId = 'test-breadcrumb-item';
+var testIconId = 'test-icon-item';
+var defaultProps = {
+  'data-testid': testId,
+  icon: _ChevronRightIcon["default"]
+};
+var testItemsArr = ['item1', 'item2', 'item3'];
+
+var getComponent = function getComponent() {
+  var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var itemProps = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return (0, _testWrapper.render)((0, _react2.jsx)(_Breadcrumbs["default"], (0, _utils.mergeProps)(defaultProps, props), (0, _map["default"])(testItemsArr).call(testItemsArr, function (testItem, idx) {
+    return (0, _react2.jsx)(_collections.Item, (0, _extends2["default"])({
+      key: testItem,
+      "data-id": testItem
+    }, itemProps, {
+      isCurrent: idx === testItemsArr.length - 1
+    }), testItem);
+  })));
+}; // Need to be added to each test file to test accessibility using axe.
+
+
+(0, _testAxe["default"])(getComponent);
+test('default breadcrumbs', function () {
+  getComponent();
+  expect(_testWrapper.screen.getByTestId(testId)).toBeInTheDocument();
+});
+test('should render nodes from the children', function () {
+  getComponent();
+  expect(_testWrapper.screen.getByText(testItemsArr[0])).toBeInTheDocument();
+  expect(_testWrapper.screen.getByText(testItemsArr[1])).toBeInTheDocument();
+  expect(_testWrapper.screen.getByText(testItemsArr[2])).toBeInTheDocument();
+});
+test('should render correct amount of icons', function () {
+  getComponent({
+    iconProps: {
+      'data-testid': testIconId
+    }
+  });
+  expect(_testWrapper.screen.getAllByTestId(testIconId).length).toBe(testItemsArr.length - 1);
+});
+test('breadcrumbItem should render breadcrumbItem as a Text component when appropriate elementType passed', function () {
+  getComponent({}, {
+    elementType: 'Text',
+    'data-testid': testItemId
+  });
+  expect(_testWrapper.screen.getAllByTestId(testItemId)[0]).toBeInstanceOf(HTMLSpanElement);
+});
+test('breadcrumbItem should render breadcrumbItem as a IconButton component when appropriate elementType passed', function () {
+  getComponent({}, {
+    elementType: 'IconButton',
+    'data-testid': testItemId,
+    icon: _CreateIcon["default"]
+  });
+  expect(_testWrapper.screen.getAllByTestId(testItemId)[0]).toBeInstanceOf(HTMLButtonElement);
+});
+test('breadcrumbItem should render breadcrumbItem as a html tag when appropriate elementType passed', function () {
+  getComponent({}, {
+    elementType: 'a',
+    'data-testid': testItemId,
+    icon: _CreateIcon["default"]
+  });
+  expect(_testWrapper.screen.getAllByTestId(testItemId)[0]).toBeInstanceOf(HTMLAnchorElement);
+});
+test('breadcrumbs will use onAction if provided', function () {
+  var mockOnAction = jest.fn();
+  getComponent({}, {
+    elementType: 'Link',
+    onAction: mockOnAction
+  });
+
+  _userEvent["default"].click(_testWrapper.screen.getByText(testItemsArr[0]));
+
+  expect(mockOnAction).toHaveBeenCalled();
+});
+test('Item accepts a data-id and the data-id can be found in the DOM', function () {
+  getComponent();
+
+  var item = _testWrapper.screen.getByText(testItemsArr[0]);
+
+  expect(item).toBeInTheDocument();
+  expect(item).toHaveAttribute('data-id', testItemsArr[0]);
+});
+test('will render correctly with single child item', function () {
+  (0, _testWrapper.render)((0, _react2.jsx)(_Breadcrumbs["default"], (0, _utils.mergeProps)(defaultProps), (0, _react2.jsx)(_collections.Item, {
+    key: testItemsArr[0],
+    "data-id": testItemsArr[0],
+    isCurrent: true
+  }, testItemsArr[0])));
+  expect(_testWrapper.screen.getByTestId(testId)).toBeInTheDocument();
+  expect(_testWrapper.screen.getByText(testItemsArr[0])).toBeInTheDocument();
+});

package/lib/cjs/components/Breadcrumbs/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+_Object$defineProperty(exports, "BreadcrumbItem", {
+  enumerable: true,
+  get: function get() {
+    return _BreadcrumbItem["default"];
+  }
+});
+
+_Object$defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _Breadcrumbs["default"];
+  }
+});
+
+var _Breadcrumbs = _interopRequireDefault(require("./Breadcrumbs"));
+
+var _BreadcrumbItem = _interopRequireDefault(require("./BreadcrumbItem"));