@enact/limestone 1.3.0

package/PageViews/PageViewsRouter.js

@@ -0,0 +1,150 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PageViewsRouter = PageViewsRouter;
+exports["default"] = void 0;
+var _propTypes = _interopRequireDefault(require("@enact/core/internal/prop-types"));
+var _useChainRefs = _interopRequireDefault(require("@enact/core/useChainRefs"));
+var _propTypes2 = _interopRequireDefault(require("prop-types"));
+var _react = require("react");
+var _Panels = require("../internal/Panels");
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["autoFocus", "children", "componentRef", "data-spotlight-id", "index", "onTransition", "onWillTransition", "rtl"],
+  _excluded2 = ["onWillTransition"]; // single-index ViewManagers need some help knowing when the transition direction needs to change
+// because the index is always 0 from its perspective.
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+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) { _defineProperty(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; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+function useReverseTransition(index, rtl) {
+  var prevIndex = (0, _react.useRef)(index);
+  var reverse = false;
+  if (prevIndex.current !== index) {
+    reverse = rtl ? index > prevIndex.current : index < prevIndex.current;
+  }
+  prevIndex.current = index;
+  return {
+    reverseTransition: reverse
+  };
+}
+
+/**
+ * PageViewsRouter passes children, index and transition handlers
+ *
+ * @class PageViewsRouter
+ * @memberof limestone/PageViews
+ * @private
+ */
+function PageViewsRouter(Wrapped) {
+  var PageViewsProvider = function PageViewsProvider(_ref) {
+    var autoFocus = _ref.autoFocus,
+      children = _ref.children,
+      componentRef = _ref.componentRef,
+      spotlightId = _ref['data-spotlight-id'],
+      _ref$index = _ref.index,
+      index = _ref$index === void 0 ? 0 : _ref$index,
+      onTransition = _ref.onTransition,
+      onWillTransition = _ref.onWillTransition,
+      rtl = _ref.rtl,
+      rest = _objectWithoutProperties(_ref, _excluded);
+    var totalIndex = _react.Children.count(children);
+    var _useToggleRole = (0, _Panels.useToggleRole)(),
+      a11yRef = _useToggleRole.ref,
+      a11yOnWillTransition = _useToggleRole.onWillTransition;
+    var autoFocusRef = (0, _Panels.useAutoFocus)({
+      autoFocus: autoFocus
+    });
+    var ref = (0, _useChainRefs["default"])(autoFocusRef, a11yRef, componentRef);
+    var _useReverseTransition = useReverseTransition(index, rtl),
+      reverseTransition = _useReverseTransition.reverseTransition;
+    var _useFocusOnTransition = (0, _Panels.useFocusOnTransition)({
+        onTransition: onTransition,
+        onWillTransition: onWillTransition,
+        spotlightId: spotlightId
+      }),
+      focusOnWillTransition = _useFocusOnTransition.onWillTransition,
+      transition = _objectWithoutProperties(_useFocusOnTransition, _excluded2);
+    var handleWillTransition = (0, _react.useCallback)(function (ev) {
+      focusOnWillTransition(ev);
+      a11yOnWillTransition(ev);
+    }, [a11yOnWillTransition, focusOnWillTransition]);
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(Wrapped, _objectSpread(_objectSpread(_objectSpread({}, rest), transition), {}, {
+      componentRef: ref,
+      "data-spotlight-id": spotlightId,
+      index: index,
+      totalIndex: totalIndex,
+      onWillTransition: handleWillTransition,
+      reverseTransition: reverseTransition,
+      children: children
+    }));
+  };
+  PageViewsProvider.propTypes = /** @lends limestone/PageViews.PageViewsRouter.prototype */{
+    /**
+     * Sets the strategy used to automatically focus an element within the PageViews upon render.
+     * When set to 'none', focus is not set only on the first render.
+     *
+     * @type {('default-element'|'last-focused'|'none'|String)}
+     * @default 'last-focused'
+     * @private
+     */
+    autoFocus: _propTypes2["default"].string,
+    /**
+     * Obtains a reference to the root node.
+     *
+     * @type {Function|Object}
+     * @private
+     */
+    componentRef: _propTypes["default"].ref,
+    /**
+    * The spotlight id for the panel.
+    *
+    * @type {String}
+    * @private
+    */
+    'data-spotlight-id': _propTypes2["default"].string,
+    /**
+    * The currently selected step.
+    *
+    * @type {Number}
+    * @default 0
+    * @private
+    */
+    index: _propTypes2["default"].number,
+    /**
+     * Disables panel transitions.
+     *
+     * @type {Boolean}
+     * @public
+     */
+    noAnimation: _propTypes2["default"].bool,
+    /**
+    * Called when a transition completes.
+    *
+    * @type {Function}
+    * @private
+    */
+    onTransition: _propTypes2["default"].func,
+    /**
+    * Called when a transition begins.
+    *
+    * @type {Function}
+    * @private
+    */
+    onWillTransition: _propTypes2["default"].func,
+    /**
+     * Used to determine the transition direction.
+     *
+     * @type {Boolean}
+     * @private
+     */
+    rtl: _propTypes2["default"].bool
+  };
+  return PageViewsProvider;
+}
+var _default = exports["default"] = PageViewsRouter;

package/PageViews/index.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Page", {
+  enumerable: true,
+  get: function get() {
+    return _Page["default"];
+  }
+});
+Object.defineProperty(exports, "PageViews", {
+  enumerable: true,
+  get: function get() {
+    return _PageViews.PageViews;
+  }
+});
+exports["default"] = void 0;
+var _PageViews = require("./PageViews");
+var _Page = _interopRequireDefault(require("./Page"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+/**
+ * Provides a Limestone styled pages component with page indicator and navigation buttons.
+ *
+ * Usage:
+ * ```
+ * <PageViews>
+ *		<PageViews.Page aria-label="This is a description for page">
+ *			lorem ipsum ...
+ *		</PageViews.Page>
+ * </PageViews>
+ * ```
+ * @module limestone/PageViews
+ * @exports PageViews
+ */
+
+/**
+ * A shortcut to access {@link limestone/PageViews.Page}
+ *
+ * @name Page
+ * @static
+ * @memberof limestone/PageViews.PageViews
+ */
+_PageViews.PageViews.Page = _Page["default"];
+var _default = exports["default"] = _PageViews.PageViews;

package/PageViews/tests/PageViews-specs.js

@@ -0,0 +1,192 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _react = require("@testing-library/react");
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+var _ = require("../");
+var _jsxRuntime = require("react/jsx-runtime");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+describe('PageViews Specs', function () {
+  test('should show next button and hide previous button on the first page', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+      index: 0,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      })]
+    }));
+    var nextButton = _react.screen.getByLabelText('Next');
+    var prevButton = _react.screen.queryByLabelText('Previous');
+    expect(nextButton).toBeInTheDocument();
+    expect(prevButton).toBeNull();
+  });
+  test('should show next button and hide previous button on the first page when pageIndicatorType is `number`', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+      pageIndicatorType: "number",
+      index: 0,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      })]
+    }));
+    var nextButton = _react.screen.getByLabelText('Next');
+    var prevButton = _react.screen.queryByLabelText('Previous');
+    expect(nextButton).toBeInTheDocument();
+    expect(prevButton).toBeNull();
+  });
+  test('should show previous button and hide next button on the last page', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+      index: 1,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      })]
+    }));
+    var prevButton = _react.screen.getByLabelText('Previous');
+    var nextButton = _react.screen.queryByLabelText('Next');
+    expect(prevButton).toBeInTheDocument();
+    expect(nextButton).toBeNull();
+  });
+  test('should show previous button and hide next button on the last page when pageIndicatorType is `number`', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+      pageIndicatorType: "number",
+      index: 1,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      })]
+    }));
+    var prevButton = _react.screen.getByLabelText('Previous');
+    var nextButton = _react.screen.queryByLabelText('Next');
+    expect(prevButton).toBeInTheDocument();
+    expect(nextButton).toBeNull();
+  });
+  test('should fire onTransition with target index and type', /*#__PURE__*/_asyncToGenerator(function* () {
+    var spy = jest.fn();
+    var index = 0;
+    var _render = (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+        index: index,
+        onTransition: spy,
+        noAnimation: true,
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+          children: "I got contents"
+        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+          children: "I got contents2"
+        })]
+      })),
+      rerender = _render.rerender;
+    spy.mockClear();
+    index++;
+    rerender(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+      index: index,
+      onTransition: spy,
+      noAnimation: true,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents2"
+      })]
+    }));
+    var expected = {
+      index: index,
+      type: 'onTransition'
+    };
+    var actual = spy.mock.calls.length && spy.mock.calls[0][0];
+    yield (0, _react.waitFor)(function () {
+      expect(actual).toMatchObject(expected);
+    });
+  }));
+  test('should fire onWillTransition with target index and type', /*#__PURE__*/_asyncToGenerator(function* () {
+    var spy = jest.fn();
+    var index = 0;
+    var _render2 = (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+        index: index,
+        onWillTransition: spy,
+        noAnimation: true,
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+          children: "I got contents"
+        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+          children: "I got contents2"
+        })]
+      })),
+      rerender = _render2.rerender;
+    spy.mockClear();
+    index++;
+    rerender(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+      index: index,
+      onWillTransition: spy,
+      noAnimation: true,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents"
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {
+        children: "I got contents2"
+      })]
+    }));
+    var expected = {
+      index: index,
+      type: 'onWillTransition'
+    };
+    var actual = spy.mock.calls.length && spy.mock.calls[0][0];
+    yield (0, _react.waitFor)(function () {
+      expect(actual).toMatchObject(expected);
+    });
+  }));
+  test('should fire `onNextClick` and `onChange` with type when go to the next page', /*#__PURE__*/_asyncToGenerator(function* () {
+    var handleChange = jest.fn();
+    var handleNextClick = jest.fn();
+    var user = _userEvent["default"].setup();
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+      index: 1,
+      onChange: handleChange,
+      onNextClick: handleNextClick,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {}), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {}), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {})]
+    }));
+    var nextButton = _react.screen.getByLabelText('Next');
+    var expected = {
+      type: 'onNextClick'
+    };
+    yield user.click(nextButton);
+    yield (0, _react.waitFor)(function () {
+      expect(handleChange).toHaveBeenCalledWith({
+        index: 2,
+        type: 'onChange'
+      });
+    });
+    yield (0, _react.waitFor)(function () {
+      var actual = handleNextClick.mock.calls.length && handleNextClick.mock.calls[0][0];
+      expect(actual).toMatchObject(expected);
+    });
+  }));
+  test('should fire `onPrevClick` and `onChange` with type when go to the previous page', /*#__PURE__*/_asyncToGenerator(function* () {
+    var handleChange = jest.fn();
+    var handlePrevClick = jest.fn();
+    var user = _userEvent["default"].setup();
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsxs)(_.PageViews, {
+      index: 2,
+      onChange: handleChange,
+      onPrevClick: handlePrevClick,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {}), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {}), /*#__PURE__*/(0, _jsxRuntime.jsx)(_.Page, {})]
+    }));
+    var prevButton = _react.screen.getByLabelText('Previous');
+    var expected = {
+      type: 'onPrevClick'
+    };
+    yield user.click(prevButton);
+    yield (0, _react.waitFor)(function () {
+      expect(handleChange).toHaveBeenCalledWith({
+        index: 1,
+        type: 'onChange'
+      });
+    });
+    yield (0, _react.waitFor)(function () {
+      var actual = handlePrevClick.mock.calls.length && handlePrevClick.mock.calls[0][0];
+      expect(actual).toMatchObject(expected);
+    });
+  }));
+});