@enact/ui
Version:
A collection of simplified unstyled cross-platform UI components for Enact
625 lines (603 loc) • 23.2 kB
JavaScript
;
require("@testing-library/jest-dom");
var _react = require("@testing-library/react");
var _useScroll = require("../useScroll");
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; }
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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), 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); }
// Mock all dependencies at the top level BEFORE importing useScroll
var mockRiScale;
var mockPlatform;
jest.mock('../../resolution', function () {
return {
__esModule: true,
"default": {
get scale() {
return mockRiScale || function (val) {
return val;
};
}
}
};
});
jest.mock('@enact/core/platform', function () {
return {
__esModule: true,
get platform() {
return mockPlatform || {
chrome: 120
};
}
};
});
global.ResizeObserver = /*#__PURE__*/function () {
function ResizeObserver() {
_classCallCheck(this, ResizeObserver);
}
return _createClass(ResizeObserver, [{
key: "observe",
value: function observe() {}
}, {
key: "unobserve",
value: function unobserve() {}
}, {
key: "disconnect",
value: function disconnect() {}
}]);
}();
// Import AFTER all mocks
// Helper function to create complete mock refs
function createMockRefs() {
return {
scrollContentHandle: {
current: {
getScrollBounds: jest.fn(function () {
return {
clientWidth: 1920,
clientHeight: 1080,
scrollWidth: 2000,
// greater than clientWidth
scrollHeight: 2000,
// greater than clientHeight
maxTop: 920,
// 2000 - 1080 = 920
maxLeft: 80 // 2000 - 1920 = 80
};
}),
getMoreInfo: jest.fn(function () {
return {};
}),
hasDataSizeChanged: false,
syncClientSize: jest.fn(function () {
return false;
}),
getRtlPositionX: jest.fn(function (x) {
return x;
}),
calculateMetrics: jest.fn(),
didScroll: jest.fn(),
props: {}
}
},
scrollContainerRef: {
current: document.createElement('div')
},
scrollContentRef: {
current: document.createElement('div')
},
horizontalScrollbarHandle: {
current: {
update: jest.fn(),
getContainerRef: jest.fn(function () {
return document.createElement('div');
}),
startHidingScrollbarTrack: jest.fn(),
showScrollbarTrack: jest.fn()
}
},
verticalScrollbarHandle: {
current: {
update: jest.fn(),
getContainerRef: jest.fn(function () {
return document.createElement('div');
}),
startHidingScrollbarTrack: jest.fn(),
showScrollbarTrack: jest.fn()
}
}
};
}
describe('useScroll', function () {
describe('riRatio itemSize scaling on window resize', function () {
beforeEach(function () {
jest.useFakeTimers();
mockPlatform = {
chrome: 132
};
});
afterEach(function () {
jest.runOnlyPendingTimers();
jest.useRealTimers();
});
test('should scale itemSize when ri.scale(1) changes from 1 to 2', function () {
var _scrollContentPropsCa;
mockRiScale = jest.fn(function (val) {
return val;
});
var itemSize = {
minWidth: 100,
minHeight: 50
};
var mocks = createMockRefs();
var assignProperties = jest.fn();
var props = _objectSpread(_objectSpread({
itemRenderer: jest.fn(),
itemSize: itemSize,
direction: 'vertical',
scrollMode: 'translate'
}, mocks), {}, {
assignProperties: assignProperties,
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
mockRiScale = jest.fn(function () {
return 2;
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
(0, _react.fireEvent)(window, new Event('resize'));
jest.runAllTimers();
});
// Original props object must not be mutated
expect(itemSize.minWidth).toBe(100);
expect(itemSize.minHeight).toBe(50);
// The scaled values should be passed to scrollContentProps via assignProperties
var scrollContentPropsCall = assignProperties.mock.calls.findLast(function (_ref) {
var _ref2 = _slicedToArray(_ref, 1),
name = _ref2[0];
return name === 'scrollContentProps';
});
var passedItemSize = scrollContentPropsCall === null || scrollContentPropsCall === void 0 || (_scrollContentPropsCa = scrollContentPropsCall[1]) === null || _scrollContentPropsCa === void 0 ? void 0 : _scrollContentPropsCa.itemSize;
expect(passedItemSize === null || passedItemSize === void 0 ? void 0 : passedItemSize.minWidth).toBe(200);
expect(passedItemSize === null || passedItemSize === void 0 ? void 0 : passedItemSize.minHeight).toBe(100);
});
test('should scale itemSizes when ri.scale(1) changes from 1 to 2', function () {
var _scrollContentPropsCa2;
mockRiScale = jest.fn(function (val) {
return val;
});
var itemSize = 100;
var itemSizes = [100, 100, 100, 100, 100];
var mocks = createMockRefs();
var assignProperties = jest.fn();
var props = _objectSpread(_objectSpread({
itemRenderer: jest.fn(),
itemSize: itemSize,
itemSizes: itemSizes,
direction: 'vertical',
scrollMode: 'translate'
}, mocks), {}, {
assignProperties: assignProperties,
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
mockRiScale = jest.fn(function () {
return 2;
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
(0, _react.fireEvent)(window, new Event('resize'));
jest.runAllTimers();
});
// Original props array must not be mutated
expect(itemSizes[1]).toBe(100);
// The scaled values should be passed to scrollContentProps via assignProperties
var scrollContentPropsCall = assignProperties.mock.calls.findLast(function (_ref3) {
var _ref4 = _slicedToArray(_ref3, 1),
name = _ref4[0];
return name === 'scrollContentProps';
});
var passedItemSizes = scrollContentPropsCall === null || scrollContentPropsCall === void 0 || (_scrollContentPropsCa2 = scrollContentPropsCall[1]) === null || _scrollContentPropsCa2 === void 0 ? void 0 : _scrollContentPropsCa2.itemSizes;
expect(passedItemSizes === null || passedItemSizes === void 0 ? void 0 : passedItemSizes[1]).toBe(200);
});
test('should NOT scale itemSize when ri.scale(1) remains unchanged', function () {
mockRiScale = jest.fn(function (val) {
return val;
});
var itemSize = {
minWidth: 100,
minHeight: 50
};
var mocks = createMockRefs();
var props = _objectSpread(_objectSpread({
itemRenderer: jest.fn(),
itemSize: itemSize,
direction: 'vertical',
scrollMode: 'translate'
}, mocks), {}, {
assignProperties: jest.fn(),
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
(0, _react.fireEvent)(window, new Event('resize'));
jest.runAllTimers();
});
expect(itemSize.minWidth).toBe(100);
expect(itemSize.minHeight).toBe(50);
});
test('should NOT scale itemSizes when ri.scale(1) remains unchanged', function () {
mockRiScale = jest.fn(function (val) {
return val;
});
var itemSize = 100;
var itemSizes = [100, 100, 100, 100, 100];
var mocks = createMockRefs();
var props = _objectSpread(_objectSpread({
itemRenderer: jest.fn(),
itemSize: itemSize,
itemSizes: itemSizes,
direction: 'vertical',
scrollMode: 'translate'
}, mocks), {}, {
assignProperties: jest.fn(),
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
(0, _react.fireEvent)(window, new Event('resize'));
jest.runAllTimers();
});
expect(itemSizes[1]).toBe(100);
});
test('should NOT scale when minWidth is missing', function () {
mockRiScale = jest.fn(function (val) {
return val;
});
var itemSize = {
minHeight: 50
};
var mocks = createMockRefs();
var props = _objectSpread(_objectSpread({
itemRenderer: jest.fn(),
itemSize: itemSize,
direction: 'vertical',
scrollMode: 'translate'
}, mocks), {}, {
assignProperties: jest.fn(),
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
mockRiScale = jest.fn(function () {
return 2;
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
(0, _react.fireEvent)(window, new Event('resize'));
jest.runAllTimers();
});
expect(itemSize.minHeight).toBe(50);
expect(itemSize.minWidth).toBeUndefined();
});
test('should NOT scale when minHeight is missing', function () {
mockRiScale = jest.fn(function (val) {
return val;
});
var itemSize = {
minWidth: 100
};
var mocks = createMockRefs();
var props = _objectSpread(_objectSpread({
itemRenderer: jest.fn(),
itemSize: itemSize,
direction: 'vertical',
scrollMode: 'translate'
}, mocks), {}, {
assignProperties: jest.fn(),
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
mockRiScale = jest.fn(function () {
return 2;
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
(0, _react.fireEvent)(window, new Event('resize'));
jest.runAllTimers();
});
expect(itemSize.minWidth).toBe(100);
expect(itemSize.minHeight).toBeUndefined();
});
});
describe('Rounding target scroll position', function () {
beforeEach(function () {
jest.resetModules(); // important! clears cached modules
});
test('should round target position upwards when target is bigger than current position', function () {
mockPlatform = {
chrome: 132
};
var _require = require('../useScroll'),
roundTarget = _require.roundTarget;
var currentPosition = {
scrollPos: {
left: 100,
top: 100
}
};
var _roundTarget = roundTarget(currentPosition, 120.5, 120.4),
roundedTargetX = _roundTarget.roundedTargetX,
roundedTargetY = _roundTarget.roundedTargetY;
expect(roundedTargetX).toEqual(121);
expect(roundedTargetY).toEqual(121);
});
test('should round target position downwards when target is less than current position', function () {
mockPlatform = {
chrome: 132
};
var _require2 = require('../useScroll'),
roundTarget = _require2.roundTarget;
var currentPosition = {
scrollPos: {
left: 100,
top: 100
}
};
var _roundTarget2 = roundTarget(currentPosition, 90.4, 80.8),
roundedTargetX = _roundTarget2.roundedTargetX,
roundedTargetY = _roundTarget2.roundedTargetY;
expect(roundedTargetX).toEqual(90);
expect(roundedTargetY).toEqual(80);
});
test('should not round target position when chrome <= 120', function () {
mockPlatform = {
chrome: 119
};
var _require3 = require('../useScroll'),
roundTarget = _require3.roundTarget;
var currentPosition = {
scrollPos: {
left: 100,
top: 100
}
};
var _roundTarget3 = roundTarget(currentPosition, 90.4, 80.8),
roundedTargetX = _roundTarget3.roundedTargetX,
roundedTargetY = _roundTarget3.roundedTargetY;
expect(roundedTargetX).toEqual(90.4);
expect(roundedTargetY).toEqual(80.8);
});
});
describe('Native scroll behavior', function () {
beforeEach(function () {
jest.useFakeTimers();
mockPlatform = {
chrome: 132
};
mockRiScale = jest.fn(function (val) {
return val;
});
});
afterEach(function () {
jest.runOnlyPendingTimers();
jest.useRealTimers();
});
test('should update scroll position from scroll event', function () {
var mocks = createMockRefs();
var props = _objectSpread(_objectSpread({
direction: 'vertical',
scrollMode: 'native'
}, mocks), {}, {
assignProperties: jest.fn(),
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
var scrollEvent = new Event('scroll');
Object.defineProperty(scrollEvent, 'target', {
value: {
scrollLeft: 50,
scrollTop: 150
},
writable: false
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
(0, _react.fireEvent)(mocks.scrollContentRef.current, scrollEvent);
});
expect(mocks.scrollContentHandle.current.didScroll).toHaveBeenCalledWith(50, 150);
});
test('should handle RTL scroll position correctly', function () {
var mocks = createMockRefs();
mockPlatform = {
chrome: 132
};
var props = _objectSpread(_objectSpread({
direction: 'horizontal',
scrollMode: 'native',
rtl: true
}, mocks), {}, {
addEventListeners: jest.fn(),
assignProperties: jest.fn(),
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
var scrollEvent = new Event('scroll');
Object.defineProperty(scrollEvent, 'target', {
value: {
scrollLeft: -50,
scrollTop: 0
}
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
(0, _react.fireEvent)(mocks.scrollContentRef.current, scrollEvent);
});
expect(mocks.scrollContentHandle.current.didScroll).toHaveBeenCalledWith(50, 0);
});
});
describe('onKeyDown repeat handling (native scroll mode)', function () {
beforeEach(function () {
jest.useFakeTimers();
mockPlatform = {
chrome: 132
};
mockRiScale = jest.fn(function (val) {
return val;
});
});
afterEach(function () {
jest.runOnlyPendingTimers();
jest.useRealTimers();
});
function createNativeScrollProps(mocks) {
var extra = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
return _objectSpread(_objectSpread({
direction: 'vertical',
scrollMode: 'native'
}, mocks), {}, {
assignProperties: jest.fn(),
horizontalScrollbar: 'auto',
verticalScrollbar: 'auto'
}, extra);
}
test('should forward onKeyDown event when key is not repeated', function () {
var mocks = createMockRefs();
var onKeyDown = jest.fn();
var props = createNativeScrollProps(mocks, {
onKeyDown: onKeyDown
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
_react.fireEvent.keyDown(mocks.scrollContainerRef.current, {
keyCode: 40,
repeat: false
});
});
expect(onKeyDown).toHaveBeenCalledTimes(1);
});
test('should not forward onKeyDown event when arrowKey is repeated and lastInputType is arrowKey', function () {
var mocks = createMockRefs();
var onKeyDown = jest.fn();
var scrollContainerHandle = null;
var props = createNativeScrollProps(mocks, {
onKeyDown: onKeyDown,
setScrollContainerHandle: function setScrollContainerHandle(handle) {
scrollContainerHandle = handle;
}
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
// Set lastInputType to arrowKey via the exposed themeScrollContainerHandle
(0, _react.act)(function () {
if (scrollContainerHandle) {
scrollContainerHandle.lastInputType = 'arrowKey';
}
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
_react.fireEvent.keyDown(mocks.scrollContainerRef.current, {
keyCode: 40,
repeat: true
});
});
expect(onKeyDown).not.toHaveBeenCalled();
});
test('should not forward onKeyDown event when pageKey is repeated and lastInputType is pageKey', function () {
var mocks = createMockRefs();
var onKeyDown = jest.fn();
var scrollContainerHandle = null;
var props = createNativeScrollProps(mocks, {
onKeyDown: onKeyDown,
setScrollContainerHandle: function setScrollContainerHandle(handle) {
scrollContainerHandle = handle;
}
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
// Set lastInputType to pageKey via the exposed themeScrollContainerHandle
(0, _react.act)(function () {
if (scrollContainerHandle) {
scrollContainerHandle.lastInputType = 'pageKey';
}
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
_react.fireEvent.keyDown(mocks.scrollContainerRef.current, {
keyCode: 33,
repeat: true
});
});
expect(onKeyDown).not.toHaveBeenCalled();
});
test('should forward onKeyDown event when repeat is true but lastInputType is neither arrowKey nor pageKey', function () {
var mocks = createMockRefs();
var onKeyDown = jest.fn();
var scrollContainerHandle = null;
var props = createNativeScrollProps(mocks, {
onKeyDown: onKeyDown,
setScrollContainerHandle: function setScrollContainerHandle(handle) {
scrollContainerHandle = handle;
}
});
(0, _react.renderHook)(function () {
return (0, _useScroll.useScrollBase)(props);
});
// Set lastInputType to wheel (not arrowKey or pageKey)
(0, _react.act)(function () {
if (scrollContainerHandle) {
scrollContainerHandle.lastInputType = 'wheel';
}
});
// eslint-disable-next-line testing-library/no-unnecessary-act
(0, _react.act)(function () {
_react.fireEvent.keyDown(mocks.scrollContainerRef.current, {
keyCode: 40,
repeat: true
});
});
expect(onKeyDown).toHaveBeenCalledTimes(1);
});
});
});