@enact/limestone 1.3.0

package/VirtualList/tests/VirtualList-specs.js

@@ -0,0 +1,288 @@
+"use strict";
+
+require("@testing-library/jest-dom");
+var _react = require("@testing-library/react");
+var _Item = _interopRequireDefault(require("../../Item"));
+var _VirtualList = _interopRequireDefault(require("../VirtualList"));
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["index"],
+  _excluded2 = ["index"];
+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; }
+describe('VirtualList', function () {
+  var clientSize, dataSize, items, itemSize, renderItem;
+  beforeEach(function () {
+    clientSize = {
+      clientWidth: 1280,
+      clientHeight: 720
+    };
+    dataSize = 200;
+    items = [];
+    itemSize = 60;
+    renderItem = function renderItem(_ref) {
+      var index = _ref.index,
+        rest = _objectWithoutProperties(_ref, _excluded);
+      // eslint-disable-line enact/display-name
+      return /*#__PURE__*/(0, _jsxRuntime.jsx)(_Item["default"], _objectSpread(_objectSpread({}, rest), {}, {
+        children: items[index].name
+      }));
+    };
+    for (var i = 0; i < dataSize; i++) {
+      items.push({
+        name: 'Account ' + i
+      });
+    }
+  });
+  afterEach(function () {
+    clientSize = null;
+    dataSize = null;
+    items = null;
+    itemSize = null;
+    renderItem = null;
+  });
+  test('should render a list of \'items\'', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+      clientSize: clientSize,
+      dataSize: dataSize,
+      itemRenderer: renderItem,
+      itemSize: itemSize
+    }));
+    var expected = 'Account 0';
+    var actual = _react.screen.getByRole('list').children.item(0).textContent;
+    expect(actual).toBe(expected);
+  });
+  test('should render overhang items when \'clientSize\' and outer DOM size are not specified', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+      dataSize: dataSize,
+      itemRenderer: renderItem,
+      itemSize: itemSize
+    }));
+    var expected = 3;
+    var actual = _react.screen.getByRole('list').children.length;
+    expect(actual).toBe(expected);
+  });
+  test('should render (clientHeight / itemHeight + overhang) items', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+      clientSize: clientSize,
+      dataSize: dataSize,
+      itemRenderer: renderItem,
+      itemSize: itemSize
+    }));
+    var expected = 15; // 720 / 60 + 3
+    var actual = _react.screen.getByRole('list').children.length;
+    expect(actual).toBe(expected);
+  });
+  test('should re-render (clientHeight / itemHeight + overhang) items after changing \'clientSize\'', function () {
+    var _render = (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        itemRenderer: renderItem,
+        itemSize: itemSize
+      })),
+      rerender = _render.rerender;
+    var newClientSize = {
+      clientWidth: 1280,
+      clientHeight: 360
+    };
+    rerender(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+      clientSize: newClientSize,
+      dataSize: dataSize,
+      itemRenderer: renderItem,
+      itemSize: itemSize
+    }));
+    var expected = 9; // 360 / 60 + 3
+    var actual = _react.screen.getByRole('list').children.length;
+    expect(actual).toBe(expected);
+  });
+  test('should render only one scrollbar', function () {
+    (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+      clientSize: clientSize,
+      dataSize: dataSize,
+      direction: "horizontal",
+      itemRenderer: renderItem,
+      itemSize: itemSize
+    }));
+    var expected = 2; // One for the list and another for the horizontal scrollbar
+    var actual = _react.screen.getByRole('list').parentElement.parentElement.children.length;
+    expect(actual).toBe(expected);
+  });
+  describe('Scrollbar visibility', function () {
+    test('should render both horizontal and vertical scrollbars when \'horizontalScrollbar\' and \'verticalScrollbar\' are "visible"', function () {
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        direction: "horizontal",
+        itemRenderer: renderItem,
+        itemSize: itemSize,
+        horizontalScrollbar: "visible",
+        verticalScrollbar: "visible"
+      }));
+      var virtualListRoot = _react.screen.getByRole('list').parentElement.parentElement;
+      var verticalScrollbar = virtualListRoot.children.item(1);
+      var horizontalScrollbar = virtualListRoot.children.item(2);
+      expect(verticalScrollbar).toHaveClass("verticalScrollbar");
+      expect(horizontalScrollbar).toHaveClass("horizontalScrollbar");
+    });
+    test('should render only vertical scrollbar when \'verticalScrollbar\' is "visible" and \'horizontalScrollbar\' is "hidden"', function () {
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        itemRenderer: renderItem,
+        itemSize: itemSize
+      }));
+      var virtualListRoot = _react.screen.getByRole('list').parentElement.parentElement;
+      var verticalScrollbar = virtualListRoot.children.item(1);
+      var horizontalScrollbar = virtualListRoot.children.item(2);
+      expect(verticalScrollbar).toBeInTheDocument();
+      expect(verticalScrollbar).toHaveClass("verticalScrollbar");
+      expect(horizontalScrollbar).toBeNull();
+    });
+    test('should not render any scrollbar when \'horizontalScrollbar\' and \'verticalScrollbar\' are "hidden"', function () {
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        direction: "horizontal",
+        itemRenderer: renderItem,
+        itemSize: itemSize,
+        horizontalScrollbar: "hidden",
+        verticalScrollbar: "hidden"
+      }));
+      var virtualListRoot = _react.screen.getByRole('list').parentElement.parentElement;
+      var verticalScrollbar = virtualListRoot.children.item(1);
+      var horizontalScrollbar = virtualListRoot.children.item(2);
+      expect(verticalScrollbar).toBeNull();
+      expect(horizontalScrollbar).toBeNull();
+    });
+  });
+  describe('ScrollTo', function () {
+    test('should warn if both \'minSize\' in \'itemSize\' prop and \'cbScrollTo\' prop are given', function () {
+      var consoleSpy = jest.spyOn(console, 'error').mockImplementation(function () {});
+      var variableItemSize = {
+        minSize: itemSize,
+        size: [100, 200, 300, 400, 100, 200, 300, 400, 100, 200]
+      };
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        cbScrollTo: function cbScrollTo() {},
+        clientSize: clientSize,
+        dataSize: 10,
+        itemRenderer: renderItem,
+        itemSize: variableItemSize,
+        scrollMode: "translate"
+      }));
+      var expectedErrorMsg = 'Warning: VirtualList with `minSize` in `itemSize` prop does not support `cbScrollTo` prop';
+      expect(consoleSpy).toHaveBeenCalled();
+      expect(consoleSpy.mock.calls[0][0]).toBe(expectedErrorMsg);
+    });
+  });
+  describe('Adding an item', function () {
+    test('should render an added item named \'Password 0\' as the first item', function (done) {
+      var itemArray = [{
+        name: 'A'
+      }, {
+        name: 'B'
+      }, {
+        name: 'C'
+      }];
+      var renderItemArray = function renderItemArray(_ref2) {
+        var index = _ref2.index,
+          rest = _objectWithoutProperties(_ref2, _excluded2);
+        return /*#__PURE__*/(0, _jsxRuntime.jsx)("div", _objectSpread(_objectSpread({}, rest), {}, {
+          id: 'item' + index,
+          children: itemArray[index].name
+        }));
+      };
+      var _render2 = (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+          clientSize: clientSize,
+          dataSize: itemArray.length,
+          itemRenderer: renderItemArray,
+          itemSize: itemSize
+        })),
+        rerender = _render2.rerender;
+      itemArray.unshift({
+        name: 'Password 0'
+      });
+      rerender(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: itemArray.length,
+        itemRenderer: renderItemArray,
+        itemSize: itemSize
+      }));
+      jest.useFakeTimers();
+      (0, _react.act)(function () {
+        return jest.advanceTimersByTime(0);
+      });
+      var expected = itemArray[0].name;
+      var actual = _react.screen.getByRole('list').children.item(0).textContent;
+      expect(actual).toBe(expected);
+      done();
+      jest.useRealTimers();
+    });
+  });
+  describe('Voice Control', function () {
+    test('should render \'data-webos-voice-focused\' to the outermost node of VirtualList', function () {
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        itemRenderer: renderItem,
+        itemSize: itemSize,
+        "data-webos-voice-focused": true
+      }));
+      var actual = _react.screen.getByRole('list').parentElement;
+      expect(actual).toHaveAttribute('data-webos-voice-focused', 'true');
+    });
+    test('should render \'data-webos-voice-group-label\' to the outermost node of VirtualList', function () {
+      var label = 'group label';
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        itemRenderer: renderItem,
+        itemSize: itemSize,
+        "data-webos-voice-group-label": label
+      }));
+      var actual = _react.screen.getByRole('list').parentElement;
+      expect(actual).toHaveAttribute('data-webos-voice-group-label', label);
+    });
+    test('should render \'data-webos-voice-disabled\' to the outermost node of VirtualList', function () {
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        itemRenderer: renderItem,
+        itemSize: itemSize,
+        "data-webos-voice-disabled": true
+      }));
+      var actual = _react.screen.getByRole('list').parentElement;
+      expect(actual).toHaveAttribute('data-webos-voice-disabled', 'true');
+    });
+  });
+  describe('HoverToScroll', function () {
+    test('should not render hoverToScroll node when \'hoverToScroll\' prop is not provided', function () {
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        itemRenderer: renderItem,
+        itemSize: itemSize
+      }));
+      var expected = 2;
+      var actual = _react.screen.getByRole('list').parentElement.parentElement.children.length;
+      expect(actual).toBe(expected);
+    });
+    test('should render hoverToScroll node when \'hoverToScroll\' prop is provided', function () {
+      (0, _react.render)(/*#__PURE__*/(0, _jsxRuntime.jsx)(_VirtualList["default"], {
+        clientSize: clientSize,
+        dataSize: dataSize,
+        hoverToScroll: true,
+        itemRenderer: renderItem,
+        itemSize: itemSize
+      }));
+      var expected = 3;
+      var actual = _react.screen.getByRole('list').parentElement.parentElement.children.length;
+      expect(actual).toBe(expected);
+    });
+  });
+});