@enact/limestone 1.3.0

package/Slider/SliderBehaviorDecorator.js

@@ -0,0 +1,184 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.SliderBehaviorDecorator = void 0;
+var _handle = require("@enact/core/handle");
+var _hoc = _interopRequireDefault(require("@enact/core/hoc"));
+var _util = require("@enact/core/util");
+var _Pause = _interopRequireDefault(require("@enact/spotlight/Pause"));
+var _IString = _interopRequireDefault(require("ilib/lib/IString"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _react = require("react");
+var _$L = _interopRequireDefault(require("../internal/$L"));
+var _utils = require("./utils");
+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; }
+var defaultConfig = {
+  // FIXME: This is a compromise to maintain a single decorator for Slider and IncrementSlider
+  // that handles both a consolidated focus state and spotlight directional event mgmt. When this
+  // is unset (for Slider), this decorator will listen to onKeyDown and fire spotlight events.
+  // When set (for IncrementSlider), it specifies the event that is passed down to trigger
+  // spotlight events and also doesn't remove the spotlight directional callbacks from the props
+  // so the Wrapped component can fire them manually or use the callback for the default behavior.
+  emitSpotlightEvents: null
+};
+var sliderBehaviorDefaultProps = {
+  max: 100,
+  min: 0,
+  orientation: 'horizontal'
+};
+
+// Adds limestone-specific slider behaviors
+// * aria-valuetext handling
+//   * use aria-valuetext when set
+//   * defaults to current value
+//   * onActivate, set to hint text
+//   * on value change, reset to value or aria-valuetext
+// * Spotlight
+//   * Pause Spotlight when dragging to prevent spotlight from leaving when pointer enters another
+//     component
+//   * Forward directional spotlight events from slider
+// * Managing focused state to show/hide tooltip
+var SliderBehaviorDecorator = exports.SliderBehaviorDecorator = (0, _hoc["default"])(defaultConfig, function (config, Wrapped) {
+  var emitSpotlightEvents = config.emitSpotlightEvents;
+
+  // eslint-disable-next-line no-shadow
+  var SliderBehaviorDecorator = function SliderBehaviorDecorator(props) {
+    var sliderBehaviorProps = (0, _util.setDefaultProps)(props, sliderBehaviorDefaultProps);
+    var paused = (0, _react.useMemo)(function () {
+      return new _Pause["default"]();
+    }, []);
+    var _useState = (0, _react.useState)(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      active = _useState2[0],
+      setActive = _useState2[1];
+    var _useState3 = (0, _react.useState)(false),
+      _useState4 = _slicedToArray(_useState3, 2),
+      dragging = _useState4[0],
+      setDragging = _useState4[1];
+    var _useState5 = (0, _react.useState)(false),
+      _useState6 = _slicedToArray(_useState5, 2),
+      focused = _useState6[0],
+      setFocused = _useState6[1];
+    var _useState7 = (0, _react.useState)(true),
+      _useState8 = _slicedToArray(_useState7, 2),
+      useHintText = _useState8[0],
+      setUseHintText = _useState8[1];
+    var _useState9 = (0, _react.useState)(sliderBehaviorProps.value),
+      _useState0 = _slicedToArray(_useState9, 2),
+      prevValue = _useState0[0],
+      setPrevValue = _useState0[1];
+    (0, _react.useEffect)(function () {
+      if (sliderBehaviorProps.value !== prevValue) {
+        setUseHintText(false);
+        setPrevValue(sliderBehaviorProps.value);
+      }
+    }, [prevValue, sliderBehaviorProps.value]);
+    (0, _react.useEffect)(function () {
+      return function () {
+        paused.resume();
+      };
+    }, []); // eslint-disable-line react-hooks/exhaustive-deps
+
+    var getValueText = (0, _react.useCallback)(function () {
+      var ariaValueText = sliderBehaviorProps['aria-valuetext'],
+        max = sliderBehaviorProps.max,
+        min = sliderBehaviorProps.min,
+        orientation = sliderBehaviorProps.orientation,
+        _sliderBehaviorProps$ = sliderBehaviorProps.value,
+        value = _sliderBehaviorProps$ === void 0 ? min : _sliderBehaviorProps$;
+      var valueText = ariaValueText != null ? ariaValueText : value;
+      var verticalHint = "".concat(new _IString["default"]((0, _$L["default"])('From {startValue} to {lastValue}')).format({
+        startValue: min,
+        lastValue: max
+      }), " ").concat(valueText, " ").concat((0, _$L["default"])('change a value with up down button'));
+      var horizontalHint = "".concat(new _IString["default"]((0, _$L["default"])('From {startValue} to {lastValue}')).format({
+        startValue: min,
+        lastValue: max
+      }), " ").concat(valueText, " ").concat((0, _$L["default"])('change a value with left right button'));
+      if (useHintText) {
+        return orientation === 'horizontal' ? horizontalHint : verticalHint;
+      }
+      return valueText;
+    }, [sliderBehaviorProps, useHintText]);
+    var handleActivate = (0, _react.useCallback)(function () {
+      (0, _handle.forwardCustom)('onActivate')(null, sliderBehaviorProps);
+      setActive(function (prevState) {
+        return !prevState;
+      });
+    }, [sliderBehaviorProps]);
+    var handleBlur = (0, _react.useCallback)(function (ev) {
+      (0, _handle.forward)('onBlur', ev, sliderBehaviorProps);
+      setFocused(false);
+      setUseHintText(true);
+    }, [sliderBehaviorProps]);
+    var handleDragStart = (0, _react.useCallback)(function () {
+      paused.pause();
+      setDragging(true);
+    }, [paused]);
+    var handleDragEnd = (0, _react.useCallback)(function () {
+      paused.resume();
+      setDragging(false);
+    }, [paused]);
+    var handleFocus = (0, _react.useCallback)(function (ev) {
+      (0, _handle.forward)('onFocus', ev, sliderBehaviorProps);
+      if (!sliderBehaviorProps.activateOnSelect) {
+        handleActivate();
+      }
+      setFocused(true);
+    }, [handleActivate, sliderBehaviorProps]);
+    var handleSpotlightEvents = (0, _react.useCallback)(function (ev) {
+      if (!emitSpotlightEvents) {
+        (0, _handle.forward)('onKeyDown', ev, sliderBehaviorProps);
+      }
+      (0, _utils.forwardSpotlightEvents)(ev, sliderBehaviorProps);
+    }, [sliderBehaviorProps]);
+    var sliderProps = Object.assign({}, sliderBehaviorProps);
+    if (!emitSpotlightEvents) {
+      // Remove spotlight props before hitting spottable since we've handled them uniquely
+      delete sliderProps.onSpotlightLeft;
+      delete sliderProps.onSpotlightRight;
+      delete sliderProps.onSpotlightUp;
+      delete sliderProps.onSpotlightDown;
+      sliderProps.onKeyDown = handleSpotlightEvents;
+    } else {
+      sliderProps[emitSpotlightEvents] = handleSpotlightEvents;
+    }
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(Wrapped, _objectSpread(_objectSpread({
+      role: "slider"
+    }, sliderProps), {}, {
+      active: active,
+      "aria-valuetext": getValueText(),
+      focused: focused || dragging,
+      onActivate: handleActivate,
+      onBlur: handleBlur,
+      onDragStart: handleDragStart,
+      onDragEnd: handleDragEnd,
+      onFocus: handleFocus
+    }));
+  };
+  SliderBehaviorDecorator.displayName = 'SliderBehaviorDecorator';
+  SliderBehaviorDecorator.propTypes = {
+    activateOnSelect: _propTypes["default"].bool,
+    'aria-valuetext': _propTypes["default"].oneOfType([_propTypes["default"].string, _propTypes["default"].number]),
+    max: _propTypes["default"].number,
+    min: _propTypes["default"].number,
+    orientation: _propTypes["default"].string,
+    value: _propTypes["default"].number
+  };
+  return SliderBehaviorDecorator;
+});
+var _default = exports["default"] = SliderBehaviorDecorator;

package/Slider/package.json

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