@enact/limestone 1.3.0

package/useScroll/ScrollbarTrack.js

@@ -0,0 +1,209 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.ScrollbarTrackBase = exports.ScrollbarTrack = void 0;
+var _classnames = _interopRequireDefault(require("classnames"));
+var _keymap = require("@enact/core/keymap");
+var _Accelerator = _interopRequireDefault(require("@enact/spotlight/Accelerator"));
+var _Spottable = _interopRequireDefault(require("@enact/spotlight/Spottable"));
+var _AnnounceDecorator = require("@enact/ui/AnnounceDecorator");
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _react = require("react");
+var _$L = _interopRequireDefault(require("../internal/$L"));
+var _ScrollbarTrackModule = _interopRequireDefault(require("./ScrollbarTrack.module.css"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["aria-label", "cbAlertScrollbarTrack", "focusableScrollbar", "onInteractionForScroll", "ref", "rtl", "scrollbarTrackCss", "vertical"];
+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 nop = function nop() {};
+var isDown = (0, _keymap.is)('down'),
+  isLeft = (0, _keymap.is)('left'),
+  isPageUp = (0, _keymap.is)('pageUp'),
+  isPageDown = (0, _keymap.is)('pageDown'),
+  isRight = (0, _keymap.is)('right'),
+  isUp = (0, _keymap.is)('up');
+var scrollStopWaiting = 500; // Wait for finishing scroll animation.
+
+var SpotlightAccelerator = new _Accelerator["default"]();
+var SpottableDiv = (0, _Spottable["default"])('div');
+
+/**
+ * A Limestone-styled scrollbar track with limestone behavior
+ *
+ * @class ScrollbarTrack
+ * @memberof limestone/useScroll
+ * @ui
+ * @private
+ */
+var ScrollbarTrack = exports.ScrollbarTrackBase = exports.ScrollbarTrack = function ScrollbarTrack(props) {
+  var ariaLabel = props['aria-label'],
+    cbAlertScrollbarTrack = props.cbAlertScrollbarTrack,
+    focusableScrollbar = props.focusableScrollbar,
+    onInteractionForScroll = props.onInteractionForScroll,
+    ref = props.ref,
+    rtl = props.rtl,
+    scrollbarTrackCss = props.scrollbarTrackCss,
+    vertical = props.vertical,
+    rest = _objectWithoutProperties(props, _excluded),
+    className = (0, _classnames["default"])(_ScrollbarTrackModule["default"].scrollbarTrack, _defineProperty(_defineProperty({}, _ScrollbarTrackModule["default"].vertical, vertical), _ScrollbarTrackModule["default"].focusableScrollbar, focusableScrollbar)),
+    ScrollbarThumb = focusableScrollbar ? SpottableDiv : 'div',
+    announceRef = (0, _react.useRef)({});
+  (0, _react.useEffect)(function () {
+    cbAlertScrollbarTrack();
+    SpotlightAccelerator.reset();
+    return function () {
+      SpotlightAccelerator.reset();
+    };
+  }, []); // eslint-disable-line react-hooks/exhaustive-deps
+
+  var consumeEventWithScroll = (0, _react.useCallback)(function (scrollParam, ev) {
+    ev.preventDefault();
+    ev.stopPropagation(); // stop propagation of React synthetic event to other components like PopupDecorator
+    ev.nativeEvent.stopImmediatePropagation(); // stop propagation of browser native event to Spotlight
+    onInteractionForScroll(scrollParam);
+  }, [onInteractionForScroll]);
+  var onKeyDown = (0, _react.useCallback)(function (ev) {
+    if (SpotlightAccelerator.processKey(ev, nop)) {
+      ev.stopPropagation(); // stop propagation of React synthetic event to other components like PopupDecorator
+      ev.nativeEvent.stopImmediatePropagation(); // stop propagation of browser native event to Spotlight
+    } else {
+      var keyCode = ev.keyCode,
+        isLeftRight = isLeft(keyCode) || isRight(keyCode),
+        isUpDown = isUp(keyCode) || isDown(keyCode),
+        isPageKey = isPageUp(keyCode) || isPageDown(keyCode),
+        scrollParam = {
+          inputType: isPageKey ? 'pageKey' : 'arrowKey',
+          isPagination: isPageKey,
+          isForward: !rtl && isRight(keyCode) || rtl && isLeft(keyCode) || isDown(keyCode) || isPageDown(keyCode),
+          isVerticalScrollBar: vertical
+        },
+        scrollProgress = Number(ref.current && ref.current.style.getPropertyValue('--scrollbar-thumb-progress-ratio')),
+        scrollSize = Number(ref.current && ref.current.style.getPropertyValue('--scrollbar-thumb-size-ratio'));
+      if (vertical && (isUpDown || isPageKey) || !vertical && isLeftRight) {
+        // Do nothing when (!vertical && pageKey)
+
+        if (!ev.repeat && announceRef.current.announce) {
+          announceRef.current.announce((isDown(keyCode) || isPageDown(keyCode)) && (0, _$L["default"])('DOWN') || (isUp(keyCode) || isPageUp(keyCode)) && (0, _$L["default"])('UP') || isLeft(keyCode) && (0, _$L["default"])('LEFT') || (0, _$L["default"])('RIGHT') // the case that isRight(keyCode) is true
+          );
+        }
+        if (ev.repeat || scrollSize !== 1 && (scrollParam.isForward && scrollProgress !== 1 || !scrollParam.isForward && scrollProgress !== 0)) {
+          consumeEventWithScroll(scrollParam, ev);
+          setTimeout(function () {
+            var updatedScrollProgress = Number(ref.current && ref.current.style.getPropertyValue('--scrollbar-thumb-progress-ratio'));
+            var horizontalReachLeftMost = rtl ? updatedScrollProgress === 1 : updatedScrollProgress === 0;
+            var horizontalReachRightMost = rtl ? updatedScrollProgress === 0 : updatedScrollProgress === 1;
+
+            // Current UX announce only after Scroll via Scrollthumb.
+            if (announceRef.current.announce && (updatedScrollProgress === 0 || updatedScrollProgress === 1)) {
+              announceRef.current.announce((isDown(keyCode) || isPageDown(keyCode)) && updatedScrollProgress === 1 && (0, _$L["default"])('DOWNMOST') || (isUp(keyCode) || isPageUp(keyCode)) && updatedScrollProgress === 0 && (0, _$L["default"])('UPMOST') || isLeft(keyCode) && horizontalReachLeftMost && (0, _$L["default"])('LEFTMOST') || isRight(keyCode) && horizontalReachRightMost && (0, _$L["default"])('RIGHTMOST') // the case that isRight(keyCode) is true
+              );
+            }
+          }, scrollStopWaiting);
+        }
+      }
+      if (!ev.repeat) {
+        SpotlightAccelerator.reset();
+      }
+    }
+  }, [consumeEventWithScroll, ref, rtl, vertical]);
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", _objectSpread(_objectSpread({}, rest), {}, {
+    className: (0, _classnames["default"])(className, scrollbarTrackCss && scrollbarTrackCss.scrollbarTrack),
+    ref: ref,
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsxs)(ScrollbarThumb, {
+      "aria-label": ariaLabel,
+      className: (0, _classnames["default"])(_ScrollbarTrackModule["default"].thumb, scrollbarTrackCss && scrollbarTrackCss.thumb),
+      "data-spotlight-ignore-restore": true,
+      onKeyDown: onKeyDown,
+      children: [/*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+        className: (0, _classnames["default"])(_ScrollbarTrackModule["default"].directionIndicator, _ScrollbarTrackModule["default"].backward)
+      }), /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+        className: (0, _classnames["default"])(_ScrollbarTrackModule["default"].directionIndicator, _ScrollbarTrackModule["default"].forward)
+      })]
+    }), /*#__PURE__*/(0, _jsxRuntime.jsx)(_AnnounceDecorator.Announce, {
+      ref: announceRef
+    }, "announce")]
+  }));
+};
+ScrollbarTrack.displayName = 'ScrollbarTrack';
+ScrollbarTrack.propTypes = /** @lends limestone/useScroll.ScrollbarTrack.prototype */{
+  /**
+   * The aria label for the component.
+   *
+   * @type {String}
+   * @private
+   */
+  'aria-label': _propTypes["default"].string,
+  /**
+   * Called when {@link limestone/useScroll.ScrollbarTrack|ScrollbarTrack} is updated.
+   *
+   * @type {Function}
+   * @private
+   */
+  cbAlertScrollbarTrack: _propTypes["default"].func,
+  /**
+   * `true` if scroll thumb is spottable.
+   *
+   * @type {Boolean|'byEnter'}
+   * @private
+   */
+  focusableScrollbar: _propTypes["default"].oneOfType([_propTypes["default"].bool, _propTypes["default"].oneOf(['byEnter'])]),
+  /**
+   * Called when the user requests scroll.
+   *
+   * @type {Function}
+   * @private
+   */
+  onInteractionForScroll: _propTypes["default"].func,
+  /**
+   * Forwards a reference to the DOM element.
+   *
+   * @type {Object}
+   * @private
+   */
+  ref: _propTypes["default"].shape({
+    current: _propTypes["default"].any
+  }),
+  /**
+   * `true` if rtl, `false` if ltr.
+   *
+   * @type {Boolean}
+   * @private
+   */
+  rtl: _propTypes["default"].bool,
+  /**
+   * Customizes the component by mapping the supplied collection of CSS class names to the
+   * corresponding internal elements and states of this component.
+   *
+   * The following classes are supported:
+   *
+   * * `scrollbarTrack` - The scrollbarTrack component class
+   * * `thumb` - The scrollbar thumb component class
+   *
+   * @type {Object}
+   * @public
+   */
+  scrollbarTrackCss: _propTypes["default"].object,
+  /**
+   * `true` if vertical scroll, `false` if horizontal scroll.
+   *
+   * @type {Boolean}
+   * @private
+   */
+  vertical: _propTypes["default"].bool
+};
+ScrollbarTrack.defaultProps = {
+  cbAlertScrollbarTrack: nop,
+  focusableScrollbar: false,
+  onInteractionForScroll: nop,
+  rtl: false,
+  vertical: true
+};
+var _default = exports["default"] = ScrollbarTrack;

package/useScroll/ScrollbarTrack.module.css

@@ -0,0 +1,136 @@
+.scrollbarTrack {
+  --scrollbar-track-margin: 0.25rem;
+  --scrollbar-thumb-size-ratio: 1;
+  --scrollbar-thumb-progress-ratio: 0;
+  --scrollbar-thumb-size: calc(100% * var(--scrollbar-thumb-size-ratio));
+  --scrollbar-thumb-progress: calc(((1 - var(--scrollbar-thumb-size-ratio)) * var(--scrollbar-thumb-progress-ratio)) * 100%);
+  position: relative;
+  height: 100%;
+  width: 100%;
+  background-color: transparent;
+  border-radius: var(--semantic-radius-full);
+  opacity: 0;
+  transition: opacity 100ms ease-out;
+}
+.scrollbarTrack:hover {
+  opacity: 1;
+}
+.scrollbarTrack:has(.thumb:focus) {
+  background-color: color(from var(--semantic-color-surface-default-track) srgb r g b / 0.5);
+}
+.scrollbarTrack.focusableScrollbar {
+  opacity: 1;
+  --scrollbar-track-margin: 0.5rem;
+}
+.scrollbarTrack .thumb {
+  background: var(--semantic-color-surface-scroll-handle);
+  display: block;
+  position: absolute;
+  width: 100%;
+  height: 100%;
+  border-radius: var(--semantic-radius-full);
+}
+:global(.spotlight-input-key) .scrollbarTrack .thumb:global(.spottable):focus,
+:global(.spotlight-input-mouse) .scrollbarTrack .thumb:global(.spottable):focus {
+  position: absolute;
+  background-color: var(--semantic-color-surface-default-focused);
+  box-shadow: 0 0.125rem 0.375rem color(from var(--semantic-color-on-background-black) srgb r g b / 0.35);
+  border-radius: var(--semantic-radius-full);
+}
+:global(.spotlight-input-key) .scrollbarTrack .thumb:global(.spottable):focus .directionIndicator,
+:global(.spotlight-input-mouse) .scrollbarTrack .thumb:global(.spottable):focus .directionIndicator {
+  position: absolute;
+  width: 0;
+  height: 0;
+  border-top: 0.25rem solid transparent;
+  border-bottom: 0.25rem solid var(--semantic-color-on-surface-accent);
+  border-right: 0.1875rem solid transparent;
+  border-left: 0.1875rem solid transparent;
+}
+:global(.spotlight-input-touch) .scrollbarTrack .thumb:global(.spottable):active {
+  position: absolute;
+  background-color: var(--semantic-color-surface-default-focused);
+  box-shadow: 0 0.125rem 0.375rem color(from var(--semantic-color-on-background-black) srgb r g b / 0.35);
+  border-radius: var(--semantic-radius-full);
+}
+:global(.spotlight-input-touch) .scrollbarTrack .thumb:global(.spottable):active .directionIndicator {
+  position: absolute;
+  width: 0;
+  height: 0;
+  border-top: 0.25rem solid transparent;
+  border-bottom: 0.25rem solid var(--semantic-color-on-surface-accent);
+  border-right: 0.1875rem solid transparent;
+  border-left: 0.1875rem solid transparent;
+}
+:global(.spotlight-input-key) :global(.noAnimation) .scrollbarTrack .thumb:global(.spottable):focus,
+:global(.spotlight-input-mouse) :global(.noAnimation) .scrollbarTrack .thumb:global(.spottable):focus {
+  box-shadow: none;
+}
+:global(.spotlight-input-touch) :global(.noAnimation) .scrollbarTrack .thumb:global(.spottable):active {
+  box-shadow: none;
+}
+:global(.spotlight-input-touch) .scrollbarTrack .thumb {
+  pointer-events: none;
+}
+.scrollbarTrack.vertical {
+  margin: 0 var(--scrollbar-track-margin);
+  width: 0.25rem;
+}
+.scrollbarTrack.vertical .thumb {
+  height: var(--scrollbar-thumb-size);
+  top: var(--scrollbar-thumb-progress);
+  will-change: top;
+}
+.scrollbarTrack.vertical .thumb:focus {
+  width: 0.625rem;
+  left: -0.1875rem;
+}
+.scrollbarTrack.vertical .thumb:focus .directionIndicator.backward {
+  top: calc(9px - 0.25rem);
+  left: 0.125rem;
+}
+.scrollbarTrack.vertical .thumb:focus .directionIndicator.forward {
+  transform: rotate(180deg);
+  bottom: calc(9px - 0.25rem);
+  left: 0.125rem;
+}
+.scrollbarTrack:not(.vertical) {
+  margin: var(--scrollbar-track-margin) 0;
+  height: 0.25rem;
+}
+.scrollbarTrack:not(.vertical) .thumb {
+  width: var(--scrollbar-thumb-size);
+  left: var(--scrollbar-thumb-progress);
+  will-change: left;
+  top: 50%;
+  transform: translateY(-50%);
+}
+:global(.spotlight-input-key) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):focus,
+:global(.spotlight-input-mouse) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):focus {
+  height: 0.625rem;
+}
+:global(.spotlight-input-key) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):focus .directionIndicator.backward,
+:global(.spotlight-input-mouse) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):focus .directionIndicator.backward {
+  transform: rotate(-90deg);
+  left: calc(9px - 0.25rem);
+  top: calc(0.125rem / 2);
+}
+:global(.spotlight-input-key) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):focus .directionIndicator.forward,
+:global(.spotlight-input-mouse) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):focus .directionIndicator.forward {
+  transform: rotate(90deg);
+  right: calc(9px - 0.25rem);
+  top: calc(0.125rem / 2);
+}
+:global(.spotlight-input-touch) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):active {
+  height: 0.625rem;
+}
+:global(.spotlight-input-touch) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):active .directionIndicator.backward {
+  transform: rotate(-90deg);
+  left: calc(9px - 0.25rem);
+  top: calc(0.125rem / 2);
+}
+:global(.spotlight-input-touch) .scrollbarTrack:not(.vertical) .thumb:global(.spottable):active .directionIndicator.forward {
+  transform: rotate(90deg);
+  right: calc(9px - 0.25rem);
+  top: calc(0.125rem / 2);
+}

package/useScroll/package.json

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