@enact/ui 5.4.4 → 5.5.1

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 +30 -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 +170 -32
  47. package/VirtualList/tests/VirtualList-native-specs.js +233 -3
  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 +8 -3
  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 +408 -42
  64. package/useScroll/useScroll.js +132 -27
  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", "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.
@@ -138,6 +138,7 @@ function roundTarget(currentPosition, targetX, targetY) {
138
138
  * @private
139
139
  */
140
140
  var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
141
+ var _scaledItemSizesRef$c;
141
142
  var childProps = props.childProps,
142
143
  children = props.children,
143
144
  className = props.className,
@@ -148,8 +149,6 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
148
149
  horizontalScrollbar = props.horizontalScrollbar,
149
150
  horizontalScrollbarHandle = props.horizontalScrollbarHandle,
150
151
  itemRenderer = props.itemRenderer,
151
- itemSize = props.itemSize,
152
- itemSizes = props.itemSizes,
153
152
  noScrollByDrag = props.noScrollByDrag,
154
153
  noScrollByWheel = props.noScrollByWheel,
155
154
  overhang = props.overhang,
@@ -179,6 +178,8 @@ 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
+ delete rest.itemSizes;
182
183
  delete rest.onFlick;
183
184
  delete rest.onKeyDown;
184
185
  delete rest.onMouseDown;
@@ -207,10 +208,29 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
207
208
  _useState4 = _slicedToArray(_useState3, 2),
208
209
  isVerticalScrollbarVisible = _useState4[0],
209
210
  setIsVerticalScrollbarVisible = _useState4[1];
211
+ var _useState5 = (0, _react.useState)(_resolution["default"].scale(1)),
212
+ _useState6 = _slicedToArray(_useState5, 2),
213
+ riRatio = _useState6[0],
214
+ setRiRatio = _useState6[1];
215
+ var _useState7 = (0, _react.useState)(props.itemSize),
216
+ _useState8 = _slicedToArray(_useState7, 2),
217
+ originalItemSize = _useState8[0],
218
+ setOriginalItemSize = _useState8[1];
219
+ var _useState9 = (0, _react.useState)(props.itemSize),
220
+ _useState0 = _slicedToArray(_useState9, 2),
221
+ itemSize = _useState0[0],
222
+ setItemSize = _useState0[1];
223
+ var scaledItemSizesRef = (0, _react.useRef)(null);
224
+ var scaledItemSizesSourceRef = (0, _react.useRef)(props.itemSizes);
225
+ if (scaledItemSizesSourceRef.current !== props.itemSizes) {
226
+ scaledItemSizesRef.current = null;
227
+ scaledItemSizesSourceRef.current = props.itemSizes;
228
+ }
210
229
  var mutableRef = (0, _react.useRef)({
211
230
  overscrollEnabled: !!props.applyOverscrollEffect,
212
231
  // Enable the early bail out of repeated scrolling to the same position
213
232
  animationInfo: null,
233
+ scrollEndGraceTimer: null,
214
234
  resizeRegistry: null,
215
235
  // constants
216
236
  pixelPerLine: 39,
@@ -336,6 +356,16 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
336
356
  mutableRef.current.wheelDirection = val;
337
357
  }
338
358
  });
359
+ if ((originalItemSize || originalItemSize === 0 || props.itemSize || props.itemSize === 0) && originalItemSize !== props.itemSize) {
360
+ setOriginalItemSize(props.itemSize);
361
+ if (typeof props.itemSize === 'object') {
362
+ if (_resolution["default"].scale(1) / riRatio !== props.itemSize.minWidth / itemSize.minWidth || _resolution["default"].scale(1) / riRatio !== props.itemSize.minHeight / itemSize.minHeight) {
363
+ setItemSize(props.itemSize);
364
+ }
365
+ } else if (_resolution["default"].scale(1) / riRatio !== props.itemSize / itemSize) {
366
+ setItemSize(props.itemSize);
367
+ }
368
+ }
339
369
  if (mutableRef.current.animator == null) {
340
370
  mutableRef.current.animator = new _ScrollAnimator["default"]();
341
371
  }
@@ -433,8 +463,44 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
433
463
  }, [forceUpdate, scrollContentHandle]);
434
464
  // scrollMode 'translate' ]]
435
465
 
466
+ var scrollContentProps = props.itemRenderer ?
467
+ // If the child component is a VirtualList
468
+ {
469
+ childProps: childProps,
470
+ clientSize: clientSize,
471
+ dataSize: dataSize,
472
+ itemRenderer: itemRenderer,
473
+ itemSize: itemSize,
474
+ itemSizes: (_scaledItemSizesRef$c = scaledItemSizesRef.current) !== null && _scaledItemSizesRef$c !== void 0 ? _scaledItemSizesRef$c : props.itemSizes,
475
+ overhang: overhang,
476
+ pageScroll: pageScroll,
477
+ spacing: spacing,
478
+ wrap: wrap
479
+ } : {
480
+ children: children
481
+ };
436
482
  function handleResizeWindow() {
437
483
  var propsHandleResizeWindow = props.handleResizeWindow;
484
+ if (_resolution["default"].scale(1) !== riRatio) {
485
+ if (scrollContentProps.itemSize) {
486
+ var ratio = _resolution["default"].scale(1) / riRatio;
487
+ if (scrollContentProps.itemSize.minWidth && scrollContentProps.itemSize.minHeight) {
488
+ scrollContentProps.itemSize = _objectSpread(_objectSpread({}, scrollContentProps.itemSize), {}, {
489
+ minWidth: scrollContentProps.itemSize.minWidth * ratio,
490
+ minHeight: scrollContentProps.itemSize.minHeight * ratio
491
+ });
492
+ } else {
493
+ scrollContentProps.itemSize *= ratio;
494
+ if (scrollContentProps.itemSizes) {
495
+ scaledItemSizesRef.current = scrollContentProps.itemSizes.map(function (s) {
496
+ return s * ratio;
497
+ });
498
+ }
499
+ }
500
+ setItemSize(scrollContentProps.itemSize);
501
+ }
502
+ setRiRatio(_resolution["default"].scale(1));
503
+ }
438
504
 
439
505
  // `handleSize` in `ui/resolution.ResolutionDecorator` should be executed first.
440
506
  setTimeout(function () {
@@ -812,15 +878,19 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
812
878
  // scrollMode 'translate' ]]
813
879
 
814
880
  // scrollMode 'native' [[
815
- function onScroll(ev) {
881
+ /**
882
+ * Updates scroll position from a scroll event.
883
+ * Handles RTL adjustment and position updates.
884
+ *
885
+ * @param {Event} ev - Scroll event
886
+ * @private
887
+ */
888
+ function updateScrollPosition(ev) {
816
889
  var _ev$target = ev.target,
817
890
  scrollLeft = _ev$target.scrollLeft,
818
891
  scrollTop = _ev$target.scrollTop;
819
892
  var bounds = getScrollBounds(),
820
893
  canScrollH = canScrollHorizontally(bounds);
821
- if (!mutableRef.current.scrolling) {
822
- scrollStartOnScroll();
823
- }
824
894
  if (rtl && canScrollH) {
825
895
  scrollLeft = _platform.platform.chrome < 85 ? bounds.maxLeft - scrollLeft : -scrollLeft;
826
896
  }
@@ -833,8 +903,55 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
833
903
  if (scrollContentHandle.current.didScroll) {
834
904
  scrollContentHandle.current.didScroll(mutableRef.current.scrollLeft, mutableRef.current.scrollTop);
835
905
  }
906
+ }
907
+ function onScroll(ev) {
908
+ // Track if we had a grace timer active before clearing it
909
+ var hadGraceTimer = !!mutableRef.current.scrollEndGraceTimer;
910
+ if (mutableRef.current.scrollEndGraceTimer) {
911
+ clearTimeout(mutableRef.current.scrollEndGraceTimer);
912
+ mutableRef.current.scrollEndGraceTimer = null;
913
+ }
914
+ if (!mutableRef.current.scrolling) {
915
+ scrollStartOnScroll();
916
+ }
917
+ updateScrollPosition(ev);
918
+ if (mutableRef.current.lastInputType === 'wheel' && !mutableRef.current.isScrollAnimationTargetAccumulated) {
919
+ mutableRef.current.isScrollAnimationTargetAccumulated = true;
920
+ }
836
921
  forwardScrollEvent('onScroll');
837
- mutableRef.current.scrollStopJob.start();
922
+ if (!hadGraceTimer) {
923
+ mutableRef.current.scrollStopJob.start();
924
+ }
925
+ }
926
+
927
+ /*
928
+ * Handler for scrollend event
929
+ */
930
+ function onScrollEnd(ev) {
931
+ var _scrollContentHandle$;
932
+ if (!mutableRef.current.scrolling || mutableRef.current.keyPressed || (_scrollContentHandle$ = scrollContentHandle.current) !== null && _scrollContentHandle$ !== void 0 && _scrollContentHandle$.scrolling) {
933
+ return;
934
+ }
935
+ updateScrollPosition(ev);
936
+
937
+ // Stop the fallback timer since the native scrollend has fired
938
+ mutableRef.current.scrollStopJob.stop();
939
+
940
+ // stop for non-accumulating scrolls (mouse/touch)
941
+ if (!mutableRef.current.isScrollAnimationTargetAccumulated && !mutableRef.current.keyScroll) {
942
+ scrollStopOnScroll();
943
+ return;
944
+ }
945
+
946
+ // This prevents spamming onScrollStop during smooth scroll continuation
947
+ if (mutableRef.current.scrollEndGraceTimer) {
948
+ clearTimeout(mutableRef.current.scrollEndGraceTimer);
949
+ }
950
+ mutableRef.current.scrollEndGraceTimer = setTimeout(function () {
951
+ mutableRef.current.scrollEndGraceTimer = null;
952
+ mutableRef.current.keyScroll = false;
953
+ scrollStopOnScroll();
954
+ }, 100);
838
955
  }
839
956
  // scrollMode 'native' ]]
840
957
 
@@ -858,6 +975,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
858
975
  }
859
976
  function onKeyUp(ev) {
860
977
  mutableRef.current.keyPressed = false;
978
+ mutableRef.current.keyScroll = true;
861
979
  (0, _handle.forward)('onKeyUp', ev, props);
862
980
  }
863
981
  function scrollToAccumulatedTarget(delta, vertical, overscrollEffect) {
@@ -1172,6 +1290,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
1172
1290
  roundedTargetX = _roundTarget.roundedTargetX,
1173
1291
  roundedTargetY = _roundTarget.roundedTargetY;
1174
1292
  if (animate) {
1293
+ scrollContentRef.current.lastInputType = mutableRef.current.lastInputType;
1175
1294
  scrollContentHandle.current.scrollToPosition(roundedTargetX, roundedTargetY, 'smooth', mutableRef.current.repeat);
1176
1295
  } else {
1177
1296
  scrollContentHandle.current.scrollToPosition(roundedTargetX, roundedTargetY, 'instant');
@@ -1450,6 +1569,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
1450
1569
  (0, _utilEvent["default"])('scroll').addEventListener(scrollContentRef, onScroll, {
1451
1570
  passive: true
1452
1571
  });
1572
+ (0, _utilEvent["default"])('scrollend').addEventListener(scrollContentRef, onScrollEnd);
1453
1573
  }
1454
1574
  // scrollMode 'native' ]]
1455
1575
 
@@ -1472,6 +1592,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
1472
1592
  (0, _utilEvent["default"])('scroll').removeEventListener(scrollContentRef, onScroll, {
1473
1593
  passive: true
1474
1594
  });
1595
+ (0, _utilEvent["default"])('scrollend').removeEventListener(scrollContentRef, onScrollEnd);
1475
1596
  // scrollMode 'native' ]]
1476
1597
 
1477
1598
  if (props.removeEventListeners) {
@@ -1514,22 +1635,6 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
1514
1635
  onFlick: onFlick,
1515
1636
  onTouchStart: scrollMode === 'native' ? onTouchStart : null // scrollMode 'native'
1516
1637
  }));
1517
- var scrollContentProps = props.itemRenderer ?
1518
- // If the child component is a VirtualList
1519
- {
1520
- childProps: childProps,
1521
- clientSize: clientSize,
1522
- dataSize: dataSize,
1523
- itemRenderer: itemRenderer,
1524
- itemSize: itemSize,
1525
- itemSizes: itemSizes,
1526
- overhang: overhang,
1527
- pageScroll: pageScroll,
1528
- spacing: spacing,
1529
- wrap: wrap
1530
- } : {
1531
- children: children
1532
- };
1533
1638
  assignProperties('scrollContentProps', _objectSpread(_objectSpread({}, scrollContentProps), {}, {
1534
1639
  cbScrollTo: scrollTo,
1535
1640
  className: [_useScrollModule["default"].scrollFill],
@@ -1624,7 +1729,7 @@ var useScroll = exports.useScroll = function useScroll(props) {
1624
1729
  isVerticalScrollbarVisible = _useScrollBase.isVerticalScrollbarVisible;
1625
1730
  assignProperties('scrollContainerProps', {
1626
1731
  ref: scrollContainerRef
1627
- });
1732
+ }); // eslint-disable-line react-hooks/refs
1628
1733
  assignProperties('scrollContentProps', _objectSpread(_objectSpread({}, props.itemRenderer ? {
1629
1734
  itemRefs: itemRefs
1630
1735
  } : {}), {}, {
@@ -1632,10 +1737,10 @@ var useScroll = exports.useScroll = function useScroll(props) {
1632
1737
  }));
1633
1738
  assignProperties('verticalScrollbarProps', {
1634
1739
  scrollbarHandle: verticalScrollbarHandle
1635
- });
1740
+ }); // eslint-disable-line react-hooks/refs
1636
1741
  assignProperties('horizontalScrollbarProps', {
1637
1742
  scrollbarHandle: horizontalScrollbarHandle
1638
- });
1743
+ }); // eslint-disable-line react-hooks/refs
1639
1744
 
1640
1745
  // Return
1641
1746
 
@@ -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) {