@enact/ui 5.4.3 → 5.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/AnnounceDecorator/Announce.js +9 -5
  2. package/AnnounceDecorator/AnnounceDecorator.js +5 -3
  3. package/AnnounceDecorator/tests/AnnounceDecorator-specs.js +4 -1
  4. package/AnnounceDecorator/tests/useAnnounce-specs.js +4 -1
  5. package/CHANGELOG.md +17 -0
  6. package/Cancelable/Cancelable.js +7 -0
  7. package/Cancelable/tests/Cancelable-specs.js +26 -0
  8. package/Changeable/Changeable.js +6 -0
  9. package/Changeable/tests/Changeable-specs.js +4 -1
  10. package/FloatingLayer/FloatingLayer.js +3 -0
  11. package/FloatingLayer/FloatingLayerDecorator.js +2 -0
  12. package/FloatingLayer/Scrim.js +3 -0
  13. package/Marquee/Marquee.module.css +1 -1
  14. package/Marquee/MarqueeDecorator.js +19 -3
  15. package/Marquee/tests/Marquee-specs.js +306 -1
  16. package/Marquee/useMarqueeController.js +6 -4
  17. package/Measurable/tests/Measurable-specs.js +6 -2
  18. package/Media/Media.js +5 -2
  19. package/Placeholder/tests/PlaceholderControllerDecorator-specs.js +4 -1
  20. package/Resizable/tests/Resizable-specs.js +4 -1
  21. package/Resizable/tests/useResize-specs.js +4 -1
  22. package/Routable/Route.js +5 -3
  23. package/Routable/Router.js +25 -16
  24. package/Routable/tests/Routable-specs.js +16 -0
  25. package/Scroller/Scroller.js +6 -5
  26. package/Scroller/ScrollerBasic.js +5 -5
  27. package/Skinnable/Skinnable.js +9 -7
  28. package/Skinnable/tests/Skinnable-specs.js +7 -2
  29. package/Skinnable/useSkins.js +6 -2
  30. package/Slider/PositionDecorator.js +20 -5
  31. package/Slider/Slider.d.ts +4 -0
  32. package/Slider/Slider.js +10 -0
  33. package/Slider/tests/Slider-specs.js +18 -0
  34. package/Slider/utils.js +9 -1
  35. package/Toggleable/Toggleable.js +4 -2
  36. package/Toggleable/tests/Toggleable-specs.js +4 -1
  37. package/Touchable/Touchable.js +6 -4
  38. package/Touchable/tests/Touchable-specs.js +4 -1
  39. package/Touchable/tests/useTouch-specs.js +4 -1
  40. package/Touchable/useTouch.js +7 -2
  41. package/Transition/Transition.js +2 -0
  42. package/ViewManager/TransitionGroup.js +3 -0
  43. package/ViewManager/View.js +2 -0
  44. package/ViewManager/ViewManager.js +7 -0
  45. package/VirtualList/VirtualList.js +7 -5
  46. package/VirtualList/VirtualListBasic.js +59 -8
  47. package/VirtualList/tests/VirtualList-native-specs.js +14 -0
  48. package/VirtualList/tests/VirtualList-specs.js +13 -0
  49. package/internal/IdProvider/IdProvider.js +2 -0
  50. package/internal/IdProvider/tests/IdProvider-specs.js +4 -1
  51. package/internal/Pure/tests/Pure-specs.js +7 -0
  52. package/package.json +12 -7
  53. package/resolution/ResolutionDecorator.js +21 -18
  54. package/resolution/index.d.ts +63 -4
  55. package/resolution/index.js +18 -2
  56. package/resolution/resolution.js +209 -29
  57. package/resolution/tests/ResolutionDecorator-specs.js +84 -4
  58. package/resolution/tests/resolution-specs.js +217 -599
  59. package/useControlledState/tests/useControlledState-specs.js +4 -1
  60. package/useControlledState/useControlledState.js +11 -7
  61. package/useScroll/Scrollbar.js +27 -24
  62. package/useScroll/ScrollbarTrack.js +5 -3
  63. package/useScroll/tests/useScroll-specs.js +402 -25
  64. package/useScroll/useScroll.js +117 -26
  65. package/useScroll/utilEvent.js +18 -0
@@ -24,7 +24,7 @@ var _utilEvent = _interopRequireDefault(require("./utilEvent"));
24
24
  var _useScrollModule = _interopRequireDefault(require("./useScroll.module.css"));
25
25
  var _jsxRuntime = require("react/jsx-runtime");
26
26
  var _excluded = ["ref"],
27
- _excluded2 = ["childProps", "children", "className", "clientSize", "assignProperties", "dataSize", "direction", "horizontalScrollbar", "horizontalScrollbarHandle", "itemRenderer", "itemSize", "itemSizes", "noScrollByDrag", "noScrollByWheel", "overhang", "overscrollEffectOn", "pageScroll", "role", "rtl", "scrollContainerRef", "scrollContentHandle", "scrollContentRef", "scrollMode", "setScrollContainerHandle", "snapToCenter", "spacing", "spotlightContainerDisabled", "verticalScrollbar", "verticalScrollbarHandle", "wrap"];
27
+ _excluded2 = ["childProps", "children", "className", "clientSize", "assignProperties", "dataSize", "direction", "horizontalScrollbar", "horizontalScrollbarHandle", "itemRenderer", "itemSizes", "noScrollByDrag", "noScrollByWheel", "overhang", "overscrollEffectOn", "pageScroll", "role", "rtl", "scrollContainerRef", "scrollContentHandle", "scrollContentRef", "scrollMode", "setScrollContainerHandle", "snapToCenter", "spacing", "spotlightContainerDisabled", "verticalScrollbar", "verticalScrollbarHandle", "wrap"];
28
28
  /* global ResizeObserver */
29
29
  /**
30
30
  * Unstyled scrollable hook and behaviors to be customized by a theme or application.
@@ -148,7 +148,6 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
148
148
  horizontalScrollbar = props.horizontalScrollbar,
149
149
  horizontalScrollbarHandle = props.horizontalScrollbarHandle,
150
150
  itemRenderer = props.itemRenderer,
151
- itemSize = props.itemSize,
152
151
  itemSizes = props.itemSizes,
153
152
  noScrollByDrag = props.noScrollByDrag,
154
153
  noScrollByWheel = props.noScrollByWheel,
@@ -179,6 +178,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
179
178
  delete rest.cbScrollTo;
180
179
  delete rest.clearOverscrollEffect;
181
180
  delete rest.handleResizeWindow;
181
+ delete rest.itemSize;
182
182
  delete rest.onFlick;
183
183
  delete rest.onKeyDown;
184
184
  delete rest.onMouseDown;
@@ -207,10 +207,23 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
207
207
  _useState4 = _slicedToArray(_useState3, 2),
208
208
  isVerticalScrollbarVisible = _useState4[0],
209
209
  setIsVerticalScrollbarVisible = _useState4[1];
210
+ var _useState5 = (0, _react.useState)(_resolution["default"].scale(1)),
211
+ _useState6 = _slicedToArray(_useState5, 2),
212
+ riRatio = _useState6[0],
213
+ setRiRatio = _useState6[1];
214
+ var _useState7 = (0, _react.useState)(props.itemSize),
215
+ _useState8 = _slicedToArray(_useState7, 2),
216
+ originalItemSize = _useState8[0],
217
+ setOriginalItemSize = _useState8[1];
218
+ var _useState9 = (0, _react.useState)(props.itemSize),
219
+ _useState0 = _slicedToArray(_useState9, 2),
220
+ itemSize = _useState0[0],
221
+ setItemSize = _useState0[1];
210
222
  var mutableRef = (0, _react.useRef)({
211
223
  overscrollEnabled: !!props.applyOverscrollEffect,
212
224
  // Enable the early bail out of repeated scrolling to the same position
213
225
  animationInfo: null,
226
+ scrollEndGraceTimer: null,
214
227
  resizeRegistry: null,
215
228
  // constants
216
229
  pixelPerLine: 39,
@@ -336,6 +349,16 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
336
349
  mutableRef.current.wheelDirection = val;
337
350
  }
338
351
  });
352
+ if ((originalItemSize || originalItemSize === 0 || props.itemSize || props.itemSize === 0) && originalItemSize !== props.itemSize) {
353
+ setOriginalItemSize(props.itemSize);
354
+ if (typeof props.itemSize === 'object') {
355
+ if (_resolution["default"].scale(1) / riRatio !== props.itemSize.minWidth / itemSize.minWidth || _resolution["default"].scale(1) / riRatio !== props.itemSize.minHeight / itemSize.minHeight) {
356
+ setItemSize(props.itemSize);
357
+ }
358
+ } else if (_resolution["default"].scale(1) / riRatio !== props.itemSize / itemSize) {
359
+ setItemSize(props.itemSize);
360
+ }
361
+ }
339
362
  if (mutableRef.current.animator == null) {
340
363
  mutableRef.current.animator = new _ScrollAnimator["default"]();
341
364
  }
@@ -433,8 +456,41 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
433
456
  }, [forceUpdate, scrollContentHandle]);
434
457
  // scrollMode 'translate' ]]
435
458
 
459
+ var scrollContentProps = props.itemRenderer ?
460
+ // If the child component is a VirtualList
461
+ {
462
+ childProps: childProps,
463
+ clientSize: clientSize,
464
+ dataSize: dataSize,
465
+ itemRenderer: itemRenderer,
466
+ itemSize: itemSize,
467
+ itemSizes: itemSizes,
468
+ overhang: overhang,
469
+ pageScroll: pageScroll,
470
+ spacing: spacing,
471
+ wrap: wrap
472
+ } : {
473
+ children: children
474
+ };
436
475
  function handleResizeWindow() {
437
476
  var propsHandleResizeWindow = props.handleResizeWindow;
477
+ if (_resolution["default"].scale(1) !== riRatio) {
478
+ if (scrollContentProps.itemSize) {
479
+ if (scrollContentProps.itemSize.minWidth && scrollContentProps.itemSize.minHeight) {
480
+ scrollContentProps.itemSize.minWidth *= _resolution["default"].scale(1) / riRatio;
481
+ scrollContentProps.itemSize.minHeight *= _resolution["default"].scale(1) / riRatio;
482
+ } else {
483
+ scrollContentProps.itemSize *= _resolution["default"].scale(1) / riRatio;
484
+ if (scrollContentProps.itemSizes) {
485
+ for (var i = 0; i < scrollContentProps.itemSizes.length; i++) {
486
+ scrollContentProps.itemSizes[i] *= _resolution["default"].scale(1) / riRatio;
487
+ }
488
+ }
489
+ }
490
+ setItemSize(scrollContentProps.itemSize);
491
+ }
492
+ setRiRatio(_resolution["default"].scale(1));
493
+ }
438
494
 
439
495
  // `handleSize` in `ui/resolution.ResolutionDecorator` should be executed first.
440
496
  setTimeout(function () {
@@ -812,15 +868,19 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
812
868
  // scrollMode 'translate' ]]
813
869
 
814
870
  // scrollMode 'native' [[
815
- function onScroll(ev) {
871
+ /**
872
+ * Updates scroll position from a scroll event.
873
+ * Handles RTL adjustment and position updates.
874
+ *
875
+ * @param {Event} ev - Scroll event
876
+ * @private
877
+ */
878
+ function updateScrollPosition(ev) {
816
879
  var _ev$target = ev.target,
817
880
  scrollLeft = _ev$target.scrollLeft,
818
881
  scrollTop = _ev$target.scrollTop;
819
882
  var bounds = getScrollBounds(),
820
883
  canScrollH = canScrollHorizontally(bounds);
821
- if (!mutableRef.current.scrolling) {
822
- scrollStartOnScroll();
823
- }
824
884
  if (rtl && canScrollH) {
825
885
  scrollLeft = _platform.platform.chrome < 85 ? bounds.maxLeft - scrollLeft : -scrollLeft;
826
886
  }
@@ -833,8 +893,53 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
833
893
  if (scrollContentHandle.current.didScroll) {
834
894
  scrollContentHandle.current.didScroll(mutableRef.current.scrollLeft, mutableRef.current.scrollTop);
835
895
  }
896
+ }
897
+ function onScroll(ev) {
898
+ // Track if we had a grace timer active before clearing it
899
+ var hadGraceTimer = !!mutableRef.current.scrollEndGraceTimer;
900
+ if (mutableRef.current.scrollEndGraceTimer) {
901
+ clearTimeout(mutableRef.current.scrollEndGraceTimer);
902
+ mutableRef.current.scrollEndGraceTimer = null;
903
+ }
904
+ if (!mutableRef.current.scrolling) {
905
+ scrollStartOnScroll();
906
+ }
907
+ updateScrollPosition(ev);
908
+ if (mutableRef.current.lastInputType === 'wheel' && !mutableRef.current.isScrollAnimationTargetAccumulated) {
909
+ mutableRef.current.isScrollAnimationTargetAccumulated = true;
910
+ }
836
911
  forwardScrollEvent('onScroll');
837
- mutableRef.current.scrollStopJob.start();
912
+ if (!hadGraceTimer) {
913
+ mutableRef.current.scrollStopJob.start();
914
+ }
915
+ }
916
+
917
+ /*
918
+ * Handler for scrollend event
919
+ */
920
+ function onScrollEnd(ev) {
921
+ if (!mutableRef.current.scrolling) {
922
+ return;
923
+ }
924
+ updateScrollPosition(ev);
925
+
926
+ // Stop the fallback timer since the native scrollend has fired
927
+ mutableRef.current.scrollStopJob.stop();
928
+
929
+ // stop for non-accumulating scrolls (mouse/touch)
930
+ if (!mutableRef.current.isScrollAnimationTargetAccumulated) {
931
+ scrollStopOnScroll();
932
+ return;
933
+ }
934
+
935
+ // This prevents spamming onScrollStop during smooth scroll continuation
936
+ if (mutableRef.current.scrollEndGraceTimer) {
937
+ clearTimeout(mutableRef.current.scrollEndGraceTimer);
938
+ }
939
+ mutableRef.current.scrollEndGraceTimer = setTimeout(function () {
940
+ mutableRef.current.scrollEndGraceTimer = null;
941
+ scrollStopOnScroll();
942
+ }, 100);
838
943
  }
839
944
  // scrollMode 'native' ]]
840
945
 
@@ -1448,6 +1553,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
1448
1553
  (0, _utilEvent["default"])('scroll').addEventListener(scrollContentRef, onScroll, {
1449
1554
  passive: true
1450
1555
  });
1556
+ (0, _utilEvent["default"])('scrollend').addEventListener(scrollContentRef, onScrollEnd);
1451
1557
  }
1452
1558
  // scrollMode 'native' ]]
1453
1559
 
@@ -1470,6 +1576,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
1470
1576
  (0, _utilEvent["default"])('scroll').removeEventListener(scrollContentRef, onScroll, {
1471
1577
  passive: true
1472
1578
  });
1579
+ (0, _utilEvent["default"])('scrollend').removeEventListener(scrollContentRef, onScrollEnd);
1473
1580
  // scrollMode 'native' ]]
1474
1581
 
1475
1582
  if (props.removeEventListeners) {
@@ -1512,22 +1619,6 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
1512
1619
  onFlick: onFlick,
1513
1620
  onTouchStart: scrollMode === 'native' ? onTouchStart : null // scrollMode 'native'
1514
1621
  }));
1515
- var scrollContentProps = props.itemRenderer ?
1516
- // If the child component is a VirtualList
1517
- {
1518
- childProps: childProps,
1519
- clientSize: clientSize,
1520
- dataSize: dataSize,
1521
- itemRenderer: itemRenderer,
1522
- itemSize: itemSize,
1523
- itemSizes: itemSizes,
1524
- overhang: overhang,
1525
- pageScroll: pageScroll,
1526
- spacing: spacing,
1527
- wrap: wrap
1528
- } : {
1529
- children: children
1530
- };
1531
1622
  assignProperties('scrollContentProps', _objectSpread(_objectSpread({}, scrollContentProps), {}, {
1532
1623
  cbScrollTo: scrollTo,
1533
1624
  className: [_useScrollModule["default"].scrollFill],
@@ -1622,7 +1713,7 @@ var useScroll = exports.useScroll = function useScroll(props) {
1622
1713
  isVerticalScrollbarVisible = _useScrollBase.isVerticalScrollbarVisible;
1623
1714
  assignProperties('scrollContainerProps', {
1624
1715
  ref: scrollContainerRef
1625
- });
1716
+ }); // eslint-disable-line react-hooks/refs
1626
1717
  assignProperties('scrollContentProps', _objectSpread(_objectSpread({}, props.itemRenderer ? {
1627
1718
  itemRefs: itemRefs
1628
1719
  } : {}), {}, {
@@ -1630,10 +1721,10 @@ var useScroll = exports.useScroll = function useScroll(props) {
1630
1721
  }));
1631
1722
  assignProperties('verticalScrollbarProps', {
1632
1723
  scrollbarHandle: verticalScrollbarHandle
1633
- });
1724
+ }); // eslint-disable-line react-hooks/refs
1634
1725
  assignProperties('horizontalScrollbarProps', {
1635
1726
  scrollbarHandle: horizontalScrollbarHandle
1636
- });
1727
+ }); // eslint-disable-line react-hooks/refs
1637
1728
 
1638
1729
  // Return
1639
1730
 
@@ -6,10 +6,25 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.utilEvent = exports["default"] = void 0;
7
7
  // A `React.useEvent` hooks is introduced in https://github.com/facebook/react/pull/17651
8
8
  // The `useEvent` below will be replaced with the `React.useEvent` later.
9
+
10
+ /*
11
+ * Detects if the browser natively supports the scrollend event.
12
+ */
13
+ var supportsScrollEnd = function supportsScrollEnd() {
14
+ if (typeof window === 'undefined') {
15
+ return false;
16
+ }
17
+ return 'onscrollend' in window;
18
+ };
9
19
  var utilEvent = exports.utilEvent = function utilEvent(eventName) {
20
+ var isScrollEndEvent = eventName === 'scrollend';
21
+ var hasNativeScrollEnd = isScrollEndEvent && supportsScrollEnd();
10
22
  return {
11
23
  addEventListener: function addEventListener(ref, fn, param) {
12
24
  if (!ref) return;
25
+ if (isScrollEndEvent && !hasNativeScrollEnd) {
26
+ return;
27
+ }
13
28
  if (typeof window !== 'undefined' && (ref === window || ref === document)) {
14
29
  ref.addEventListener(eventName, fn, param);
15
30
  } else if (ref.current) {
@@ -20,6 +35,9 @@ var utilEvent = exports.utilEvent = function utilEvent(eventName) {
20
35
  },
21
36
  removeEventListener: function removeEventListener(ref, fn, param) {
22
37
  if (!ref) return;
38
+ if (isScrollEndEvent && !hasNativeScrollEnd) {
39
+ return;
40
+ }
23
41
  if (typeof window !== 'undefined' && (ref === window || ref === document)) {
24
42
  ref.removeEventListener(eventName, fn, param);
25
43
  } else if (ref.current) {