@enact/limestone 1.3.0

package/FlexiblePopupPanels/Panel.js

@@ -0,0 +1,256 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.PanelBase = exports.Panel = void 0;
+var _handle = _interopRequireWildcard(require("@enact/core/handle"));
+var _kind = _interopRequireDefault(require("@enact/core/kind"));
+var _Layout = require("@enact/ui/Layout");
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _$L = _interopRequireDefault(require("../internal/$L"));
+var _Panels = require("../internal/Panels");
+var _Panel = require("../Panels/Panel");
+var _FlexiblePopupPanelsModule = _interopRequireDefault(require("./FlexiblePopupPanels.module.css"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["children", "nextButton", "nextButtonVisibility", "onNextClick", "onPrevClick", "prevButton", "prevButtonVisibility", "contentCellSize"];
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, "default": e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+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 clamp(val, total) {
+  // The extra two `total` values here accommodate negative values
+  return (val % total + total) % total;
+}
+
+/**
+ * The standard view container used inside a {@link limestone/FlexiblePopupPanels.FlexiblePopupPanels|FlexiblePopupPanels} view
+ * manager instance.
+ *
+ * @class Panel
+ * @extends limestone/Panels.Panel
+ * @memberof limestone/FlexiblePopupPanels
+ * @ui
+ * @public
+ */
+var PanelBase = exports.PanelBase = (0, _kind["default"])({
+  name: 'Panel',
+  contextType: _Panels.PanelsStateContext,
+  propTypes: /** @lends limestone/FlexiblePopupPanels.Panel.prototype */{
+    /**
+     * The button to use in place of the standard next button.
+     *
+     * This prop accepts a component (e.g. `Button`), a component instance or a boolean value.
+     *
+     * If `false`, the button will not show. If set to a component, or `true`, the button will
+     * show. This will override the setting of
+     * {@link limestone/FlexiblePopupPanels.FlexiblePopupPanels.nextButtonVisibility|nextButtonVisibility}.
+     *
+     * Example:
+     * ```
+     * nextButton={<Button icon="closex" aria-label="Quit">Close</Button>}
+     * ```
+     *
+     * @type {Boolean|Component}
+     * @public
+     */
+    nextButton: _propTypes["default"].any,
+    /**
+     * Specifies when and how to show `nextButton` on `FlexiblePopupPanels.Panel`.
+     *
+     * * `'auto'` will display the `nextButton` if more than one `FlexiblePopupPanels.Panel` exists
+     * * `'always'` will always display the `nextButton`
+     * * `'never'` will always hide the `nextButton`
+     *
+     * Note, children values will override the generalized parent visibility settings. In this
+     * case, a customized `nextButton` on `FlexiblePopupPanels.Panel` will take precedence over the
+     * `nextButtonVisibility` value.
+     *
+     * @type {('auto'|'always'|'never')}
+     * @default 'auto'
+     * @private
+     */
+    nextButtonVisibility: _propTypes["default"].oneOf(['auto', 'always', 'never']),
+    /**
+     * Called when the index value is changed.
+     *
+     * @type {Function}
+     * @private
+     */
+    onChange: _propTypes["default"].func,
+    /**
+     * Called when the next button is clicked in `FlexiblePopupPanels.Panel`.
+     *
+     * Calling `preventDefault` on the passed event will prevent advancing to the next panel.
+     *
+     * @type {Function}
+     * @private
+     */
+    onNextClick: _propTypes["default"].func,
+    /**
+     * Called when the previous button is clicked in `FlexiblePopupPanels.Panel`.
+     *
+     * Calling `preventDefault` on the passed event will prevent navigation to the previous panel.
+     *
+     * @type {Function}
+     * @private
+     */
+    onPrevClick: _propTypes["default"].func,
+    /**
+     * The button to use in place of the standard prev button.
+     *
+     * This prop accepts a component (e.g. `Button`), a component instance or a boolean value.
+     *
+     * If `false`, the button will not show. If set to a component, or `true`, the button will
+     * show. This will override the setting of
+     * {@link limestone/FlexiblePopupPanels.FlexiblePopupPanels.prevButtonVisibility|prevButtonVisibility}.
+     *
+     * Example:
+     * ```
+     * prevButton={<Button icon="closex" aria-label="Back">Back</Button>}
+     * ```
+     *
+     * @type {Boolean|Component}
+     * @public
+     */
+    prevButton: _propTypes["default"].any,
+    /**
+     * Specifies when and how to show `prevButton` on `FlexiblePopupPanels.Panel`.
+     *
+     * * `'auto'` will display the `prevButton` if more than one `FlexiblePopupPanels.Panel` exists
+     * * `'always'` will always display the `prevButton`
+     * * `'never'` will always hide the `prevButton`
+     *
+     * Note, children values will override the generalized parent visibility settings. In this case,
+     * if user provides a customized `prevButton` on `FlexiblePopupPanels.Panel` will take precedence over the `prevButtonVisibility` value.
+     *
+     * @type {('auto'|'always'|'never')}
+     * @default 'auto'
+     * @private
+     */
+    prevButtonVisibility: _propTypes["default"].oneOf(['auto', 'always', 'never']),
+    /**
+     * Sets a pre-determined width on this panel.
+     *
+     * The 'auto' value will attempt to adjust the panel size to the content size.
+     * Note: the `title` may not match in width.
+     *
+     * @type {('auto'|'small'|'large')}
+     * @default 'auto'
+     * @public
+     */
+    size: _propTypes["default"].oneOf(['auto', 'small', 'large'])
+  },
+  defaultProps: {
+    size: 'auto'
+  },
+  styles: {
+    css: _FlexiblePopupPanelsModule["default"]
+  },
+  handlers: {
+    onNextClick: (0, _handle["default"])((0, _handle.forwardCustomWithPrevent)('onNextClick'), (0, _handle.forwardCustom)('onChange', function (ev, props, _ref) {
+      var count = _ref.count,
+        index = _ref.index;
+      return {
+        index: clamp(index + 1, count)
+      };
+    }) // wrap around
+    ),
+    onPrevClick: (0, _handle["default"])((0, _handle.forwardCustomWithPrevent)('onPrevClick'), (0, _handle.forwardCustom)('onChange', function (ev, props, _ref2) {
+      var count = _ref2.count,
+        index = _ref2.index;
+      return {
+        index: clamp(index - 1, count)
+      };
+    }) // wrap around
+    )
+  },
+  computed: {
+    className: function className(_ref3) {
+      var size = _ref3.size,
+        styler = _ref3.styler;
+      return styler.append(size);
+    },
+    contentCellSize: function contentCellSize(_ref4) {
+      var size = _ref4.size;
+      // These values must be kept in sync with their LESS variable counterparts
+      switch (size) {
+        case 'small':
+          return 600;
+        case 'large':
+          return 1320;
+        default:
+          return null;
+      }
+    }
+  },
+  render: function render(_ref5, _ref6) {
+    var children = _ref5.children,
+      nextButton = _ref5.nextButton,
+      nextButtonVisibility = _ref5.nextButtonVisibility,
+      onNextClick = _ref5.onNextClick,
+      onPrevClick = _ref5.onPrevClick,
+      prevButton = _ref5.prevButton,
+      prevButtonVisibility = _ref5.prevButtonVisibility,
+      contentCellSize = _ref5.contentCellSize,
+      rest = _objectWithoutProperties(_ref5, _excluded);
+    var count = _ref6.count;
+    var isPrevButtonVisible = Boolean(prevButtonVisibility === 'always' || prevButtonVisibility === 'auto' && count > 1);
+    var isNextButtonVisible = Boolean(nextButtonVisibility === 'always' || nextButtonVisibility === 'auto' && count > 1);
+    delete rest.onChange;
+    delete rest.size;
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Panel.PanelBase, _objectSpread(_objectSpread({}, rest), {}, {
+      css: _FlexiblePopupPanelsModule["default"],
+      children: /*#__PURE__*/(0, _jsxRuntime.jsxs)(_Layout.Row, {
+        className: _FlexiblePopupPanelsModule["default"].bodyLayout,
+        inline: true,
+        children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_Layout.Cell, {
+          align: "center",
+          shrink: true,
+          className: _FlexiblePopupPanelsModule["default"].navCellBefore,
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Panels.NavigationButton, {
+            "aria-label": (0, _$L["default"])('Previous'),
+            backgroundOpacity: "opaque",
+            component: prevButton,
+            className: _FlexiblePopupPanelsModule["default"].navButton,
+            icon: "arrowlargeleft",
+            iconFlip: "auto",
+            onClick: onPrevClick,
+            size: "small",
+            visible: isPrevButtonVisible
+          })
+        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Layout.Cell, {
+          className: _FlexiblePopupPanelsModule["default"].content,
+          shrink: !contentCellSize,
+          size: contentCellSize,
+          children: children
+        }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_Layout.Cell, {
+          align: "center",
+          shrink: true,
+          className: _FlexiblePopupPanelsModule["default"].navCellAfter,
+          children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_Panels.NavigationButton, {
+            "aria-label": (0, _$L["default"])('Next'),
+            backgroundOpacity: "opaque",
+            component: nextButton,
+            className: _FlexiblePopupPanelsModule["default"].navButton,
+            icon: "arrowlargeright",
+            iconFlip: "auto",
+            onClick: onNextClick,
+            size: "small",
+            visible: isNextButtonVisible
+          })
+        })]
+      })
+    }));
+  }
+});
+var Panel = exports.Panel = (0, _Panel.PanelDecorator)({
+  // favor content but fall back to body if the content lacks spottable elements
+  defaultElement: [".".concat(_FlexiblePopupPanelsModule["default"].content, " *"), ".".concat(_FlexiblePopupPanelsModule["default"].body, " *")]
+}, PanelBase);
+var _default = exports["default"] = Panel;

package/FlexiblePopupPanels/index.d.ts

@@ -0,0 +1,145 @@
+// Type definitions for limestone/FlexiblePopupPanels
+
+import { HeaderProps as limestone_Panels_HeaderProps } from "limestone/Panels";
+import { PanelProps as limestone_Panels_PanelProps } from "limestone/Panels";
+import * as React from "react";
+
+type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
+
+export interface FlexiblePopupPanelsProps {
+  /**
+ * Specifies when and how to show  `nextButton`  on  `FlexiblePopupPanels.Panel` .
+ * *  `'auto'`  will display the  `nextButton`  if more than one  `FlexiblePopupPanels.Panel`  exists
+ * *  `'always'`  will always display the  `nextButton`
+ * *  `'never'`  will always hide the  `nextButton`
+ * 
+ * Note, children values will override the generalized parent visibility settings. In this
+case, a customized  `nextButton`  on  `FlexiblePopupPanels.Panel`  will take precedence over the
+ `nextButtonVisibility`  value.
+ */
+  nextButtonVisibility?: "auto" | "always" | "never";
+  /**
+   * Called when the index value is changed.
+   */
+  onChange?: Function;
+  /**
+   * Called when the next button is clicked in  `FlexiblePopupPanels.Panel` .
+   *
+   * Calling  `preventDefault`  on the passed event will prevent advancing to the next panel.
+   */
+  onNextClick?: Function;
+  /**
+   * Called when the previous button is clicked in  `FlexiblePopupPanels.Panel` .
+   *
+   * Calling  `preventDefault`  on the passed event will prevent navigation to the previous panel.
+   */
+  onPrevClick?: Function;
+  /**
+ * Specifies when and how to show  `prevButton`  on  `FlexiblePopupPanels.Panel` .
+ * *  `'auto'`  will display the  `prevButton`  if more than one  `FlexiblePopupPanels.Panel`  exists
+ * *  `'always'`  will always display the  `prevButton`
+ * *  `'never'`  will always hide the  `prevButton`
+ * 
+ * Note, children values will override the generalized parent visibility settings. In this case,
+if user provides a customized  `prevButton`  on  `FlexiblePopupPanels.Panel`  will take precedence over the  `prevButtonVisibility`  value.
+ */
+  prevButtonVisibility?: "auto" | "always" | "never";
+}
+/**
+ * An instance of    which restricts the  `Panel`  to the left
+or right side of the screen inside a popup. This panel flexes both horizontally and vertically,
+with the Header positioned outside the Panel background area. This is typically used for a single
+setting or control at a time, for maximum background area viewing.
+ */
+
+export class FlexiblePopupPanels extends React.Component<
+  Merge<React.HTMLProps<HTMLElement>, FlexiblePopupPanelsProps>
+> {
+  /**
+   * A shortcut to access
+   */
+  Panel: Panel;
+
+  /**
+   * A shortcut to access
+   */
+  Header: Header;
+}
+
+export interface HeaderProps extends limestone_Panels_HeaderProps {
+  /**
+   * Hint string read when focusing the application close button.
+   */
+  closeButtonAriaLabel?: string;
+  /**
+   * Background opacity of the application close button.
+   */
+  closeButtonBackgroundOpacity?: "opaque" | "transparent";
+  /**
+   * Omits the close button.
+   */
+  noCloseButton?: boolean;
+  /**
+   * Called when the app close button is clicked.
+   */
+  onClose?: Function;
+}
+/**
+ * A header component for  `FlexiblePopupPanels.Panel`  with a  `title`  and  `subtitle` , supporting several configurable
+   for components.
+ */
+
+export class Header extends React.Component<
+  Merge<React.HTMLProps<HTMLElement>, HeaderProps>
+> {}
+
+export interface PanelProps extends limestone_Panels_PanelProps {
+  /**
+ * The button to use in place of the standard next button.
+ * 
+ * This prop accepts a component (e.g.  `Button` ), a component instance or a boolean value.
+ * 
+ * If  `false` , the button will not show. If set to a component, or  `true` , the button will
+show. This will override the setting of
+  .
+ * 
+ * Example:
+ * ```
+nextButton={<Button icon="closex" aria-label="Quit">Close</Button>}
+```
+ */
+  nextButton?: boolean | React.ComponentType;
+  /**
+ * The button to use in place of the standard prev button.
+ * 
+ * This prop accepts a component (e.g.  `Button` ), a component instance or a boolean value.
+ * 
+ * If  `false` , the button will not show. If set to a component, or  `true` , the button will
+show. This will override the setting of
+  .
+ * 
+ * Example:
+ * ```
+prevButton={<Button icon="closex" aria-label="Back">Back</Button>}
+```
+ */
+  prevButton?: boolean | React.ComponentType;
+  /**
+ * Sets a pre-determined width on this panel.
+ * 
+ * The 'auto' value will attempt to adjust the panel size to the content size.
+Note: the  `title`  may not match in width.
+ */
+  size?: "auto" | "small" | "large";
+}
+/**
+ * The standard view container used inside a    view
+manager instance.
+ */
+
+export class Panel extends React.Component<
+  Merge<React.HTMLProps<HTMLElement>, PanelProps>
+> {}
+
+export default FlexiblePopupPanels;

package/FlexiblePopupPanels/index.js

@@ -0,0 +1,68 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "FlexiblePopupPanels", {
+  enumerable: true,
+  get: function get() {
+    return _FlexiblePopupPanels.FlexiblePopupPanels;
+  }
+});
+Object.defineProperty(exports, "FlexiblePopupPanelsBase", {
+  enumerable: true,
+  get: function get() {
+    return _FlexiblePopupPanels.FlexiblePopupPanelsBase;
+  }
+});
+Object.defineProperty(exports, "Header", {
+  enumerable: true,
+  get: function get() {
+    return _Header["default"];
+  }
+});
+Object.defineProperty(exports, "Panel", {
+  enumerable: true,
+  get: function get() {
+    return _Panel["default"];
+  }
+});
+Object.defineProperty(exports, "PanelBase", {
+  enumerable: true,
+  get: function get() {
+    return _Panel.PanelBase;
+  }
+});
+exports["default"] = void 0;
+var _FlexiblePopupPanels = require("./FlexiblePopupPanels");
+var _Header = _interopRequireDefault(require("./Header"));
+var _Panel = _interopRequireWildcard(require("./Panel"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, "default": e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+/**
+ * Provides a Limestone styled flexible-width, popup-styled Panels component.
+ *
+ * @module limestone/FlexiblePopupPanels
+ * @exports FlexiblePopupPanels
+ * @exports Header
+ * @exports Panel
+ */
+
+/**
+ * A shortcut to access {@link limestone/FlexiblePopupPanels.Panel}
+ *
+ * @name Panel
+ * @static
+ * @memberof limestone/FlexiblePopupPanels.FlexiblePopupPanels
+ */
+_FlexiblePopupPanels.FlexiblePopupPanels.Panel = _Panel["default"];
+
+/**
+ * A shortcut to access {@link limestone/FlexiblePopupPanels.Header}
+ *
+ * @name Header
+ * @static
+ * @memberof limestone/FlexiblePopupPanels.FlexiblePopupPanels
+ */
+_FlexiblePopupPanels.FlexiblePopupPanels.Header = _Header["default"];
+var _default = exports["default"] = _FlexiblePopupPanels.FlexiblePopupPanels;

package/FlexiblePopupPanels/package.json

@@ -0,0 +1,3 @@
+{
+	"main": "index.js"
+}