@enact/limestone 1.3.0

package/TooltipDecorator/useTooltip.js

@@ -0,0 +1,278 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useTooltip = exports.defaultScreenEdgeKeepout = exports["default"] = void 0;
+var _handle = require("@enact/core/handle");
+var _util = require("@enact/core/util");
+var _I18nDecorator = require("@enact/i18n/I18nDecorator");
+var _FloatingLayer = require("@enact/ui/FloatingLayer");
+var _resolution = _interopRequireDefault(require("@enact/ui/resolution"));
+var _react = require("react");
+var _Tooltip = require("./Tooltip");
+var _util2 = require("./util");
+var _jsxRuntime = require("react/jsx-runtime");
+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 _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function _objectDestructuringEmpty(t) { if (null == t) throw new TypeError("Cannot destructure " + t); } /* global MutationObserver ResizeObserver */
+var currentTooltip; // needed to know whether we should stop a showing job when unmounting
+
+var getTooltipDirection = function getTooltipDirection(tooltipPosition, tooltipType) {
+  var position = tooltipPosition || (0, _Tooltip.defaultDirection)(tooltipType) + ' ' + (0, _Tooltip.defaultArrowAnchor)(tooltipType);
+  var arr = position.split(' ');
+  if (arr.length === 2) {
+    return {
+      tooltipDirection: arr[0],
+      arrowAnchor: arr[1]
+    };
+  } else {
+    return {
+      tooltipDirection: position === 'below' ? 'below' : 'above',
+      arrowAnchor: 'right'
+    };
+  }
+};
+var removeTooltipProps = function removeTooltipProps(_ref) {
+  var props = Object.assign({}, (_objectDestructuringEmpty(_ref), _ref));
+  delete props.rtl;
+  delete props.screenEdgeKeepout;
+  delete props.tooltipDelay;
+  delete props.tooltipMarquee;
+  delete props.tooltipPosition;
+  delete props.tooltipProps;
+  delete props.tooltipRelative;
+  delete props.tooltipText;
+  delete props.tooltipType;
+  delete props.tooltipUpdateDelay;
+  delete props.tooltipWidth;
+  return props;
+};
+
+/*
+ * The boundary around the screen which the tooltip should never cross, typically involving
+ * flipping to an alternate orientation or adjusting its offset to remain on screen.
+ * The default of 48 is derived from a standard 24px screen-keepout size plus the standard
+ * Spotlight-outset (24px) margin/padding value which keeps elements and text aligned inside a
+ * Panel. Note: This value will be scaled according to the resolution.
+ */
+var defaultScreenEdgeKeepout = exports.defaultScreenEdgeKeepout = 24 + 24;
+
+// A hook to show Limestone-styled tooltip components.
+var useTooltip = exports.useTooltip = function useTooltip(props) {
+  var _useI18nContext;
+  var _props$screenEdgeKeep = props.screenEdgeKeepout,
+    screenEdgeKeepout = _props$screenEdgeKeep === void 0 ? defaultScreenEdgeKeepout : _props$screenEdgeKeep,
+    _props$tooltipDelay = props.tooltipDelay,
+    tooltipDelay = _props$tooltipDelay === void 0 ? 500 : _props$tooltipDelay,
+    _props$tooltipType = props.tooltipType,
+    tooltipType = _props$tooltipType === void 0 ? 'balloon' : _props$tooltipType,
+    _props$tooltipUpdateD = props.tooltipUpdateDelay,
+    tooltipUpdateDelay = _props$tooltipUpdateD === void 0 ? 400 : _props$tooltipUpdateD,
+    tooltipMarquee = props.tooltipMarquee,
+    tooltipPosition = props.tooltipPosition,
+    tooltipProps = props.tooltipProps,
+    tooltipRelative = props.tooltipRelative,
+    tooltipText = props.tooltipText,
+    tooltipWidth = props.tooltipWidth;
+  var rtlI18nContext = (_useI18nContext = (0, _I18nDecorator.useI18nContext)()) === null || _useI18nContext === void 0 ? void 0 : _useI18nContext.rtl;
+  var rtl = typeof props.rtl === 'boolean' ? props.rtl : rtlI18nContext;
+  var _useState = (0, _react.useState)(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    showing = _useState2[0],
+    setShowing = _useState2[1];
+  var _useState3 = (0, _react.useState)({
+      arrowAnchor: null,
+      labelOffset: null,
+      position: {
+        top: 0,
+        left: 0
+      },
+      tooltipDirection: null
+    }),
+    _useState4 = _slicedToArray(_useState3, 2),
+    layout = _useState4[0],
+    setLayout = _useState4[1];
+  var mutableRef = (0, _react.useRef)({
+    mutationObserver: null,
+    resizeObserver: null,
+    showTooltipJob: null,
+    setTooltipLayoutJob: null
+  });
+  var clientRef = (0, _react.useRef)(null);
+  var tooltipRef = (0, _react.useRef)(null);
+  var showTooltip = (0, _react.useCallback)(function (client) {
+    if (tooltipText) {
+      var _mutableRef$current$s, _mutableRef$current$m, _mutableRef$current$r;
+      clientRef.current = client;
+      currentTooltip = client;
+      (_mutableRef$current$s = mutableRef.current.showTooltipJob) === null || _mutableRef$current$s === void 0 || _mutableRef$current$s.startAfter(tooltipDelay);
+      (_mutableRef$current$m = mutableRef.current.mutationObserver) === null || _mutableRef$current$m === void 0 || _mutableRef$current$m.observe(clientRef.current, {
+        attributes: true,
+        childList: true
+      });
+      (_mutableRef$current$r = mutableRef.current.resizeObserver) === null || _mutableRef$current$r === void 0 || _mutableRef$current$r.observe(clientRef.current);
+    }
+  }, [clientRef, tooltipDelay, tooltipText]);
+  var hideTooltip = (0, _react.useCallback)(function () {
+    if (tooltipText) {
+      var _mutableRef$current$m2, _mutableRef$current$r2, _mutableRef$current$s2, _mutableRef$current$s3;
+      (_mutableRef$current$m2 = mutableRef.current.mutationObserver) === null || _mutableRef$current$m2 === void 0 || _mutableRef$current$m2.disconnect();
+      (_mutableRef$current$r2 = mutableRef.current.resizeObserver) === null || _mutableRef$current$r2 === void 0 || _mutableRef$current$r2.disconnect();
+      clientRef.current = null;
+      currentTooltip = null;
+      (_mutableRef$current$s2 = mutableRef.current.showTooltipJob) === null || _mutableRef$current$s2 === void 0 || _mutableRef$current$s2.stop();
+      (_mutableRef$current$s3 = mutableRef.current.setTooltipLayoutJob) === null || _mutableRef$current$s3 === void 0 || _mutableRef$current$s3.stop();
+      setShowing(false);
+    }
+  }, [clientRef, tooltipText]);
+  var startTooltipLayoutJob = (0, _react.useCallback)(function () {
+    var _mutableRef$current$s4;
+    (_mutableRef$current$s4 = mutableRef.current.setTooltipLayoutJob) === null || _mutableRef$current$s4 === void 0 || _mutableRef$current$s4.startAfter(tooltipUpdateDelay);
+  }, [tooltipUpdateDelay]);
+
+  // Recalculate tooltip layout on keydown to make sure tooltip is positioned correctly in case something changes as a result of the keydown.
+  var onKeyDown = (0, _react.useCallback)(function (ev) {
+    (0, _handle.forward)('onKeyDown', ev, props);
+    if (!props.disabled) {
+      startTooltipLayoutJob();
+    }
+  }, [props, startTooltipLayoutJob]);
+  var onMouseOver = (0, _react.useCallback)(function (ev) {
+    (0, _handle.forward)('onMouseOver', ev, props);
+    if (props.disabled) {
+      showTooltip(ev.currentTarget);
+    }
+  }, [props, showTooltip]);
+  var onMouseOut = (0, _react.useCallback)(function (ev) {
+    (0, _handle.forward)('onMouseOut', ev, props);
+    if (props.disabled) {
+      if (clientRef.current && !clientRef.current.contains(ev.relatedTarget)) {
+        hideTooltip();
+      }
+    }
+  }, [hideTooltip, props]);
+  var onFocus = (0, _react.useCallback)(function (ev) {
+    (0, _handle.forward)('onFocus', ev, props);
+    showTooltip(ev.target);
+  }, [props, showTooltip]);
+  var onBlur = (0, _react.useCallback)(function (ev) {
+    (0, _handle.forward)('onBlur', ev, props);
+    hideTooltip();
+  }, [hideTooltip, props]);
+  var handlers = {
+    onKeyDown: onKeyDown,
+    onMouseOver: onMouseOver,
+    onMouseOut: onMouseOut,
+    onFocus: onFocus,
+    onBlur: onBlur
+  };
+  (0, _react.useEffect)(function () {
+    var mutableRefCurrent = mutableRef.current;
+    if (typeof window !== 'undefined' && window.MutationObserver) {
+      mutableRefCurrent.mutationObserver = new MutationObserver(startTooltipLayoutJob);
+    }
+    if (typeof window !== 'undefined' && window.ResizeObserver) {
+      mutableRefCurrent.resizeObserver = new ResizeObserver(startTooltipLayoutJob);
+    }
+    return function () {
+      if (currentTooltip === clientRef.current) {
+        var _mutableRefCurrent$mu, _mutableRefCurrent$re;
+        currentTooltip = null;
+        (_mutableRefCurrent$mu = mutableRefCurrent.mutationObserver) === null || _mutableRefCurrent$mu === void 0 || _mutableRefCurrent$mu.disconnect();
+        (_mutableRefCurrent$re = mutableRefCurrent.resizeObserver) === null || _mutableRefCurrent$re === void 0 || _mutableRefCurrent$re.disconnect();
+        mutableRefCurrent.showTooltipJob.stop();
+        mutableRefCurrent.setTooltipLayoutJob.stop();
+      }
+    };
+  }, [startTooltipLayoutJob]);
+  var setTooltipLayout = (0, _react.useCallback)(function () {
+    if (!tooltipRef.current || !clientRef.current) {
+      return;
+    }
+    var newLayout = getTooltipDirection(tooltipPosition, tooltipType);
+    var tooltipNode = tooltipRef.current.getBoundingClientRect(); // label bound
+    var clientNode = clientRef.current.getBoundingClientRect(); // client bound
+    var overflow = (0, _util2.calcOverflow)(tooltipNode, clientNode, newLayout.tooltipDirection, _resolution["default"].scale(screenEdgeKeepout));
+    newLayout.tooltipDirection = (0, _util2.adjustDirection)(newLayout.tooltipDirection, overflow, rtl);
+    newLayout.arrowAnchor = (0, _util2.adjustAnchor)(newLayout.arrowAnchor, newLayout.tooltipDirection, overflow, rtl);
+    newLayout.position = (0, _util2.adjustTransform)(clientRef.current, newLayout.tooltipDirection, (0, _util2.getPosition)(clientNode, newLayout.tooltipDirection));
+    newLayout.labelOffset = newLayout.arrowAnchor === 'center' ? (0, _util2.getLabelOffset)(tooltipNode, newLayout.tooltipDirection, newLayout.position, overflow) : null;
+    if (newLayout.position.top !== layout.position.top || newLayout.position.left !== layout.position.left || newLayout.labelOffset !== layout.labelOffset || newLayout.arrowAnchor !== layout.arrowAnchor) {
+      setLayout(newLayout);
+    }
+  }, [rtl, tooltipPosition, tooltipType, screenEdgeKeepout, layout, tooltipRef, clientRef]);
+  (0, _react.useLayoutEffect)(function () {
+    mutableRef.current.showTooltipJob = new _util.Job(function () {
+      setShowing(true);
+    });
+  }, [showing]);
+  (0, _react.useLayoutEffect)(function () {
+    mutableRef.current.setTooltipLayoutJob = new _util.Job(function () {
+      setTooltipLayout();
+    });
+  }, [setTooltipLayout]);
+  var getTooltipRef = (0, _react.useCallback)(function (node) {
+    tooltipRef.current = node;
+    if (node) {
+      setTooltipLayout();
+    }
+  }, [setTooltipLayout]);
+
+  /*
+   * Conditionally creates the FloatingLayer and Tooltip based on the presence of `tooltipText`
+   */
+  var renderTooltip = (0, _react.useCallback)(function () {
+    var _layout$position = layout.position,
+      top = _layout$position.top,
+      left = _layout$position.left;
+    var tooltipStyle = {
+      // Moving the position to CSS variables where there are additional offset calculations
+      '--tooltip-position-top': tooltipRelative ? null : _resolution["default"].unit(top, 'rem'),
+      '--tooltip-position-left': tooltipRelative ? null : _resolution["default"].unit(left, 'rem')
+    };
+    var renderedTooltip = /*#__PURE__*/(0, _jsxRuntime.jsx)(_Tooltip.Tooltip, _objectSpread(_objectSpread({
+      "aria-hidden": true,
+      labelOffset: layout.labelOffset
+    }, tooltipProps), {}, {
+      arrowAnchor: layout.arrowAnchor,
+      direction: layout.tooltipDirection,
+      marquee: tooltipMarquee,
+      relative: tooltipRelative,
+      style: tooltipStyle,
+      tooltipRef: getTooltipRef,
+      type: tooltipType,
+      width: tooltipWidth,
+      children: tooltipText
+    }));
+    if (!tooltipRelative) {
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_FloatingLayer.FloatingLayerBase, {
+        open: showing,
+        noAutoDismiss: true,
+        onDismiss: hideTooltip,
+        scrimType: "none",
+        children: renderedTooltip
+      }, "tooltipFloatingLayer");
+    } else if (showing) {
+      return renderedTooltip;
+    } else {
+      return null;
+    }
+  }, [getTooltipRef, hideTooltip, layout, showing, tooltipMarquee, tooltipProps, tooltipRelative, tooltipText, tooltipType, tooltipWidth]);
+  return {
+    tooltip: tooltipText ? renderTooltip() : null,
+    handlers: handlers,
+    restProps: removeTooltipProps(props)
+  };
+};
+var _default = exports["default"] = useTooltip;

package/TooltipDecorator/util.js

@@ -0,0 +1,273 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getPosition = exports.getLabelOffset = exports.calcOverflow = exports.adjustTransform = exports.adjustDirection = exports.adjustAnchor = void 0;
+var _resolution = _interopRequireDefault(require("@enact/ui/resolution"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
+function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; } // TooltipDecorator util.js
+//
+/**
+ * Calculates the unusable space of a centered Tooltip, which the Tooltip arrow cannot be positioned,
+ * as a percentage of the Tooltip's total width.
+ *
+ * @param  {Number} tooltipWidth        The measured width of the Tooltip
+ * @return {Number}                     The percent of the width of the tooltip that the Tooltip's
+ *                                      decorations allocate for themselves (on one side).
+ * @private
+ */
+var getLabelUnavailableSpace = function getLabelUnavailableSpace(tooltipWidth) {
+  // Arrow is 30px wide total, we need to know how wide half of it is, since it's centered on the anchor point.
+  var arrowWidth = 30 / 2;
+
+  // Tooltip is 108px tall, divide by half to get the curve radius, add the tooltip width
+  // to determine the distance that the anchor cannot progress past.
+  var tooltipUnavailableEdge = _resolution["default"].scale(108 / 2 + arrowWidth);
+
+  // cap the offset at 50% - that percentage
+  var tooltipUnavailablePercentage = 0.5 - tooltipUnavailableEdge / tooltipWidth;
+  return tooltipUnavailablePercentage;
+};
+
+/**
+ * Adjust anchor position for `Tooltip` based on overflow and rtl.
+ * Takes the output of `adjustDirection`, and `calcOverflow`.
+ *
+ * @method
+ * @memberof limestone/TooltipDecorator
+ * @param   {String}  arrowAnchor       Initial anchor position
+ * @param   {String}  tooltipDirection  Direction of tooltip; value from `adjustDirection`
+ * @param   {Object}  overflow          Tooltip's calculated overflow from `calcOverflow`
+ * @param   {Boolean} rtl               RTL mode
+ * @returns {String}                    Adjusted anchor position
+ * @private
+ */
+var adjustAnchor = exports.adjustAnchor = function adjustAnchor(arrowAnchor, tooltipDirection, overflow, rtl) {
+  if (tooltipDirection === 'above' || tooltipDirection === 'below') {
+    if (rtl && arrowAnchor !== 'center') {
+      arrowAnchor = arrowAnchor === 'left' ? 'right' : 'left';
+    }
+
+    // Flip sideways if it overflows to the sides
+    if (arrowAnchor === 'center') {
+      // If tooltip is anchored in the center, don't flip. We'll offset it appropriately later.
+    } else if (overflow.isOverRight) {
+      arrowAnchor = 'left';
+    } else if (overflow.isOverLeft) {
+      arrowAnchor = 'right';
+    }
+
+    // If tooltip is just too wide for the whole screen, switch it to a center tooltip
+    if (overflow.isOverWide && tooltipDirection !== 'left' && tooltipDirection !== 'right') {
+      arrowAnchor = 'center';
+    }
+  }
+  return arrowAnchor;
+};
+
+/**
+ * Adjust direction for `Tooltip` based on overflow and rtl.
+ * Takes the output from `calcOverflow`.
+ *
+ * @method
+ * @memberof limestone/TooltipDecorator
+ * @param   {String}  tooltipDirection  Direction of tooltip
+ * @param   {Object}  overflow          Tooltip's calculated overflow from `calcOverflow`
+ * @param   {Boolean} rtl               RTL mode
+ * @returns {String}                    Adjusted tooltip direction
+ * @private
+ */
+var adjustDirection = exports.adjustDirection = function adjustDirection(tooltipDirection, overflow, rtl) {
+  if (rtl && (tooltipDirection === 'left' || tooltipDirection === 'right')) {
+    tooltipDirection = tooltipDirection === 'left' ? 'right' : 'left';
+  }
+
+  // Flip tooltip if it overflows towards the tooltip direction
+  if (overflow.isOverTop && tooltipDirection === 'above') {
+    tooltipDirection = 'below';
+  } else if (overflow.isOverBottom && tooltipDirection === 'below') {
+    tooltipDirection = 'above';
+  } else if (overflow.isOverLeft && tooltipDirection === 'left' && !overflow.isOverWide) {
+    tooltipDirection = 'right';
+  } else if (overflow.isOverRight && tooltipDirection === 'right' && !overflow.isOverWide) {
+    tooltipDirection = 'left';
+  }
+  return tooltipDirection;
+};
+
+/**
+ * Calculates the top and left position for `Tooltip` accounting for transform.
+ *
+ * @method
+ * @memberof limestone/TooltipDecorator
+ * @param   {Node} clientNode         	The value for client node
+ * @param   {String} tooltipDirection   Direction of tooltip
+ * @param   {Object} tooltipPosition    The `getBoundingClientRect` values for tooltip node
+ * @returns {Object}                    Tooltip's calculated new position accounting for transform
+ * @private
+ */
+var adjustTransform = exports.adjustTransform = function adjustTransform(clientNode, tooltipDirection, tooltipPosition) {
+  var componentNodes = clientNode !== null && clientNode !== void 0 && clientNode.childNodes.length ? [clientNode].concat(_toConsumableArray(clientNode.childNodes)) : [clientNode];
+  var nodePositions = clientNode.getBoundingClientRect();
+  var hasTransform = false;
+  var transformMatrix = [];
+  componentNodes.forEach(function (node) {
+    if (window.getComputedStyle(node).transitionProperty === 'transform') {
+      hasTransform = true;
+      var matrix = window.getComputedStyle(node).transform.split('(')[1].split(')')[0].split(',');
+      transformMatrix = [parseFloat(matrix[0]) - 1, parseFloat(matrix[3]) - 1];
+    }
+  });
+  if (!hasTransform) return tooltipPosition;
+  var horizontal = (nodePositions.right - nodePositions.left) * transformMatrix[0] / 2,
+    vertical = (nodePositions.bottom - nodePositions.top) * transformMatrix[1] / 2;
+  switch (tooltipDirection) {
+    case 'above':
+      tooltipPosition.top -= vertical;
+      break;
+    case 'below':
+      tooltipPosition.top += vertical;
+      break;
+    case 'left':
+      tooltipPosition.left -= horizontal;
+      break;
+    case 'right':
+      tooltipPosition.left += horizontal;
+      break;
+    default:
+      break;
+  }
+  return tooltipPosition;
+};
+
+/**
+ * Calculates the overflow of `Tooltip` — if `Tooltip` is at the edge of the viewport.
+ * Return the amount of overflow in a particular direction if there is overflow (false otherwise).
+ *
+ * @method
+ * @memberof limestone/TooltipDecorator
+ * @param   {Object} tooltipNode        The `getBoundingClientRect` values for tooltip node
+ * @param   {Object} clientNode         The `getBoundingClientRect` values for client node
+ * @param   {String} tooltipDirection   Direction of tooltip
+ * @param   {Number} tooltipHeight      Tooltip height
+ * @param   {Number} edgeKeepout        Extra margin around the screen to avoid
+ * @returns {Object}                    Tooltip's calculated overflow
+ * @private
+ */
+var calcOverflow = exports.calcOverflow = function calcOverflow(tooltipNode, clientNode, tooltipDirection, edgeKeepout) {
+  // get the distance of space on both the right and left side of the client node. `clientNode.width / 2` because we want the tooltip to be positioned horizontally in middle of the client node.
+  var windowWidth = window.innerWidth;
+  var windowHeight = window.innerHeight;
+  var clientHorizontalCenter = clientNode.left + clientNode.width / 2;
+  var tooltipSafeWidth = tooltipNode.width + edgeKeepout;
+  var tooltipCenteredSafeWidth = tooltipNode.width / 2 + edgeKeepout;
+  var rightDelta = tooltipSafeWidth > clientHorizontalCenter;
+  var leftDelta = tooltipSafeWidth > windowWidth - clientHorizontalCenter;
+  var isTooltipWide = tooltipSafeWidth > windowWidth || leftDelta && rightDelta;
+  if (tooltipDirection === 'above' || tooltipDirection === 'below') {
+    var isOverTop = clientNode.top - tooltipNode.height - edgeKeepout;
+    var isOverBottom = clientNode.bottom + tooltipNode.height + edgeKeepout;
+    var isOverLeft = clientHorizontalCenter - tooltipSafeWidth;
+    var isOverRight = clientHorizontalCenter + tooltipSafeWidth;
+    var isOverCenterLeft = clientHorizontalCenter - tooltipCenteredSafeWidth;
+    var isOverCenterRight = clientHorizontalCenter + tooltipCenteredSafeWidth;
+    return {
+      isOverTop: isOverTop < 0 ? isOverTop : false,
+      isOverBottom: isOverBottom > windowHeight ? isOverBottom - windowHeight : false,
+      isOverLeft: isOverLeft < 0 ? isOverLeft : false,
+      isOverRight: isOverRight > windowWidth ? isOverRight - windowWidth : false,
+      isOverCenterLeft: isOverCenterLeft < 0 ? isOverCenterLeft : false,
+      isOverCenterRight: isOverCenterRight > windowWidth ? isOverCenterRight - windowWidth : false,
+      isOverWide: isTooltipWide
+    };
+  } else if (tooltipDirection === 'left' || tooltipDirection === 'right') {
+    var _isOverTop = clientNode.top - tooltipNode.height + clientNode.height - edgeKeepout;
+    var _isOverBottom = clientNode.bottom + tooltipNode.height - clientNode.height / 2 + edgeKeepout;
+    var _isOverLeft = clientNode.left - tooltipNode.width - edgeKeepout;
+    var _isOverRight = clientNode.right + tooltipNode.width + edgeKeepout;
+    return {
+      isOverTop: _isOverTop < 0 ? _isOverTop : false,
+      isOverBottom: _isOverBottom > windowHeight ? _isOverBottom - windowHeight : false,
+      isOverLeft: _isOverLeft < 0 ? _isOverLeft : false,
+      isOverRight: _isOverRight > windowWidth ? _isOverRight - windowWidth : false,
+      isOverWide: isTooltipWide
+    };
+  }
+};
+
+/**
+ * Calculates the top and left position for `Tooltip`.
+ * Takes the output of `adjustAnchor`, `adjustDirection`, and `calcOverflow`.
+ *
+ * @method
+ * @memberof limestone/TooltipDecorator
+ * @param   {Object} clientNode         The `getBoundingClientRect` values for client node
+ * @param   {String} tooltipDirection   Direction of tooltip
+ * @returns {Object}                    Tooltip top and left position
+ * @private
+ */
+var getPosition = exports.getPosition = function getPosition(clientNode, tooltipDirection) {
+  var position = {};
+  switch (tooltipDirection) {
+    case 'above':
+      position.top = clientNode.top;
+      break;
+    case 'below':
+      position.top = clientNode.bottom;
+      break;
+    case 'right':
+      position.left = clientNode.right;
+      break;
+    case 'left':
+      position.left = clientNode.left;
+      break;
+    default:
+      position = {};
+  }
+  if (tooltipDirection === 'above' || tooltipDirection === 'below') {
+    position.left = clientNode.left + clientNode.width / 2;
+  } else if (tooltipDirection === 'left' || tooltipDirection === 'right') {
+    position.top = clientNode.top + clientNode.height / 2;
+  }
+  return position;
+};
+
+/**
+ * Adjusts the `Tooltip` arrow anchor when the tooltip is too wide.
+ * Takes the output of `calcOverflow`.
+ *
+ * @method
+ * @memberof limestone/TooltipDecorator
+ * @param   {Object}  tooltipNode       The `getBoundingClientRect` values for tooltip node
+ * @param   {String}  tooltipDirection  Direction of tooltip
+ * @param   {Object}  tooltipPosition   Calculated tooltip position from `getPosition`
+ * @param   {Object}  overflow          Tooltip's calculated overflow from `calcOverflow`
+ * @private
+ */
+var getLabelOffset = exports.getLabelOffset = function getLabelOffset(tooltipNode, tooltipDirection, tooltipPosition, overflow) {
+  // This method is irrelevant to left and right anchored tooltips, skip entirely.
+  if (tooltipDirection !== 'left' && tooltipDirection !== 'right') {
+    var tooltipWidth = tooltipNode.width;
+    if (overflow.isOverWide || overflow.isOverCenterLeft || overflow.isOverCenterRight) {
+      var pixelOffset = 0;
+      if (overflow.isOverCenterLeft) {
+        // Start shifting the label to the right (negative offset)
+        pixelOffset = overflow.isOverCenterLeft;
+      } else if (overflow.isOverCenterRight) {
+        // Start shifting the label to the left (positive offset)
+        pixelOffset = overflow.isOverCenterRight;
+      }
+      var percentageOffset = pixelOffset / tooltipWidth * -1;
+      var offsetBoundaryPercentage = getLabelUnavailableSpace(tooltipWidth);
+      var cappedPercentageOffset = Math.max(offsetBoundaryPercentage * -1, Math.min(offsetBoundaryPercentage, percentageOffset));
+      return cappedPercentageOffset;
+    }
+  }
+  return null;
+};

package/VideoPlayer/Feedback.js

@@ -0,0 +1,110 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.FeedbackBase = exports.Feedback = void 0;
+var _kind = _interopRequireDefault(require("@enact/core/kind"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _util = require("../internal/util");
+var _FeedbackIcon = _interopRequireDefault(require("./FeedbackIcon"));
+var _FeedbackIcons = _interopRequireDefault(require("./FeedbackIcons.js"));
+var _FeedbackModule = _interopRequireDefault(require("./Feedback.module.css"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["children", "playbackState"];
+/**
+ * Feedback {@link limestone/VideoPlayer}. This displays the media's playback rate and other
+ * information.
+ *
+ * @class Feedback
+ * @memberof limestone/VideoPlayer
+ * @ui
+ * @private
+ */
+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; }
+var FeedbackBase = exports.FeedbackBase = (0, _kind["default"])({
+  name: 'Feedback',
+  propTypes: /** @lends limestone/VideoPlayer.Feedback.prototype */{
+    children: _propTypes["default"].oneOfType([_propTypes["default"].string, _propTypes["default"].number]),
+    /**
+     * Refers to one of the following possible media playback states.
+     * `'play'`, `'pause'`, `'rewind'`, `'fastForward'` ,
+     * `'jumpBackward'`, `'jumpForward'`, `'jumpToStart'`, `'jumpToEnd'`, `'stop'`.
+     *
+     * Each state understands where its related icon should be positioned, and whether it should
+     * respond to changes to the `visible` property.
+     *
+     * This string feeds directly into {@link limestone/FeedbackIcon.FeedbackIcon}.
+     *
+     * @type {('play'|'pause'|'rewind'|'fastForward'|'jumpBackward'|'jumpForward'|'jumpToStart'|'jumpToEnd'|'stop')}
+     * @public
+     */
+    playbackState: _propTypes["default"].oneOf(Object.keys(_FeedbackIcons["default"])),
+    /**
+     * If the current `playbackState` allows this component's visibility to be changed,
+     * this component will be hidden. If not, setting this property will have no effect.
+     * All `playbackState`s respond to this property except the following:
+     * `'rewind'`, `'fastForward'`.
+     *
+     * @type {Boolean}
+     * @default true
+     * @public
+     */
+    visible: _propTypes["default"].bool
+  },
+  defaultProps: {
+    visible: true
+  },
+  styles: {
+    css: _FeedbackModule["default"],
+    className: 'feedback'
+  },
+  computed: {
+    className: function className(_ref) {
+      var styler = _ref.styler,
+        visible = _ref.visible;
+      return styler.append({
+        hidden: !visible
+      });
+    },
+    children: function children(_ref2) {
+      var _children = _ref2.children,
+        s = _ref2.playbackState;
+      if (_FeedbackIcons["default"][s]) {
+        // Working with a known state, treat `children` as playbackRate
+        if (_FeedbackIcons["default"][s].message && _children !== 1) {
+          // `1` represents a playback rate of 1:1
+          return _children.toString().replace(/^-/, '') + _FeedbackIcons["default"][s].message;
+        }
+      } else {
+        // Custom Message
+        return _children;
+      }
+    }
+  },
+  render: function render(_ref3) {
+    var children = _ref3.children,
+      playbackState = _ref3.playbackState,
+      rest = _objectWithoutProperties(_ref3, _excluded);
+    delete rest.visible;
+    return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", _objectSpread(_objectSpread({}, rest), {}, {
+      children: [_FeedbackIcons["default"][playbackState] && _FeedbackIcons["default"][playbackState].position === 'before' ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_FeedbackIcon["default"], {
+        children: playbackState
+      }) : null, children ? /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+        className: _FeedbackModule["default"].message,
+        children: children
+      }) : null, _FeedbackIcons["default"][playbackState] && _FeedbackIcons["default"][playbackState].position === 'after' ? /*#__PURE__*/(0, _jsxRuntime.jsx)(_FeedbackIcon["default"], {
+        children: playbackState
+      }) : null]
+    }));
+  }
+});
+var Feedback = exports.Feedback = (0, _util.onlyUpdateForProps)(FeedbackBase, ['children', 'playbackState', 'visible']);
+var _default = exports["default"] = Feedback;