@enact/ui 5.4.2 → 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.
- package/AnnounceDecorator/Announce.js +9 -5
- package/AnnounceDecorator/AnnounceDecorator.js +5 -3
- package/AnnounceDecorator/tests/AnnounceDecorator-specs.js +4 -1
- package/AnnounceDecorator/tests/useAnnounce-specs.js +4 -1
- package/CHANGELOG.md +25 -0
- package/Cancelable/Cancelable.js +7 -0
- package/Cancelable/tests/Cancelable-specs.js +26 -0
- package/Changeable/Changeable.js +6 -0
- package/Changeable/tests/Changeable-specs.js +4 -1
- package/FloatingLayer/FloatingLayer.js +3 -0
- package/FloatingLayer/FloatingLayerDecorator.js +2 -0
- package/FloatingLayer/Scrim.js +3 -0
- package/Marquee/Marquee.module.css +1 -1
- package/Marquee/MarqueeDecorator.js +19 -3
- package/Marquee/tests/Marquee-specs.js +306 -1
- package/Marquee/useMarqueeController.js +6 -4
- package/Measurable/tests/Measurable-specs.js +6 -2
- package/Media/Media.js +5 -2
- package/Placeholder/tests/PlaceholderControllerDecorator-specs.js +4 -1
- package/Resizable/tests/Resizable-specs.js +4 -1
- package/Resizable/tests/useResize-specs.js +4 -1
- package/Routable/Route.js +5 -3
- package/Routable/Router.js +25 -16
- package/Routable/tests/Routable-specs.js +16 -0
- package/Scroller/Scroller.js +6 -5
- package/Scroller/ScrollerBasic.js +5 -5
- package/Skinnable/Skinnable.js +9 -7
- package/Skinnable/tests/Skinnable-specs.js +7 -2
- package/Skinnable/useSkins.js +6 -2
- package/Slider/PositionDecorator.js +20 -5
- package/Slider/Slider.d.ts +4 -0
- package/Slider/Slider.js +10 -0
- package/Slider/tests/Slider-specs.js +18 -0
- package/Slider/utils.js +9 -1
- package/Toggleable/Toggleable.js +4 -2
- package/Toggleable/tests/Toggleable-specs.js +4 -1
- package/Touchable/Touchable.js +6 -4
- package/Touchable/tests/Touchable-specs.js +4 -1
- package/Touchable/tests/useTouch-specs.js +4 -1
- package/Touchable/useTouch.js +7 -2
- package/Transition/Transition.js +2 -0
- package/ViewManager/TransitionGroup.js +3 -0
- package/ViewManager/View.js +2 -0
- package/ViewManager/ViewManager.js +7 -0
- package/VirtualList/VirtualList.js +7 -5
- package/VirtualList/VirtualListBasic.js +12 -7
- package/VirtualList/tests/VirtualList-native-specs.js +14 -0
- package/VirtualList/tests/VirtualList-specs.js +13 -0
- package/internal/IdProvider/IdProvider.js +2 -0
- package/internal/IdProvider/tests/IdProvider-specs.js +4 -1
- package/internal/Pure/tests/Pure-specs.js +7 -0
- package/package.json +12 -7
- package/resolution/ResolutionDecorator.js +21 -18
- package/resolution/index.d.ts +63 -4
- package/resolution/index.js +18 -2
- package/resolution/resolution.js +209 -29
- package/resolution/tests/ResolutionDecorator-specs.js +84 -4
- package/resolution/tests/resolution-specs.js +217 -599
- package/useControlledState/tests/useControlledState-specs.js +4 -1
- package/useControlledState/useControlledState.js +11 -7
- package/useScroll/Scrollbar.js +27 -24
- package/useScroll/ScrollbarTrack.js +5 -3
- package/useScroll/tests/useScroll-specs.js +148 -7
- package/useScroll/useScroll.js +94 -14
- package/useScroll/utilEvent.js +18 -0
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
require("@testing-library/jest-dom");
|
|
4
4
|
var _react = require("@testing-library/react");
|
|
5
|
+
var _react2 = require("react");
|
|
5
6
|
var _useControlledState3 = _interopRequireDefault(require("../useControlledState"));
|
|
6
7
|
var _jsxRuntime = require("react/jsx-runtime");
|
|
7
8
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
@@ -21,7 +22,9 @@ describe('useControlledState', function () {
|
|
|
21
22
|
var handleChange = function handleChange(ev) {
|
|
22
23
|
return setValue(ev.value);
|
|
23
24
|
};
|
|
24
|
-
|
|
25
|
+
(0, _react2.useEffect)(function () {
|
|
26
|
+
data = setValue;
|
|
27
|
+
}, [setValue]);
|
|
25
28
|
return /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
|
|
26
29
|
onChange: handleChange,
|
|
27
30
|
children: value
|
|
@@ -39,14 +39,18 @@ function calcValue(defaultValue, propValue, stateValue, controlled) {
|
|
|
39
39
|
return propValue !== undefined ? propValue : defaultValue;
|
|
40
40
|
}
|
|
41
41
|
function useControlledState(defaultValue, propValue, controlled) {
|
|
42
|
-
var
|
|
42
|
+
var _useState = (0, _react.useState)(controlled),
|
|
43
|
+
_useState2 = _slicedToArray(_useState, 1),
|
|
44
|
+
isControlled = _useState2[0];
|
|
43
45
|
|
|
44
46
|
// Store both the value and the "controlled" flag in a state hook
|
|
45
|
-
var
|
|
46
|
-
|
|
47
|
-
value =
|
|
48
|
-
onChange =
|
|
49
|
-
var memoOnChange = (0, _react.useMemo)(
|
|
50
|
-
|
|
47
|
+
var _useState3 = (0, _react.useState)(defaultValue),
|
|
48
|
+
_useState4 = _slicedToArray(_useState3, 2),
|
|
49
|
+
value = _useState4[0],
|
|
50
|
+
onChange = _useState4[1];
|
|
51
|
+
var memoOnChange = (0, _react.useMemo)(function () {
|
|
52
|
+
return createHandler();
|
|
53
|
+
}, []);
|
|
54
|
+
return [calcValue(defaultValue, propValue, value, isControlled), memoOnChange(onChange, value, isControlled)];
|
|
51
55
|
}
|
|
52
56
|
var _default = exports["default"] = useControlledState;
|
package/useScroll/Scrollbar.js
CHANGED
|
@@ -68,33 +68,27 @@ var useScrollbar = exports.useScrollbar = function useScrollbar(props) {
|
|
|
68
68
|
corner = props.corner,
|
|
69
69
|
css = props.css,
|
|
70
70
|
minThumbSize = props.minThumbSize,
|
|
71
|
-
|
|
71
|
+
scrollbarHandleRef = props.scrollbarHandle,
|
|
72
72
|
vertical = props.vertical,
|
|
73
73
|
rest = _objectWithoutProperties(props, _excluded);
|
|
74
74
|
// Refs
|
|
75
75
|
var scrollbarContainerRef = (0, _react.useRef)();
|
|
76
76
|
var scrollbarTrackRef = (0, _react.useRef)();
|
|
77
77
|
var hideScrollbarTrackJob = (0, _react.useRef)(null);
|
|
78
|
-
|
|
79
|
-
function hideScrollbarTrack() {
|
|
78
|
+
var hideScrollbarTrack = (0, _react.useCallback)(function () {
|
|
80
79
|
removeClass(scrollbarTrackRef.current, css.scrollbarTrackShown);
|
|
81
|
-
}
|
|
82
|
-
(0, _react.
|
|
83
|
-
return function () {
|
|
84
|
-
hideScrollbarTrackJob.current.stop();
|
|
85
|
-
};
|
|
86
|
-
}, []);
|
|
87
|
-
function getContainerRef() {
|
|
80
|
+
}, [css.scrollbarTrackShown]);
|
|
81
|
+
var getContainerRef = (0, _react.useCallback)(function () {
|
|
88
82
|
return scrollbarContainerRef;
|
|
89
|
-
}
|
|
90
|
-
|
|
83
|
+
}, []);
|
|
84
|
+
var showScrollbarTrack = (0, _react.useCallback)(function () {
|
|
91
85
|
hideScrollbarTrackJob.current.stop();
|
|
92
86
|
addClass(scrollbarTrackRef.current, css.scrollbarTrackShown);
|
|
93
|
-
}
|
|
94
|
-
|
|
87
|
+
}, [css.scrollbarTrackShown]);
|
|
88
|
+
var startHidingScrollbarTrack = (0, _react.useCallback)(function () {
|
|
95
89
|
hideScrollbarTrackJob.current.start();
|
|
96
|
-
}
|
|
97
|
-
|
|
90
|
+
}, []);
|
|
91
|
+
var update = (0, _react.useCallback)(function (bounds) {
|
|
98
92
|
var primaryDimension = vertical ? 'clientHeight' : 'clientWidth',
|
|
99
93
|
trackSize = clientSize ? clientSize[primaryDimension] : scrollbarContainerRef.current[primaryDimension],
|
|
100
94
|
scrollViewSize = vertical ? bounds.clientHeight : bounds.clientWidth,
|
|
@@ -105,15 +99,23 @@ var useScrollbar = exports.useScrollbar = function useScrollbar(props) {
|
|
|
105
99
|
scrollbarThumbSizeRatio = trackSize !== 0 ? Math.max(_resolution["default"].scale(minThumbSize) / trackSize, Math.min(1, scrollbarThumbSizeRatioBase)) : 1;
|
|
106
100
|
setCSSVariable(scrollbarTrackRef.current, '--scrollbar-thumb-size-ratio', scrollbarThumbSizeRatio);
|
|
107
101
|
setCSSVariable(scrollbarTrackRef.current, '--scrollbar-thumb-progress-ratio', scrollbarThumbProgressRatio);
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
102
|
+
}, [clientSize, minThumbSize, vertical]);
|
|
103
|
+
(0, _react.useLayoutEffect)(function () {
|
|
104
|
+
if (scrollbarHandleRef) {
|
|
105
|
+
scrollbarHandleRef.current = {
|
|
106
|
+
getContainerRef: getContainerRef,
|
|
107
|
+
showScrollbarTrack: showScrollbarTrack,
|
|
108
|
+
startHidingScrollbarTrack: startHidingScrollbarTrack,
|
|
109
|
+
update: update
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
hideScrollbarTrackJob.current = hideScrollbarTrackJob.current || new _util.Job(hideScrollbarTrack, scrollbarTrackHidingDelay);
|
|
113
|
+
}, [getContainerRef, hideScrollbarTrack, scrollbarHandleRef, showScrollbarTrack, startHidingScrollbarTrack, update]);
|
|
114
|
+
(0, _react.useEffect)(function () {
|
|
115
|
+
return function () {
|
|
116
|
+
hideScrollbarTrackJob.current.stop();
|
|
115
117
|
};
|
|
116
|
-
}
|
|
118
|
+
}, []);
|
|
117
119
|
return {
|
|
118
120
|
restProps: rest,
|
|
119
121
|
scrollbarProps: {
|
|
@@ -155,6 +157,7 @@ var Scrollbar = exports.ScrollbarBase = exports.Scrollbar = /*#__PURE__*/(0, _re
|
|
|
155
157
|
restProps = _useScrollbar.restProps,
|
|
156
158
|
scrollbarProps = _useScrollbar.scrollbarProps,
|
|
157
159
|
scrollbarTrackProps = _useScrollbar.scrollbarTrackProps;
|
|
160
|
+
(0, _util.checkPropTypes)(Scrollbar, props);
|
|
158
161
|
return /*#__PURE__*/(0, _jsxRuntime.jsx)("div", _objectSpread(_objectSpread(_objectSpread({}, restProps), scrollbarProps), {}, {
|
|
159
162
|
children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_ScrollbarTrack["default"], _objectSpread({}, scrollbarTrackProps))
|
|
160
163
|
}));
|
|
@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = exports.ScrollbarTrackBase = exports.MemoizedScrollbarTrack = void 0;
|
|
7
|
+
var _util = require("@enact/core/util");
|
|
7
8
|
var _classnames = _interopRequireDefault(require("classnames"));
|
|
8
9
|
var _propTypes = _interopRequireDefault(require("prop-types"));
|
|
9
10
|
var _react = require("react");
|
|
@@ -26,7 +27,8 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
|
|
|
26
27
|
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); }
|
|
27
28
|
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; }
|
|
28
29
|
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; }
|
|
29
|
-
var
|
|
30
|
+
var _ScrollbarTrack = function ScrollbarTrack(props) {
|
|
31
|
+
(0, _util.checkPropTypes)(_ScrollbarTrack, props);
|
|
30
32
|
var _props$ref = props.ref,
|
|
31
33
|
ref = _props$ref === void 0 ? null : _props$ref,
|
|
32
34
|
_props$vertical = props.vertical,
|
|
@@ -38,7 +40,7 @@ var ScrollbarTrack = function ScrollbarTrack(props) {
|
|
|
38
40
|
ref: ref
|
|
39
41
|
}));
|
|
40
42
|
};
|
|
41
|
-
|
|
43
|
+
_ScrollbarTrack.propTypes = /** @lends ui/useScroll.ScrollbarTrack.prototype */{
|
|
42
44
|
/**
|
|
43
45
|
* Forwards a reference to the DOM element.
|
|
44
46
|
*
|
|
@@ -57,6 +59,6 @@ ScrollbarTrack.propTypes = /** @lends ui/useScroll.ScrollbarTrack.prototype */{
|
|
|
57
59
|
*/
|
|
58
60
|
vertical: _propTypes["default"].bool
|
|
59
61
|
};
|
|
60
|
-
var MemoizedScrollbarTrack = exports.ScrollbarTrackBase = exports.MemoizedScrollbarTrack = /*#__PURE__*/(0, _react.memo)(
|
|
62
|
+
var MemoizedScrollbarTrack = exports.ScrollbarTrackBase = exports.MemoizedScrollbarTrack = /*#__PURE__*/(0, _react.memo)(_ScrollbarTrack);
|
|
61
63
|
MemoizedScrollbarTrack.displayName = 'ui:ScrollbarTrack';
|
|
62
64
|
var _default = exports["default"] = MemoizedScrollbarTrack;
|
|
@@ -63,10 +63,13 @@ function createMockRefs() {
|
|
|
63
63
|
return {
|
|
64
64
|
clientWidth: 1920,
|
|
65
65
|
clientHeight: 1080,
|
|
66
|
-
scrollWidth:
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
66
|
+
scrollWidth: 2000,
|
|
67
|
+
// greater than clientWidth
|
|
68
|
+
scrollHeight: 2000,
|
|
69
|
+
// greater than clientHeight
|
|
70
|
+
maxTop: 920,
|
|
71
|
+
// 2000 - 1080 = 920
|
|
72
|
+
maxLeft: 80 // 2000 - 1920 = 80
|
|
70
73
|
};
|
|
71
74
|
}),
|
|
72
75
|
getMoreInfo: jest.fn(function () {
|
|
@@ -80,6 +83,7 @@ function createMockRefs() {
|
|
|
80
83
|
return x;
|
|
81
84
|
}),
|
|
82
85
|
calculateMetrics: jest.fn(),
|
|
86
|
+
didScroll: jest.fn(),
|
|
83
87
|
props: {}
|
|
84
88
|
}
|
|
85
89
|
},
|
|
@@ -95,7 +99,8 @@ function createMockRefs() {
|
|
|
95
99
|
getContainerRef: jest.fn(function () {
|
|
96
100
|
return document.createElement('div');
|
|
97
101
|
}),
|
|
98
|
-
startHidingScrollbarTrack: jest.fn()
|
|
102
|
+
startHidingScrollbarTrack: jest.fn(),
|
|
103
|
+
showScrollbarTrack: jest.fn()
|
|
99
104
|
}
|
|
100
105
|
},
|
|
101
106
|
verticalScrollbarHandle: {
|
|
@@ -104,7 +109,8 @@ function createMockRefs() {
|
|
|
104
109
|
getContainerRef: jest.fn(function () {
|
|
105
110
|
return document.createElement('div');
|
|
106
111
|
}),
|
|
107
|
-
startHidingScrollbarTrack: jest.fn()
|
|
112
|
+
startHidingScrollbarTrack: jest.fn(),
|
|
113
|
+
showScrollbarTrack: jest.fn()
|
|
108
114
|
}
|
|
109
115
|
}
|
|
110
116
|
};
|
|
@@ -155,7 +161,39 @@ describe('useScroll', function () {
|
|
|
155
161
|
expect(itemSize.minWidth).toBe(200);
|
|
156
162
|
expect(itemSize.minHeight).toBe(100);
|
|
157
163
|
});
|
|
158
|
-
test('should
|
|
164
|
+
test('should scale itemSizes when ri.scale(1) changes from 1 to 2', function () {
|
|
165
|
+
mockRiScale = jest.fn(function (val) {
|
|
166
|
+
return val;
|
|
167
|
+
});
|
|
168
|
+
var itemSize = 100;
|
|
169
|
+
var itemSizes = [100, 100, 100, 100, 100];
|
|
170
|
+
var mocks = createMockRefs();
|
|
171
|
+
var props = _objectSpread(_objectSpread({
|
|
172
|
+
itemRenderer: jest.fn(),
|
|
173
|
+
itemSize: itemSize,
|
|
174
|
+
itemSizes: itemSizes,
|
|
175
|
+
direction: 'vertical',
|
|
176
|
+
scrollMode: 'translate'
|
|
177
|
+
}, mocks), {}, {
|
|
178
|
+
assignProperties: jest.fn(),
|
|
179
|
+
horizontalScrollbar: 'auto',
|
|
180
|
+
verticalScrollbar: 'auto'
|
|
181
|
+
});
|
|
182
|
+
(0, _react.renderHook)(function () {
|
|
183
|
+
return (0, _useScroll.useScrollBase)(props);
|
|
184
|
+
});
|
|
185
|
+
mockRiScale = jest.fn(function () {
|
|
186
|
+
return 2;
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
// eslint-disable-next-line testing-library/no-unnecessary-act
|
|
190
|
+
(0, _react.act)(function () {
|
|
191
|
+
(0, _react.fireEvent)(window, new Event('resize'));
|
|
192
|
+
jest.runAllTimers();
|
|
193
|
+
});
|
|
194
|
+
expect(itemSizes[1]).toBe(200);
|
|
195
|
+
});
|
|
196
|
+
test('should NOT scale itemSize when ri.scale(1) remains unchanged', function () {
|
|
159
197
|
mockRiScale = jest.fn(function (val) {
|
|
160
198
|
return val;
|
|
161
199
|
});
|
|
@@ -186,6 +224,35 @@ describe('useScroll', function () {
|
|
|
186
224
|
expect(itemSize.minWidth).toBe(100);
|
|
187
225
|
expect(itemSize.minHeight).toBe(50);
|
|
188
226
|
});
|
|
227
|
+
test('should NOT scale itemSizes when ri.scale(1) remains unchanged', function () {
|
|
228
|
+
mockRiScale = jest.fn(function (val) {
|
|
229
|
+
return val;
|
|
230
|
+
});
|
|
231
|
+
var itemSize = 100;
|
|
232
|
+
var itemSizes = [100, 100, 100, 100, 100];
|
|
233
|
+
var mocks = createMockRefs();
|
|
234
|
+
var props = _objectSpread(_objectSpread({
|
|
235
|
+
itemRenderer: jest.fn(),
|
|
236
|
+
itemSize: itemSize,
|
|
237
|
+
itemSizes: itemSizes,
|
|
238
|
+
direction: 'vertical',
|
|
239
|
+
scrollMode: 'translate'
|
|
240
|
+
}, mocks), {}, {
|
|
241
|
+
assignProperties: jest.fn(),
|
|
242
|
+
horizontalScrollbar: 'auto',
|
|
243
|
+
verticalScrollbar: 'auto'
|
|
244
|
+
});
|
|
245
|
+
(0, _react.renderHook)(function () {
|
|
246
|
+
return (0, _useScroll.useScrollBase)(props);
|
|
247
|
+
});
|
|
248
|
+
|
|
249
|
+
// eslint-disable-next-line testing-library/no-unnecessary-act
|
|
250
|
+
(0, _react.act)(function () {
|
|
251
|
+
(0, _react.fireEvent)(window, new Event('resize'));
|
|
252
|
+
jest.runAllTimers();
|
|
253
|
+
});
|
|
254
|
+
expect(itemSizes[1]).toBe(100);
|
|
255
|
+
});
|
|
189
256
|
test('should NOT scale when minWidth is missing', function () {
|
|
190
257
|
mockRiScale = jest.fn(function (val) {
|
|
191
258
|
return val;
|
|
@@ -312,4 +379,78 @@ describe('useScroll', function () {
|
|
|
312
379
|
expect(roundedTargetY).toEqual(80.8);
|
|
313
380
|
});
|
|
314
381
|
});
|
|
382
|
+
describe('Native scroll behavior', function () {
|
|
383
|
+
beforeEach(function () {
|
|
384
|
+
jest.useFakeTimers();
|
|
385
|
+
mockPlatform = {
|
|
386
|
+
chrome: 132
|
|
387
|
+
};
|
|
388
|
+
mockRiScale = jest.fn(function (val) {
|
|
389
|
+
return val;
|
|
390
|
+
});
|
|
391
|
+
});
|
|
392
|
+
afterEach(function () {
|
|
393
|
+
jest.runOnlyPendingTimers();
|
|
394
|
+
jest.useRealTimers();
|
|
395
|
+
});
|
|
396
|
+
test('should update scroll position from scroll event', function () {
|
|
397
|
+
var mocks = createMockRefs();
|
|
398
|
+
var props = _objectSpread(_objectSpread({
|
|
399
|
+
direction: 'vertical',
|
|
400
|
+
scrollMode: 'native'
|
|
401
|
+
}, mocks), {}, {
|
|
402
|
+
assignProperties: jest.fn(),
|
|
403
|
+
horizontalScrollbar: 'auto',
|
|
404
|
+
verticalScrollbar: 'auto'
|
|
405
|
+
});
|
|
406
|
+
(0, _react.renderHook)(function () {
|
|
407
|
+
return (0, _useScroll.useScrollBase)(props);
|
|
408
|
+
});
|
|
409
|
+
var scrollEvent = new Event('scroll');
|
|
410
|
+
Object.defineProperty(scrollEvent, 'target', {
|
|
411
|
+
value: {
|
|
412
|
+
scrollLeft: 50,
|
|
413
|
+
scrollTop: 150
|
|
414
|
+
},
|
|
415
|
+
writable: false
|
|
416
|
+
});
|
|
417
|
+
|
|
418
|
+
// eslint-disable-next-line testing-library/no-unnecessary-act
|
|
419
|
+
(0, _react.act)(function () {
|
|
420
|
+
(0, _react.fireEvent)(mocks.scrollContentRef.current, scrollEvent);
|
|
421
|
+
});
|
|
422
|
+
expect(mocks.scrollContentHandle.current.didScroll).toHaveBeenCalledWith(50, 150);
|
|
423
|
+
});
|
|
424
|
+
test('should handle RTL scroll position correctly', function () {
|
|
425
|
+
var mocks = createMockRefs();
|
|
426
|
+
mockPlatform = {
|
|
427
|
+
chrome: 132
|
|
428
|
+
};
|
|
429
|
+
var props = _objectSpread(_objectSpread({
|
|
430
|
+
direction: 'horizontal',
|
|
431
|
+
scrollMode: 'native',
|
|
432
|
+
rtl: true
|
|
433
|
+
}, mocks), {}, {
|
|
434
|
+
assignProperties: jest.fn(),
|
|
435
|
+
horizontalScrollbar: 'auto',
|
|
436
|
+
verticalScrollbar: 'auto'
|
|
437
|
+
});
|
|
438
|
+
(0, _react.renderHook)(function () {
|
|
439
|
+
return (0, _useScroll.useScrollBase)(props);
|
|
440
|
+
});
|
|
441
|
+
var scrollEvent = new Event('scroll');
|
|
442
|
+
Object.defineProperty(scrollEvent, 'target', {
|
|
443
|
+
value: {
|
|
444
|
+
scrollLeft: -50,
|
|
445
|
+
scrollTop: 0
|
|
446
|
+
}
|
|
447
|
+
});
|
|
448
|
+
|
|
449
|
+
// eslint-disable-next-line testing-library/no-unnecessary-act
|
|
450
|
+
(0, _react.act)(function () {
|
|
451
|
+
(0, _react.fireEvent)(mocks.scrollContentRef.current, scrollEvent);
|
|
452
|
+
});
|
|
453
|
+
expect(mocks.scrollContentHandle.current.didScroll).toHaveBeenCalledWith(50, 0);
|
|
454
|
+
});
|
|
455
|
+
});
|
|
315
456
|
});
|
package/useScroll/useScroll.js
CHANGED
|
@@ -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", "
|
|
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;
|
|
@@ -211,10 +211,19 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
|
|
|
211
211
|
_useState6 = _slicedToArray(_useState5, 2),
|
|
212
212
|
riRatio = _useState6[0],
|
|
213
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];
|
|
214
222
|
var mutableRef = (0, _react.useRef)({
|
|
215
223
|
overscrollEnabled: !!props.applyOverscrollEffect,
|
|
216
224
|
// Enable the early bail out of repeated scrolling to the same position
|
|
217
225
|
animationInfo: null,
|
|
226
|
+
scrollEndGraceTimer: null,
|
|
218
227
|
resizeRegistry: null,
|
|
219
228
|
// constants
|
|
220
229
|
pixelPerLine: 39,
|
|
@@ -340,6 +349,16 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
|
|
|
340
349
|
mutableRef.current.wheelDirection = val;
|
|
341
350
|
}
|
|
342
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
|
+
}
|
|
343
362
|
if (mutableRef.current.animator == null) {
|
|
344
363
|
mutableRef.current.animator = new _ScrollAnimator["default"]();
|
|
345
364
|
}
|
|
@@ -456,11 +475,21 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
|
|
|
456
475
|
function handleResizeWindow() {
|
|
457
476
|
var propsHandleResizeWindow = props.handleResizeWindow;
|
|
458
477
|
if (_resolution["default"].scale(1) !== riRatio) {
|
|
459
|
-
if (scrollContentProps.itemSize
|
|
460
|
-
scrollContentProps.itemSize.minWidth
|
|
461
|
-
|
|
462
|
-
|
|
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);
|
|
463
491
|
}
|
|
492
|
+
setRiRatio(_resolution["default"].scale(1));
|
|
464
493
|
}
|
|
465
494
|
|
|
466
495
|
// `handleSize` in `ui/resolution.ResolutionDecorator` should be executed first.
|
|
@@ -839,15 +868,19 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
|
|
|
839
868
|
// scrollMode 'translate' ]]
|
|
840
869
|
|
|
841
870
|
// scrollMode 'native' [[
|
|
842
|
-
|
|
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) {
|
|
843
879
|
var _ev$target = ev.target,
|
|
844
880
|
scrollLeft = _ev$target.scrollLeft,
|
|
845
881
|
scrollTop = _ev$target.scrollTop;
|
|
846
882
|
var bounds = getScrollBounds(),
|
|
847
883
|
canScrollH = canScrollHorizontally(bounds);
|
|
848
|
-
if (!mutableRef.current.scrolling) {
|
|
849
|
-
scrollStartOnScroll();
|
|
850
|
-
}
|
|
851
884
|
if (rtl && canScrollH) {
|
|
852
885
|
scrollLeft = _platform.platform.chrome < 85 ? bounds.maxLeft - scrollLeft : -scrollLeft;
|
|
853
886
|
}
|
|
@@ -860,8 +893,53 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
|
|
|
860
893
|
if (scrollContentHandle.current.didScroll) {
|
|
861
894
|
scrollContentHandle.current.didScroll(mutableRef.current.scrollLeft, mutableRef.current.scrollTop);
|
|
862
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
|
+
}
|
|
863
911
|
forwardScrollEvent('onScroll');
|
|
864
|
-
|
|
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);
|
|
865
943
|
}
|
|
866
944
|
// scrollMode 'native' ]]
|
|
867
945
|
|
|
@@ -1475,6 +1553,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
|
|
|
1475
1553
|
(0, _utilEvent["default"])('scroll').addEventListener(scrollContentRef, onScroll, {
|
|
1476
1554
|
passive: true
|
|
1477
1555
|
});
|
|
1556
|
+
(0, _utilEvent["default"])('scrollend').addEventListener(scrollContentRef, onScrollEnd);
|
|
1478
1557
|
}
|
|
1479
1558
|
// scrollMode 'native' ]]
|
|
1480
1559
|
|
|
@@ -1497,6 +1576,7 @@ var useScrollBase = exports.useScrollBase = function useScrollBase(props) {
|
|
|
1497
1576
|
(0, _utilEvent["default"])('scroll').removeEventListener(scrollContentRef, onScroll, {
|
|
1498
1577
|
passive: true
|
|
1499
1578
|
});
|
|
1579
|
+
(0, _utilEvent["default"])('scrollend').removeEventListener(scrollContentRef, onScrollEnd);
|
|
1500
1580
|
// scrollMode 'native' ]]
|
|
1501
1581
|
|
|
1502
1582
|
if (props.removeEventListeners) {
|
|
@@ -1633,7 +1713,7 @@ var useScroll = exports.useScroll = function useScroll(props) {
|
|
|
1633
1713
|
isVerticalScrollbarVisible = _useScrollBase.isVerticalScrollbarVisible;
|
|
1634
1714
|
assignProperties('scrollContainerProps', {
|
|
1635
1715
|
ref: scrollContainerRef
|
|
1636
|
-
});
|
|
1716
|
+
}); // eslint-disable-line react-hooks/refs
|
|
1637
1717
|
assignProperties('scrollContentProps', _objectSpread(_objectSpread({}, props.itemRenderer ? {
|
|
1638
1718
|
itemRefs: itemRefs
|
|
1639
1719
|
} : {}), {}, {
|
|
@@ -1641,10 +1721,10 @@ var useScroll = exports.useScroll = function useScroll(props) {
|
|
|
1641
1721
|
}));
|
|
1642
1722
|
assignProperties('verticalScrollbarProps', {
|
|
1643
1723
|
scrollbarHandle: verticalScrollbarHandle
|
|
1644
|
-
});
|
|
1724
|
+
}); // eslint-disable-line react-hooks/refs
|
|
1645
1725
|
assignProperties('horizontalScrollbarProps', {
|
|
1646
1726
|
scrollbarHandle: horizontalScrollbarHandle
|
|
1647
|
-
});
|
|
1727
|
+
}); // eslint-disable-line react-hooks/refs
|
|
1648
1728
|
|
|
1649
1729
|
// Return
|
|
1650
1730
|
|
package/useScroll/utilEvent.js
CHANGED
|
@@ -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) {
|