virtual-scroller 1.7.7 → 1.8.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.
- package/.gitlab-ci.yml +1 -1
- package/CHANGELOG.md +24 -1
- package/README.md +139 -33
- package/babel.config.js +25 -0
- package/babel.js +5 -0
- package/bundle/index-bypass.html +1 -1
- package/bundle/index-dom.html +1 -1
- package/bundle/index-grid.html +1 -2
- package/bundle/index-scrollableContainer.html +1 -1
- package/bundle/index-tbody-scrollableContainer.html +2 -0
- package/bundle/index-tbody.html +2 -0
- package/bundle/virtual-scroller-dom.js +1 -1
- package/bundle/virtual-scroller-dom.js.map +1 -1
- package/bundle/virtual-scroller-react.js +1 -1
- package/bundle/virtual-scroller-react.js.map +1 -1
- package/bundle/virtual-scroller.js +1 -1
- package/bundle/virtual-scroller.js.map +1 -1
- package/commonjs/BeforeResize.js +319 -0
- package/commonjs/BeforeResize.js.map +1 -0
- package/commonjs/DOM/Engine.js +46 -0
- package/commonjs/DOM/Engine.js.map +1 -0
- package/commonjs/DOM/ItemsContainer.js +78 -0
- package/commonjs/DOM/ItemsContainer.js.map +1 -0
- package/commonjs/DOM/{WaitForStylesToLoad.js → ListTopOffsetWatcher.js} +56 -35
- package/commonjs/DOM/ListTopOffsetWatcher.js.map +1 -0
- package/commonjs/DOM/ScrollableContainer.js +56 -81
- package/commonjs/DOM/ScrollableContainer.js.map +1 -1
- package/commonjs/DOM/VirtualScroller.js +20 -15
- package/commonjs/DOM/VirtualScroller.js.map +1 -1
- package/commonjs/DOM/tbody.js +2 -2
- package/commonjs/ItemHeights.js +22 -29
- package/commonjs/ItemHeights.js.map +1 -1
- package/commonjs/Layout.js +588 -215
- package/commonjs/Layout.js.map +1 -1
- package/commonjs/Layout.test.js +191 -0
- package/commonjs/Layout.test.js.map +1 -0
- package/commonjs/ListHeightChangeWatcher.js +126 -0
- package/commonjs/ListHeightChangeWatcher.js.map +1 -0
- package/commonjs/Resize.js +22 -21
- package/commonjs/Resize.js.map +1 -1
- package/commonjs/Scroll.js +148 -88
- package/commonjs/Scroll.js.map +1 -1
- package/commonjs/VirtualScroller.js +1269 -390
- package/commonjs/VirtualScroller.js.map +1 -1
- package/commonjs/getItemCoordinates.js.map +1 -1
- package/commonjs/getItemsDiff.js.map +1 -1
- package/commonjs/getVerticalSpacing.js +8 -8
- package/commonjs/getVerticalSpacing.js.map +1 -1
- package/commonjs/react/VirtualScroller.js +31 -37
- package/commonjs/react/VirtualScroller.js.map +1 -1
- package/commonjs/utility/debounce.js +26 -4
- package/commonjs/utility/debounce.js.map +1 -1
- package/commonjs/utility/debug.js +51 -12
- package/commonjs/utility/debug.js.map +1 -1
- package/commonjs/utility/getStateSnapshot.js +50 -0
- package/commonjs/utility/getStateSnapshot.js.map +1 -0
- package/commonjs/utility/px.js +1 -1
- package/commonjs/utility/px.js.map +1 -1
- package/commonjs/utility/px.test.js +14 -0
- package/commonjs/utility/px.test.js.map +1 -0
- package/commonjs/utility/shallowEqual.js +1 -1
- package/commonjs/utility/shallowEqual.js.map +1 -1
- package/commonjs/utility/throttle.js.map +1 -1
- package/dom/index.d.ts +23 -0
- package/index.d.ts +84 -0
- package/modules/BeforeResize.js +310 -0
- package/modules/BeforeResize.js.map +1 -0
- package/modules/DOM/Engine.js +27 -0
- package/modules/DOM/Engine.js.map +1 -0
- package/modules/DOM/ItemsContainer.js +71 -0
- package/modules/DOM/ItemsContainer.js.map +1 -0
- package/modules/DOM/{WaitForStylesToLoad.js → ListTopOffsetWatcher.js} +57 -35
- package/modules/DOM/ListTopOffsetWatcher.js.map +1 -0
- package/modules/DOM/ScrollableContainer.js +55 -80
- package/modules/DOM/ScrollableContainer.js.map +1 -1
- package/modules/DOM/VirtualScroller.js +15 -14
- package/modules/DOM/VirtualScroller.js.map +1 -1
- package/modules/ItemHeights.js +17 -28
- package/modules/ItemHeights.js.map +1 -1
- package/modules/Layout.js +582 -213
- package/modules/Layout.js.map +1 -1
- package/modules/Layout.test.js +185 -0
- package/modules/Layout.test.js.map +1 -0
- package/modules/ListHeightChangeWatcher.js +119 -0
- package/modules/ListHeightChangeWatcher.js.map +1 -0
- package/modules/Resize.js +21 -20
- package/modules/Resize.js.map +1 -1
- package/modules/Scroll.js +148 -87
- package/modules/Scroll.js.map +1 -1
- package/modules/VirtualScroller.js +1263 -390
- package/modules/VirtualScroller.js.map +1 -1
- package/modules/getItemCoordinates.js.map +1 -1
- package/modules/getItemsDiff.js.map +1 -1
- package/modules/getVerticalSpacing.js +8 -8
- package/modules/getVerticalSpacing.js.map +1 -1
- package/modules/react/VirtualScroller.js +31 -37
- package/modules/react/VirtualScroller.js.map +1 -1
- package/modules/utility/debounce.js +26 -4
- package/modules/utility/debounce.js.map +1 -1
- package/modules/utility/debug.js +47 -10
- package/modules/utility/debug.js.map +1 -1
- package/modules/utility/getStateSnapshot.js +43 -0
- package/modules/utility/getStateSnapshot.js.map +1 -0
- package/modules/utility/px.js +1 -1
- package/modules/utility/px.js.map +1 -1
- package/modules/utility/px.test.js +9 -0
- package/modules/utility/px.test.js.map +1 -0
- package/modules/utility/shallowEqual.js +1 -1
- package/modules/utility/shallowEqual.js.map +1 -1
- package/modules/utility/throttle.js.map +1 -1
- package/package.json +24 -22
- package/react/index.d.ts +27 -0
- package/source/BeforeResize.js +317 -0
- package/source/DOM/Engine.js +32 -0
- package/source/DOM/ItemsContainer.js +48 -0
- package/source/DOM/{WaitForStylesToLoad.js → ListTopOffsetWatcher.js} +48 -22
- package/source/DOM/ScrollableContainer.js +39 -56
- package/source/DOM/VirtualScroller.js +6 -7
- package/source/ItemHeights.js +19 -24
- package/source/Layout.js +626 -252
- package/source/Layout.test.js +171 -0
- package/source/ListHeightChangeWatcher.js +94 -0
- package/source/Resize.js +23 -15
- package/source/Scroll.js +139 -78
- package/source/VirtualScroller.js +1243 -286
- package/source/getVerticalSpacing.js +7 -7
- package/source/react/VirtualScroller.js +2 -18
- package/source/utility/debounce.js +20 -3
- package/source/utility/debug.js +34 -3
- package/source/utility/getStateSnapshot.js +36 -0
- package/source/utility/px.js +1 -1
- package/source/utility/px.test.js +9 -0
- package/website/index-bypass.html +195 -0
- package/website/index-grid.html +0 -1
- package/website/index-scrollableContainer.html +208 -0
- package/website/index-tbody-scrollableContainer.html +68 -0
- package/website/index-tbody.html +55 -0
- package/commonjs/DOM/RenderingEngine.js +0 -33
- package/commonjs/DOM/RenderingEngine.js.map +0 -1
- package/commonjs/DOM/Screen.js +0 -87
- package/commonjs/DOM/Screen.js.map +0 -1
- package/commonjs/DOM/WaitForStylesToLoad.js.map +0 -1
- package/commonjs/RestoreScroll.js +0 -118
- package/commonjs/RestoreScroll.js.map +0 -1
- package/modules/DOM/RenderingEngine.js +0 -19
- package/modules/DOM/RenderingEngine.js.map +0 -1
- package/modules/DOM/Screen.js +0 -80
- package/modules/DOM/Screen.js.map +0 -1
- package/modules/DOM/WaitForStylesToLoad.js.map +0 -1
- package/modules/RestoreScroll.js +0 -111
- package/modules/RestoreScroll.js.map +0 -1
- package/source/DOM/RenderingEngine.js +0 -22
- package/source/DOM/Screen.js +0 -51
- package/source/RestoreScroll.js +0 -86
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
+
function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
|
|
4
|
+
|
|
3
5
|
Object.defineProperty(exports, "__esModule", {
|
|
4
6
|
value: true
|
|
5
7
|
});
|
|
@@ -11,11 +13,17 @@ var _debug = _interopRequireWildcard(require("../utility/debug"));
|
|
|
11
13
|
|
|
12
14
|
var _px = _interopRequireDefault(require("../utility/px"));
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
var _excluded = ["onMount", "onItemUnmount"];
|
|
17
|
+
|
|
18
|
+
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
19
|
+
|
|
20
|
+
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
15
21
|
|
|
16
22
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
|
|
17
23
|
|
|
18
|
-
function
|
|
24
|
+
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
|
|
25
|
+
|
|
26
|
+
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
|
|
19
27
|
|
|
20
28
|
function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
|
|
21
29
|
|
|
@@ -29,10 +37,8 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
|
|
|
29
37
|
|
|
30
38
|
function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
|
|
31
39
|
|
|
32
|
-
var VirtualScroller =
|
|
33
|
-
|
|
34
|
-
function () {
|
|
35
|
-
function VirtualScroller(element, _items, renderItem) {
|
|
40
|
+
var VirtualScroller = /*#__PURE__*/function () {
|
|
41
|
+
function VirtualScroller(itemsContainerElement, _items, renderItem) {
|
|
36
42
|
var _this = this;
|
|
37
43
|
|
|
38
44
|
var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
|
|
@@ -62,15 +68,14 @@ function () {
|
|
|
62
68
|
var diffRender = prevState && items === prevState.items && items.length > 0; // Remove no longer visible items from the DOM.
|
|
63
69
|
|
|
64
70
|
if (diffRender) {
|
|
65
|
-
|
|
71
|
+
// Decrement instead of increment here because
|
|
66
72
|
// `this.container.removeChild()` changes indexes.
|
|
67
|
-
|
|
68
73
|
var _i = prevState.lastShownItemIndex;
|
|
69
74
|
|
|
70
75
|
while (_i >= prevState.firstShownItemIndex) {
|
|
71
76
|
if (_i >= firstShownItemIndex && _i <= lastShownItemIndex) {// The item is still visible.
|
|
72
77
|
} else {
|
|
73
|
-
(0, _debug["default"])('Remove item index', _i); // The item is no longer visible. Remove it.
|
|
78
|
+
(0, _debug["default"])('DOM: Remove element for item index', _i); // The item is no longer visible. Remove it.
|
|
74
79
|
|
|
75
80
|
_this.unmountItem(_this.container.childNodes[_i - prevState.firstShownItemIndex]);
|
|
76
81
|
}
|
|
@@ -78,7 +83,7 @@ function () {
|
|
|
78
83
|
_i--;
|
|
79
84
|
}
|
|
80
85
|
} else {
|
|
81
|
-
(0, _debug["default"])('Rerender from scratch');
|
|
86
|
+
(0, _debug["default"])('DOM: Rerender the list from scratch');
|
|
82
87
|
|
|
83
88
|
while (_this.container.firstChild) {
|
|
84
89
|
_this.unmountItem(_this.container.firstChild);
|
|
@@ -101,11 +106,11 @@ function () {
|
|
|
101
106
|
var item = _this.renderItem(items[i]);
|
|
102
107
|
|
|
103
108
|
if (shouldPrependItems) {
|
|
104
|
-
(0, _debug["default"])('Prepend item index', i); // Append `item` to `this.container` before the retained items.
|
|
109
|
+
(0, _debug["default"])('DOM: Prepend element for item index', i); // Append `item` to `this.container` before the retained items.
|
|
105
110
|
|
|
106
111
|
_this.container.insertBefore(item, prependBeforeItemElement);
|
|
107
112
|
} else {
|
|
108
|
-
(0, _debug["default"])('Append item index', i); // Append `item` to `this.container`.
|
|
113
|
+
(0, _debug["default"])('DOM: Append element for item index', i); // Append `item` to `this.container`.
|
|
109
114
|
|
|
110
115
|
_this.container.appendChild(item);
|
|
111
116
|
}
|
|
@@ -131,18 +136,18 @@ function () {
|
|
|
131
136
|
_this.virtualScroller.stop();
|
|
132
137
|
});
|
|
133
138
|
|
|
134
|
-
this.container =
|
|
139
|
+
this.container = itemsContainerElement;
|
|
135
140
|
this.renderItem = renderItem;
|
|
136
141
|
|
|
137
142
|
var onMount = options.onMount,
|
|
138
143
|
onItemUnmount = options.onItemUnmount,
|
|
139
|
-
restOptions = _objectWithoutProperties(options,
|
|
144
|
+
restOptions = _objectWithoutProperties(options, _excluded);
|
|
140
145
|
|
|
141
146
|
this.onItemUnmount = onItemUnmount;
|
|
142
147
|
this.tbody = this.container.tagName === 'TBODY';
|
|
143
148
|
this.virtualScroller = new _VirtualScroller["default"](function () {
|
|
144
149
|
return _this.container;
|
|
145
|
-
}, _items, _objectSpread({}, restOptions, {
|
|
150
|
+
}, _items, _objectSpread(_objectSpread({}, restOptions), {}, {
|
|
146
151
|
tbody: this.tbody,
|
|
147
152
|
onStateChange: this.onStateChange
|
|
148
153
|
})); // `onMount()` option is deprecated due to no longer being used.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../source/DOM/VirtualScroller.js"],"names":["VirtualScroller","
|
|
1
|
+
{"version":3,"sources":["../../source/DOM/VirtualScroller.js"],"names":["VirtualScroller","itemsContainerElement","items","renderItem","options","state","prevState","firstShownItemIndex","lastShownItemIndex","beforeItemsHeight","afterItemsHeight","tbody","container","style","paddingTop","paddingBottom","diffRender","length","i","unmountItem","childNodes","firstChild","shouldPrependItems","prependBeforeItemElement","item","insertBefore","appendChild","stop","virtualScroller","onMount","onItemUnmount","restOptions","tagName","VirtualScrollerCore","onStateChange","listen","itemElement","removeChild","onItemHeightChange","newItems","setItems"],"mappings":";;;;;;;;;AAAA;;AAEA;;AACA;;;;;;;;;;;;;;;;;;;;;;;;;;IAEqBA,e;AACnB,2BAAYC,qBAAZ,EAAmCC,MAAnC,EAA0CC,UAA1C,EAAoE;AAAA;;AAAA,QAAdC,OAAc,uEAAJ,EAAI;;AAAA;;AAAA,2CA2BpD,UAACC,KAAD,EAAQC,SAAR,EAAsB;AACpC,UACEJ,KADF,GAMIG,KANJ,CACEH,KADF;AAAA,UAEEK,mBAFF,GAMIF,KANJ,CAEEE,mBAFF;AAAA,UAGEC,kBAHF,GAMIH,KANJ,CAGEG,kBAHF;AAAA,UAIEC,iBAJF,GAMIJ,KANJ,CAIEI,iBAJF;AAAA,UAKEC,gBALF,GAMIL,KANJ,CAKEK,gBALF;AAOA,6BAAI,qBAAJ;AACA,6BAAI,gBAAJ,EAAsBJ,SAAtB;AACA,6BAAI,WAAJ,EAAiBD,KAAjB,EAVoC,CAWpC;AACA;AACA;AACA;AACA;;AACA,UAAI,CAAC,KAAI,CAACM,KAAV,EAAiB;AACf,QAAA,KAAI,CAACC,SAAL,CAAeC,KAAf,CAAqBC,UAArB,GAAkC,oBAAGL,iBAAH,CAAlC;AACA,QAAA,KAAI,CAACG,SAAL,CAAeC,KAAf,CAAqBE,aAArB,GAAqC,oBAAGL,gBAAH,CAArC;AACD,OAnBmC,CAoBpC;;;AACA,UAAMM,UAAU,GAAGV,SAAS,IAAIJ,KAAK,KAAKI,SAAS,CAACJ,KAAjC,IAA0CA,KAAK,CAACe,MAAN,GAAe,CAA5E,CArBoC,CAsBpC;;AACA,UAAID,UAAJ,EAAgB;AACd;AACA;AACA,YAAIE,EAAC,GAAGZ,SAAS,CAACE,kBAAlB;;AACA,eAAOU,EAAC,IAAIZ,SAAS,CAACC,mBAAtB,EAA2C;AACzC,cAAIW,EAAC,IAAIX,mBAAL,IAA4BW,EAAC,IAAIV,kBAArC,EAAyD,CACvD;AACD,WAFD,MAEO;AACL,mCAAI,oCAAJ,EAA0CU,EAA1C,EADK,CAEL;;AACA,YAAA,KAAI,CAACC,WAAL,CAAiB,KAAI,CAACP,SAAL,CAAeQ,UAAf,CAA0BF,EAAC,GAAGZ,SAAS,CAACC,mBAAxC,CAAjB;AACD;;AACDW,UAAAA,EAAC;AACF;AACF,OAdD,MAcO;AACL,+BAAI,qCAAJ;;AACA,eAAO,KAAI,CAACN,SAAL,CAAeS,UAAtB,EAAkC;AAChC,UAAA,KAAI,CAACF,WAAL,CAAiB,KAAI,CAACP,SAAL,CAAeS,UAAhC;AACD;AACF,OA1CmC,CA2CpC;;;AACA,UAAIC,kBAAkB,GAAGN,UAAzB;AACA,UAAMO,wBAAwB,GAAGD,kBAAkB,IAAI,KAAI,CAACV,SAAL,CAAeS,UAAtE;AACA,UAAIH,CAAC,GAAGX,mBAAR;;AACA,aAAOW,CAAC,IAAIV,kBAAZ,EAAgC;AAC9B,YAAIQ,UAAU,IAAIE,CAAC,IAAIZ,SAAS,CAACC,mBAA7B,IAAoDW,CAAC,IAAIZ,SAAS,CAACE,kBAAvE,EAA2F;AACzF;AACA;AACA,cAAIc,kBAAJ,EAAwB;AACtBA,YAAAA,kBAAkB,GAAG,KAArB;AACD;AACF,SAND,MAMO;AACL,cAAME,IAAI,GAAG,KAAI,CAACrB,UAAL,CAAgBD,KAAK,CAACgB,CAAD,CAArB,CAAb;;AACA,cAAII,kBAAJ,EAAwB;AACtB,mCAAI,qCAAJ,EAA2CJ,CAA3C,EADsB,CAEtB;;AACA,YAAA,KAAI,CAACN,SAAL,CAAea,YAAf,CAA4BD,IAA5B,EAAkCD,wBAAlC;AACD,WAJD,MAIO;AACL,mCAAI,oCAAJ,EAA0CL,CAA1C,EADK,CAEL;;AACA,YAAA,KAAI,CAACN,SAAL,CAAec,WAAf,CAA2BF,IAA3B;AACD;AACF;;AACDN,QAAAA,CAAC;AACF;AACF,KA/FmE;;AAAA,uCAkGxD,YAAM;AAChB,uBAAK,gGAAL;;AACA,MAAA,KAAI,CAACS,IAAL;AACD,KArGmE;;AAAA,qCAwG1D,YAAM;AACd,uBAAK,8FAAL;;AACA,MAAA,KAAI,CAACA,IAAL;AACD,KA3GmE;;AAAA,kCA8G7D,YAAM;AACX,MAAA,KAAI,CAACC,eAAL,CAAqBD,IAArB;AACD,KAhHmE;;AAClE,SAAKf,SAAL,GAAiBX,qBAAjB;AACA,SAAKE,UAAL,GAAkBA,UAAlB;;AACA,QACE0B,OADF,GAIIzB,OAJJ,CACEyB,OADF;AAAA,QAEEC,aAFF,GAII1B,OAJJ,CAEE0B,aAFF;AAAA,QAGKC,WAHL,4BAII3B,OAJJ;;AAKA,SAAK0B,aAAL,GAAqBA,aAArB;AACA,SAAKnB,KAAL,GAAa,KAAKC,SAAL,CAAeoB,OAAf,KAA2B,OAAxC;AACA,SAAKJ,eAAL,GAAuB,IAAIK,2BAAJ,CACrB;AAAA,aAAM,KAAI,CAACrB,SAAX;AAAA,KADqB,EAErBV,MAFqB,kCAIhB6B,WAJgB;AAKnBpB,MAAAA,KAAK,EAAE,KAAKA,KALO;AAMnBuB,MAAAA,aAAa,EAAE,KAAKA;AAND,OAAvB,CAVkE,CAmBlE;AACA;;AACA,QAAIL,OAAJ,EAAa;AACXA,MAAAA,OAAO;AACR;;AACD,SAAKD,eAAL,CAAqBO,MAArB;AACD;;;;WAyFD,qBAAYC,WAAZ,EAAyB;AACvB,WAAKxB,SAAL,CAAeyB,WAAf,CAA2BD,WAA3B;;AACA,UAAI,KAAKN,aAAT,EAAwB;AACtB,aAAKA,aAAL,CAAmBM,WAAnB;AACD;AACF;;;WAED,4BAAmBlB,CAAnB,EAAsB;AACpB,WAAKU,eAAL,CAAqBU,kBAArB,CAAwCpB,CAAxC;AACD;AAED;AACF;AACA;AACA;;;;WACE,qBAAYqB,QAAZ,EAAsBnC,OAAtB,EAA+B;AAC7B,WAAKoC,QAAL,CAAcD,QAAd,EAAwBnC,OAAxB;AACD;;;WAED,kBAASmC,QAAT,EAAmBnC,OAAnB,EAA4B;AAC1B,WAAKwB,eAAL,CAAqBY,QAArB,CAA8BD,QAA9B,EAAwCnC,OAAxC;AACD;AAED;AACF;AACA;AACA;AACA","sourcesContent":["import VirtualScrollerCore from '../VirtualScroller'\r\n\r\nimport log, { warn } from '../utility/debug'\r\nimport px from '../utility/px'\r\n\r\nexport default class VirtualScroller {\r\n constructor(itemsContainerElement, items, renderItem, options = {}) {\r\n this.container = itemsContainerElement\r\n this.renderItem = renderItem\r\n const {\r\n onMount,\r\n onItemUnmount,\r\n ...restOptions\r\n } = options\r\n this.onItemUnmount = onItemUnmount\r\n this.tbody = this.container.tagName === 'TBODY'\r\n this.virtualScroller = new VirtualScrollerCore(\r\n () => this.container,\r\n items,\r\n {\r\n ...restOptions,\r\n tbody: this.tbody,\r\n onStateChange: this.onStateChange\r\n }\r\n )\r\n // `onMount()` option is deprecated due to no longer being used.\r\n // If someone thinks there's a valid use case for it, create an issue.\r\n if (onMount) {\r\n onMount()\r\n }\r\n this.virtualScroller.listen()\r\n }\r\n\r\n onStateChange = (state, prevState) => {\r\n const {\r\n items,\r\n firstShownItemIndex,\r\n lastShownItemIndex,\r\n beforeItemsHeight,\r\n afterItemsHeight\r\n } = state\r\n log('~ On state change ~')\r\n log('Previous state', prevState)\r\n log('New state', state)\r\n // Set container padding top and bottom.\r\n // Work around `<tbody/>` not being able to have `padding`.\r\n // https://gitlab.com/catamphetamine/virtual-scroller/-/issues/1\r\n // `this.virtualScroller` hasn't been initialized yet at this stage,\r\n // so using `this.tbody` instead of `this.virtualScroller.tbody`.\r\n if (!this.tbody) {\r\n this.container.style.paddingTop = px(beforeItemsHeight)\r\n this.container.style.paddingBottom = px(afterItemsHeight)\r\n }\r\n // Perform an intelligent \"diff\" re-render if the `items` are the same.\r\n const diffRender = prevState && items === prevState.items && items.length > 0\r\n // Remove no longer visible items from the DOM.\r\n if (diffRender) {\r\n // Decrement instead of increment here because\r\n // `this.container.removeChild()` changes indexes.\r\n let i = prevState.lastShownItemIndex\r\n while (i >= prevState.firstShownItemIndex) {\r\n if (i >= firstShownItemIndex && i <= lastShownItemIndex) {\r\n // The item is still visible.\r\n } else {\r\n log('DOM: Remove element for item index', i)\r\n // The item is no longer visible. Remove it.\r\n this.unmountItem(this.container.childNodes[i - prevState.firstShownItemIndex])\r\n }\r\n i--\r\n }\r\n } else {\r\n log('DOM: Rerender the list from scratch')\r\n while (this.container.firstChild) {\r\n this.unmountItem(this.container.firstChild)\r\n }\r\n }\r\n // Add newly visible items to the DOM.\r\n let shouldPrependItems = diffRender\r\n const prependBeforeItemElement = shouldPrependItems && this.container.firstChild\r\n let i = firstShownItemIndex\r\n while (i <= lastShownItemIndex) {\r\n if (diffRender && i >= prevState.firstShownItemIndex && i <= prevState.lastShownItemIndex) {\r\n // The item is already being rendered.\r\n // Next items will be appended rather than prepended.\r\n if (shouldPrependItems) {\r\n shouldPrependItems = false\r\n }\r\n } else {\r\n const item = this.renderItem(items[i])\r\n if (shouldPrependItems) {\r\n log('DOM: Prepend element for item index', i)\r\n // Append `item` to `this.container` before the retained items.\r\n this.container.insertBefore(item, prependBeforeItemElement)\r\n } else {\r\n log('DOM: Append element for item index', i)\r\n // Append `item` to `this.container`.\r\n this.container.appendChild(item)\r\n }\r\n }\r\n i++\r\n }\r\n }\r\n\r\n // Public API. Should be \"bound\" to `this`.\r\n onUnmount = () => {\r\n warn('`.onUnmount()` instance method name is deprecated, use `.stop()` instance method name instead.')\r\n this.stop()\r\n }\r\n\r\n // Public API. Should be \"bound\" to `this`.\r\n destroy = () => {\r\n warn('`.destroy()` instance method name is deprecated, use `.stop()` instance method name instead.')\r\n this.stop()\r\n }\r\n\r\n // Public API. Should be \"bound\" to `this`.\r\n stop = () => {\r\n this.virtualScroller.stop()\r\n }\r\n\r\n unmountItem(itemElement) {\r\n this.container.removeChild(itemElement)\r\n if (this.onItemUnmount) {\r\n this.onItemUnmount(itemElement)\r\n }\r\n }\r\n\r\n onItemHeightChange(i) {\r\n this.virtualScroller.onItemHeightChange(i)\r\n }\r\n\r\n /**\r\n * @deprecated\r\n * `.updateItems()` has been renamed to `.setItems()`.\r\n */\r\n updateItems(newItems, options) {\r\n this.setItems(newItems, options)\r\n }\r\n\r\n setItems(newItems, options) {\r\n this.virtualScroller.setItems(newItems, options)\r\n }\r\n\r\n /*\r\n getItemCoordinates(i) {\r\n return this.virtualScroller.getItemCoordinates(i)\r\n }\r\n */\r\n}"],"file":"VirtualScroller.js"}
|
package/commonjs/DOM/tbody.js
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.
|
|
6
|
+
exports.BROWSER_NOT_SUPPORTED_ERROR = void 0;
|
|
7
7
|
exports.addTbodyStyles = addTbodyStyles;
|
|
8
8
|
exports.setTbodyPadding = setTbodyPadding;
|
|
9
|
-
exports.
|
|
9
|
+
exports.supportsTbody = supportsTbody;
|
|
10
10
|
|
|
11
11
|
var _px = _interopRequireDefault(require("../utility/px"));
|
|
12
12
|
|
package/commonjs/ItemHeights.js
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
|
+
function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
|
|
4
|
+
|
|
3
5
|
Object.defineProperty(exports, "__esModule", {
|
|
4
6
|
value: true
|
|
5
7
|
});
|
|
@@ -7,7 +9,9 @@ exports["default"] = void 0;
|
|
|
7
9
|
|
|
8
10
|
var _debug = _interopRequireWildcard(require("./utility/debug"));
|
|
9
11
|
|
|
10
|
-
function
|
|
12
|
+
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
13
|
+
|
|
14
|
+
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
11
15
|
|
|
12
16
|
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
|
|
13
17
|
|
|
@@ -15,14 +19,11 @@ function _defineProperties(target, props) { for (var i = 0; i < props.length; i+
|
|
|
15
19
|
|
|
16
20
|
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
|
|
17
21
|
|
|
18
|
-
var ItemHeights =
|
|
19
|
-
|
|
20
|
-
function () {
|
|
21
|
-
function ItemHeights(screen, getContainerElement, getItemHeight, setItemHeight) {
|
|
22
|
+
var ItemHeights = /*#__PURE__*/function () {
|
|
23
|
+
function ItemHeights(container, getItemHeight, setItemHeight) {
|
|
22
24
|
_classCallCheck(this, ItemHeights);
|
|
23
25
|
|
|
24
|
-
this.
|
|
25
|
-
this.getContainerElement = getContainerElement;
|
|
26
|
+
this.container = container;
|
|
26
27
|
this._get = getItemHeight;
|
|
27
28
|
this._set = setItemHeight;
|
|
28
29
|
this.reset();
|
|
@@ -90,15 +91,7 @@ function () {
|
|
|
90
91
|
}, {
|
|
91
92
|
key: "_measureItemHeight",
|
|
92
93
|
value: function _measureItemHeight(i, firstShownItemIndex) {
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
if (container) {
|
|
96
|
-
var elementIndex = i - firstShownItemIndex;
|
|
97
|
-
|
|
98
|
-
if (elementIndex >= 0 && elementIndex < this.screen.getChildElementsCount(container)) {
|
|
99
|
-
return this.screen.getChildElementHeight(container, elementIndex);
|
|
100
|
-
}
|
|
101
|
-
}
|
|
94
|
+
return this.container.getNthRenderedItemHeight(i - firstShownItemIndex);
|
|
102
95
|
}
|
|
103
96
|
/**
|
|
104
97
|
* Measures item heights:
|
|
@@ -122,7 +115,8 @@ function () {
|
|
|
122
115
|
}, {
|
|
123
116
|
key: "measureItemHeights",
|
|
124
117
|
value: function measureItemHeights(firstShownItemIndex, lastShownItemIndex) {
|
|
125
|
-
// If no items are rendered, don't measure anything.
|
|
118
|
+
(0, _debug["default"])('~ Measure item heights ~'); // If no items are rendered, don't measure anything.
|
|
119
|
+
|
|
126
120
|
if (firstShownItemIndex === undefined) {
|
|
127
121
|
return;
|
|
128
122
|
} // Reset `this.measuredItemsHeight` if it's not a "continuous" measured items list:
|
|
@@ -147,22 +141,18 @@ function () {
|
|
|
147
141
|
var i = firstShownItemIndex;
|
|
148
142
|
|
|
149
143
|
while (i <= lastShownItemIndex) {
|
|
144
|
+
// Measure item heights that haven't been measured previously.
|
|
150
145
|
// Don't re-measure item heights that have been measured previously.
|
|
151
146
|
// The rationale is that developers are supposed to manually call
|
|
152
147
|
// `.onItemHeightChange()` every time an item's height changes.
|
|
153
|
-
// If developers
|
|
148
|
+
// If developers don't neglect that rule, item heights won't
|
|
154
149
|
// change unexpectedly.
|
|
155
|
-
// // Re-measure all shown items' heights, because an item's height
|
|
156
|
-
// // might have changed since it has been measured initially.
|
|
157
|
-
// // For example, if an item is a long comment with a "Show more" button,
|
|
158
|
-
// // then the user might have clicked that "Show more" button.
|
|
159
150
|
if (this._get(i) === undefined) {
|
|
160
151
|
nonPreviouslyMeasuredItemIndexes.push(i);
|
|
161
|
-
(0, _debug["default"])('Item', i, 'hasn\'t been previously measured');
|
|
162
152
|
|
|
163
153
|
var height = this._measureItemHeight(i, firstShownItemIndex);
|
|
164
154
|
|
|
165
|
-
(0, _debug["default"])('
|
|
155
|
+
(0, _debug["default"])('Item index', i, 'height', height);
|
|
166
156
|
|
|
167
157
|
this._set(i, height); // Update average item height calculation variables
|
|
168
158
|
// related to the previously measured items
|
|
@@ -202,16 +192,19 @@ function () {
|
|
|
202
192
|
this.lastMeasuredItemIndex = i;
|
|
203
193
|
}
|
|
204
194
|
} else {
|
|
205
|
-
// Validate the item's height
|
|
206
|
-
//
|
|
207
|
-
//
|
|
208
|
-
//
|
|
195
|
+
// Validate that the item's height didn't change since it was last measured.
|
|
196
|
+
// If it did, then display a warning and update the item's height
|
|
197
|
+
// as an attempt to fix things.
|
|
198
|
+
// If an item's height changes unexpectedly then it means that there'll
|
|
199
|
+
// likely be "content jumping".
|
|
209
200
|
var previousHeight = this._get(i);
|
|
210
201
|
|
|
211
202
|
var _height = this._measureItemHeight(i, firstShownItemIndex);
|
|
212
203
|
|
|
213
204
|
if (previousHeight !== _height) {
|
|
214
|
-
(0, _debug.warn)('Item', i, 'height was', previousHeight, 'before it
|
|
205
|
+
(0, _debug.warn)('Item index', i, 'height changed unexpectedly: it was', previousHeight, 'before, but now it is', _height, '. An item\'s height is allowed to change only in two cases: when the item\'s "state" changes and the developer calls `onItemStateChange(i, newState)`, or when the item\'s height changes for some other reason and the developer calls `onItemHeightChange(i)`. Perhaps you forgot to persist the item\'s "state" by calling `onItemStateChange(i, newState)` when it changed, and that "state" got lost when the item element was unmounted, which resulted in a different height when the item was shown again having its "state" reset.'); // Update the item's height as an attempt to fix things.
|
|
206
|
+
|
|
207
|
+
this._set(i, _height);
|
|
215
208
|
}
|
|
216
209
|
}
|
|
217
210
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../source/ItemHeights.js"],"names":["ItemHeights","screen","getContainerElement","getItemHeight","setItemHeight","_get","_set","reset","measuredItemsHeight","firstMeasuredItemIndex","undefined","lastMeasuredItemIndex","itemHeights","i","length","firstShownItemIndex","container","elementIndex","getChildElementsCount","getChildElementHeight","lastShownItemIndex","nonPreviouslyMeasuredItemIndexes","previousFirstMeasuredItemIndex","previousLastMeasuredItemIndex","firstMeasuredItemIndexHasBeenUpdated","push","height","_measureItemHeight","previousHeight","count"],"mappings":";;;;;;;AAAA;;;;;;;;;;IAEqBA,W;;;AACpB,uBAAYC,MAAZ,EAAoBC,mBAApB,EAAyCC,aAAzC,EAAwDC,aAAxD,EAAuE;AAAA;;AACtE,SAAKH,MAAL,GAAcA,MAAd;AACA,SAAKC,mBAAL,GAA2BA,mBAA3B;AACA,SAAKG,IAAL,GAAYF,aAAZ;AACA,SAAKG,IAAL,GAAYF,aAAZ;AACA,SAAKG,KAAL;AACA;;;;4BAEO;AACP,WAAKC,mBAAL,GAA2B,CAA3B,CADO,CAEP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,WAAKC,sBAAL,GAA8BC,SAA9B;AACA,WAAKC,qBAAL,GAA6BD,SAA7B;AACA;AAED;;;;;;;;;;;+BAQWE,W,EAAa;AACvB,UAAIC,CAAC,GAAG,CAAR;;AACA,aAAOA,CAAC,GAAGD,WAAW,CAACE,MAAvB,EAA+B;AAC9B,YAAIF,WAAW,CAACC,CAAD,CAAX,KAAmBH,SAAvB,EAAkC;AACjC,cAAI,KAAKD,sBAAL,KAAgCC,SAApC,EAA+C;AAC9C,iBAAKC,qBAAL,GAA6BE,CAAC,GAAG,CAAjC;AACA;AACA;AACD,SALD,MAKO;AACN,cAAI,KAAKJ,sBAAL,KAAgCC,SAApC,EAA+C;AAC9C,iBAAKD,sBAAL,GAA8BI,CAA9B;AACA;;AACD,eAAKL,mBAAL,IAA4BI,WAAW,CAACC,CAAD,CAAvC;AACA;;AACDA,QAAAA,CAAC;AACD;AACD,K,CAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;uCAEmBA,C,EAAGE,mB,EAAqB;AAC1C,UAAMC,SAAS,GAAG,KAAKd,mBAAL,EAAlB;;AACA,UAAIc,SAAJ,EAAe;AACd,YAAMC,YAAY,GAAGJ,CAAC,GAAGE,mBAAzB;;AACA,YAAIE,YAAY,IAAI,CAAhB,IAAqBA,YAAY,GAAG,KAAKhB,MAAL,CAAYiB,qBAAZ,CAAkCF,SAAlC,CAAxC,EAAsF;AACrF,iBAAO,KAAKf,MAAL,CAAYkB,qBAAZ,CAAkCH,SAAlC,EAA6CC,YAA7C,CAAP;AACA;AACD;AACD;AAED;;;;;;;;;;;;;;;;;;;;;uCAkBmBF,mB,EAAqBK,kB,EAAoB;AAC3D;AACA,UAAIL,mBAAmB,KAAKL,SAA5B,EAAuC;AACtC;AACA,OAJ0D,CAK3D;AACA;AACA;AACA;AACA;;;AACA,UAAI,KAAKD,sBAAL,KAAgCC,SAApC,EAA+C;AAC9C,YAAIK,mBAAmB,GAAG,KAAKJ,qBAAL,GAA6B,CAAnD,IACFS,kBAAkB,GAAG,KAAKX,sBAAL,GAA8B,CADrD,EACwD;AACvD;AACA,iCAAI,8EAAJ;AACA,eAAKF,KAAL;AACA;AACD;;AACD,UAAMc,gCAAgC,GAAG,EAAzC;AACA,UAAMC,8BAA8B,GAAG,KAAKb,sBAA5C;AACA,UAAMc,6BAA6B,GAAG,KAAKZ,qBAA3C;AACA,UAAIa,oCAAoC,GAAG,KAA3C;AACA,UAAIX,CAAC,GAAGE,mBAAR;;AACA,aAAOF,CAAC,IAAIO,kBAAZ,EAAgC;AAC/B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,YAAI,KAAKf,IAAL,CAAUQ,CAAV,MAAiBH,SAArB,EAAgC;AAC/BW,UAAAA,gCAAgC,CAACI,IAAjC,CAAsCZ,CAAtC;AACA,iCAAI,MAAJ,EAAYA,CAAZ,EAAe,kCAAf;;AACA,cAAMa,MAAM,GAAG,KAAKC,kBAAL,CAAwBd,CAAxB,EAA2BE,mBAA3B,CAAf;;AACA,iCAAI,QAAJ,EAAcW,MAAd;;AACA,eAAKpB,IAAL,CAAUO,CAAV,EAAaa,MAAb,EAL+B,CAM/B;AACA;AACA;AACA;AACA;;;AACA,cAAIJ,8BAA8B,KAAKZ,SAAnC,IAAgDG,CAAC,GAAGS,8BAAxD,EAAwF;AACvF,iBAAKd,mBAAL,IAA4BkB,MAA5B,CADuF,CAEvF;;AACA,gBAAI,CAACF,oCAAL,EAA2C;AAC1C;AACA,mBAAKf,sBAAL,GAA8BI,CAA9B;AACAW,cAAAA,oCAAoC,GAAG,IAAvC;AACA;AACD,WAnB8B,CAoB/B;AACA;AACA;AACA;AACA;;;AACA,cAAID,6BAA6B,KAAKb,SAAlC,IAA+CG,CAAC,GAAGU,6BAAvD,EAAsF;AACrF;AACA;AACA;AACA;AACA;AACA;AACA,gBAAIA,6BAA6B,KAAKb,SAAtC,EAAiD;AAChD;AACA,mBAAKF,mBAAL,IAA4BkB,MAA5B;AACA,aAVoF,CAWrF;;;AACA,iBAAKf,qBAAL,GAA6BE,CAA7B;AACA;AACD,SAvCD,MAuCO;AACN;AACA;AACA;AACA;AACA,cAAMe,cAAc,GAAG,KAAKvB,IAAL,CAAUQ,CAAV,CAAvB;;AACA,cAAMa,OAAM,GAAG,KAAKC,kBAAL,CAAwBd,CAAxB,EAA2BE,mBAA3B,CAAf;;AACA,cAAIa,cAAc,KAAKF,OAAvB,EAA+B;AAC9B,6BAAK,MAAL,EAAab,CAAb,EAAgB,YAAhB,EAA8Be,cAA9B,EAA8C,kEAA9C,EAAkHF,OAAlH,EAA0H,6QAA1H;AACA;AACD;;AACDb,QAAAA,CAAC;AACD,OApF0D,CAqF3D;AACA;;;AACA,aAAOQ,gCAAP;AACA;AAED;;;;;;;;wCAKoBR,C,EAAGE,mB,EAAqB;AAC3C,UAAMa,cAAc,GAAG,KAAKvB,IAAL,CAAUQ,CAAV,CAAvB;;AACA,UAAMa,MAAM,GAAG,KAAKC,kBAAL,CAAwBd,CAAxB,EAA2BE,mBAA3B,CAAf,CAF2C,CAG3C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,WAAKT,IAAL,CAAUO,CAAV,EAAaa,MAAb;;AACA,WAAKlB,mBAAL,IAA4BkB,MAAM,GAAGE,cAArC;AACA,aAAOF,MAAP;AACA,K,CAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;;;;;;iCAIa;AACZ,UAAI,KAAKf,qBAAL,KAA+BD,SAAnC,EAA8C;AAC7C,eAAO,CAAP;AACA;;AACD,aAAO,KAAKF,mBAAL,IAA4B,KAAKG,qBAAL,GAA6B,KAAKF,sBAAlC,GAA2D,CAAvF,CAAP;AACA;;;8BAESoB,K,EAAO;AAChB,UAAI,KAAKpB,sBAAL,KAAgCC,SAApC,EAA+C;AAC9C,aAAKD,sBAAL,IAA+BoB,KAA/B;AACA,aAAKlB,qBAAL,IAA8BkB,KAA9B;AACA;AACD","sourcesContent":["import log, { warn, isDebug, reportError } from './utility/debug'\r\n\r\nexport default class ItemHeights {\r\n\tconstructor(screen, getContainerElement, getItemHeight, setItemHeight) {\r\n\t\tthis.screen = screen\r\n\t\tthis.getContainerElement = getContainerElement\r\n\t\tthis._get = getItemHeight\r\n\t\tthis._set = setItemHeight\r\n\t\tthis.reset()\r\n\t}\r\n\r\n\treset() {\r\n\t\tthis.measuredItemsHeight = 0\r\n\t\t// \"First measured item index\" variable was introduced\r\n\t\t// because it's not always `0`: when `virtualScroller.setItems()`\r\n\t\t// is called, some items might get prepended, in which case\r\n\t\t// `this.lastMeasuredItemIndex` is updated. If there was no\r\n\t\t// `this.firstMeasuredItemIndex`, then the average item height\r\n\t\t// calculated in `.getAverage()` would be incorrect in the timeframe\r\n\t\t// between `.setItems()` is called and those changes have been rendered.\r\n\t\t// And in that timeframe, `.getAverage()` is used to calculate the \"layout\":\r\n\t\t// stuff like \"before/after items height\" and \"estimated items count on screen\".\r\n\t\tthis.firstMeasuredItemIndex = undefined\r\n\t\tthis.lastMeasuredItemIndex = undefined\r\n\t}\r\n\r\n\t/**\r\n\t * Is called after `.reset()`.\r\n\t * Initializes `this.measuredItemsHeight`, `this.firstMeasuredItemIndex`\r\n\t * and `this.lastMeasuredItemIndex` instance variables from `VirtualScroller` `state`.\r\n\t * These instance variables are used when calculating \"average\" item height:\r\n\t * the \"average\" item height is simply `this.measuredItemsHeight` divided by\r\n\t * `this.lastMeasuredItemIndex` minus `this.firstMeasuredItemIndex` plus 1.\r\n\t */\r\n\tinitialize(itemHeights) {\r\n\t\tlet i = 0\r\n\t\twhile (i < itemHeights.length) {\r\n\t\t\tif (itemHeights[i] === undefined) {\r\n\t\t\t\tif (this.firstMeasuredItemIndex !== undefined) {\r\n\t\t\t\t\tthis.lastMeasuredItemIndex = i - 1\r\n\t\t\t\t\tbreak\r\n\t\t\t\t}\r\n\t\t\t} else {\r\n\t\t\t\tif (this.firstMeasuredItemIndex === undefined) {\r\n\t\t\t\t\tthis.firstMeasuredItemIndex = i\r\n\t\t\t\t}\r\n\t\t\t\tthis.measuredItemsHeight += itemHeights[i]\r\n\t\t\t}\r\n\t\t\ti++\r\n\t\t}\r\n\t}\r\n\r\n\t// Seems to be no longer used.\r\n\t// getItemHeight(i, firstShownItemIndex) {\r\n\t// \tif (this._get(i)) {\r\n\t// \t\treturn this._get(i)\r\n\t// \t}\r\n\t// \tconst itemHeight = this._measureItemHeight(i, firstShownItemIndex)\r\n\t// \tif (itemHeight) {\r\n\t// \t\tthis._set(i, itemHeight)\r\n\t// \t\treturn itemHeight\r\n\t// \t}\r\n\t// \treturn this.getAverage()\r\n\t// }\r\n\r\n\t_measureItemHeight(i, firstShownItemIndex) {\r\n\t\tconst container = this.getContainerElement()\r\n\t\tif (container) {\r\n\t\t\tconst elementIndex = i - firstShownItemIndex\r\n\t\t\tif (elementIndex >= 0 && elementIndex < this.screen.getChildElementsCount(container)) {\r\n\t\t\t\treturn this.screen.getChildElementHeight(container, elementIndex)\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n\r\n\t/**\r\n\t * Measures item heights:\r\n\t *\r\n\t * * For the items that haven't been previously measured,\r\n\t * measures them for the first time.\r\n\t *\r\n\t * * For the items that have been previoulsy measured,\r\n\t * validate that their previously measured height\r\n\t * is still equal to their current height.\r\n\t * The unequalness may not necessarily be caused by\r\n\t * incorrect use of `virtual-scroller`: there are\r\n\t * also some valid use cases when such unequalness\r\n\t * could happen (see the comments in the code).\r\n\t *\r\n\t * @param {number} firstShownItemIndex\r\n\t * @param {number} lastShownItemIndex\r\n\t * @return {number[]} The indexes of the items that have not previously been measured and have been measured now.\r\n\t */\r\n\tmeasureItemHeights(firstShownItemIndex, lastShownItemIndex) {\r\n\t\t// If no items are rendered, don't measure anything.\r\n\t\tif (firstShownItemIndex === undefined) {\r\n\t\t\treturn\r\n\t\t}\r\n\t\t// Reset `this.measuredItemsHeight` if it's not a \"continuous\" measured items list:\r\n\t\t// if a group of items has been measured previously, and now it has rendered a completely\r\n\t\t// different group of items, and there's a non-measured \"gap\" between those two groups,\r\n\t\t// then reset `this.measuredItemsHeight` and \"first measured\"/\"last measured\" item indexes.\r\n\t\t// For example, this could happen when `.setItems()` prepends a lot of new items.\r\n\t\tif (this.firstMeasuredItemIndex !== undefined) {\r\n\t\t\tif (firstShownItemIndex > this.lastMeasuredItemIndex + 1 ||\r\n\t\t\t\t\tlastShownItemIndex < this.firstMeasuredItemIndex - 1) {\r\n\t\t\t\t// Reset.\r\n\t\t\t\tlog('Non-measured items gap detected. Reset first and last measured item indexes.')\r\n\t\t\t\tthis.reset()\r\n\t\t\t}\r\n\t\t}\r\n\t\tconst nonPreviouslyMeasuredItemIndexes = []\r\n\t\tconst previousFirstMeasuredItemIndex = this.firstMeasuredItemIndex\r\n\t\tconst previousLastMeasuredItemIndex = this.lastMeasuredItemIndex\r\n\t\tlet firstMeasuredItemIndexHasBeenUpdated = false\r\n\t\tlet i = firstShownItemIndex\r\n\t\twhile (i <= lastShownItemIndex) {\r\n\t\t\t// Don't re-measure item heights that have been measured previously.\r\n\t\t\t// The rationale is that developers are supposed to manually call\r\n\t\t\t// `.onItemHeightChange()` every time an item's height changes.\r\n\t\t\t// If developers aren't neglecting that rule, item heights won't\r\n\t\t\t// change unexpectedly.\r\n\t\t\t// // Re-measure all shown items' heights, because an item's height\r\n\t\t\t// // might have changed since it has been measured initially.\r\n\t\t\t// // For example, if an item is a long comment with a \"Show more\" button,\r\n\t\t\t// // then the user might have clicked that \"Show more\" button.\r\n\t\t\tif (this._get(i) === undefined) {\r\n\t\t\t\tnonPreviouslyMeasuredItemIndexes.push(i)\r\n\t\t\t\tlog('Item', i, 'hasn\\'t been previously measured')\r\n\t\t\t\tconst height = this._measureItemHeight(i, firstShownItemIndex)\r\n\t\t\t\tlog('Height', height)\r\n\t\t\t\tthis._set(i, height)\r\n\t\t\t\t// Update average item height calculation variables\r\n\t\t\t\t// related to the previously measured items\r\n\t\t\t\t// that're above the items currently being shown.\r\n\t\t\t\t// It is known to be a \"continuous\" measured items list,\r\n\t\t\t\t// because the code at the start of this function checks that.\r\n\t\t\t\tif (previousFirstMeasuredItemIndex === undefined || i < previousFirstMeasuredItemIndex) {\r\n\t\t\t\t\tthis.measuredItemsHeight += height\r\n\t\t\t\t\t// Update first measured item index.\r\n\t\t\t\t\tif (!firstMeasuredItemIndexHasBeenUpdated) {\r\n\t\t\t\t\t\t// log('Set first measured item index', i)\r\n\t\t\t\t\t\tthis.firstMeasuredItemIndex = i\r\n\t\t\t\t\t\tfirstMeasuredItemIndexHasBeenUpdated = true\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t\t// Update average item height calculation variables\r\n\t\t\t\t// related to the previously measured items\r\n\t\t\t\t// that're below the items currently being shown.\r\n\t\t\t\t// It is known to be a \"continuous\" measured items list,\r\n\t\t\t\t// because the code at the start of this function checks that.\r\n\t\t\t\tif (previousLastMeasuredItemIndex === undefined || i > previousLastMeasuredItemIndex) {\r\n\t\t\t\t\t// If `previousLastMeasuredItemIndex` is `undefined`\r\n\t\t\t\t\t// then `previousFirstMeasuredItemIndex` is also `undefined`\r\n\t\t\t\t\t// which means that the item's `height` has already been added\r\n\t\t\t\t\t// to `this.measuredItemsHeight` in the code above,\r\n\t\t\t\t\t// so this condition guards against counting the item's `height`\r\n\t\t\t\t\t// twice in `this.measuredItemsHeight`.\r\n\t\t\t\t\tif (previousLastMeasuredItemIndex !== undefined) {\r\n\t\t\t\t\t\t// Add newly shown item height.\r\n\t\t\t\t\t\tthis.measuredItemsHeight += height\r\n\t\t\t\t\t}\r\n\t\t\t\t\t// Update last measured item index.\r\n\t\t\t\t\tthis.lastMeasuredItemIndex = i\r\n\t\t\t\t}\r\n\t\t\t} else {\r\n\t\t\t\t// Validate the item's height right after showing it after being hidden,\r\n\t\t\t\t// because, if the stored item's state isn't applied properly, the item's\r\n\t\t\t\t// height might be incorrect when it's rendered with that state not applied,\r\n\t\t\t\t// and so a developer could know that there's a bug in their code.\r\n\t\t\t\tconst previousHeight = this._get(i)\r\n\t\t\t\tconst height = this._measureItemHeight(i, firstShownItemIndex)\r\n\t\t\t\tif (previousHeight !== height) {\r\n\t\t\t\t\twarn('Item', i, 'height was', previousHeight, 'before it was hidden, but, after showing it again, its height is', height, '. Perhaps you forgot to persist the item\\'s state by calling `onItemStateChange(i, newState)` when it changed, and that state got lost when the item element was unmounted, which resulted in a different height when the item was shown again, but with the missing state.')\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t\ti++\r\n\t\t}\r\n\t\t// // Update average item height.\r\n\t\t// this.updateAverageItemHeight()\r\n\t\treturn nonPreviouslyMeasuredItemIndexes\r\n\t}\r\n\r\n\t/**\r\n\t * Re-measures item height.\r\n\t * @param {number} i — Item index.\r\n\t * @param {number} firstShownItemIndex\r\n\t */\r\n\tremeasureItemHeight(i, firstShownItemIndex) {\r\n\t\tconst previousHeight = this._get(i)\r\n\t\tconst height = this._measureItemHeight(i, firstShownItemIndex)\r\n\t\t// // Because this function is called from `.onItemHeightChange()`,\r\n\t\t// // there're no guarantees in which circumstances a developer calls it,\r\n\t\t// // and for which item indexes.\r\n\t\t// // Therefore, to guard against cases of incorrect usage,\r\n\t\t// // this function won't crash anything if the item isn't rendered\r\n\t\t// // or hasn't been previously rendered.\r\n\t\t// if (height !== undefined) {\r\n\t\t// \treportError(`\"onItemHeightChange()\" has been called for item ${i}, but that item isn't rendered.`)\r\n\t\t// \treturn\r\n\t\t// }\r\n\t\t// if (previousHeight === undefined) {\r\n\t\t// \treportError(`\"onItemHeightChange()\" has been called for item ${i}, but that item hasn't been rendered before.`)\r\n\t\t// \treturn\r\n\t\t// }\r\n\t\tthis._set(i, height)\r\n\t\tthis.measuredItemsHeight += height - previousHeight\r\n\t\treturn height\r\n\t}\r\n\r\n\t// /**\r\n\t// * \"Average\" item height is stored as an instance variable.\r\n\t// * For example, for caching, so that it isn't calculated every time it's requested.\r\n\t// * But that would be negligible performance gain, not really worth the extra code.\r\n\t// * Another thing it's stored for as an instance variable is\r\n\t// * keeping \"previous\" \"average\" item height, because it can be more precise\r\n\t// * than the newly calculated \"average\" item height, provided it had\r\n\t// * more \"samples\" (measured items). The newly calculated average item height\r\n\t// * could get less samples in a scenario when the scroll somehow jumps\r\n\t// * from one position to some other distant position: in that case previous\r\n\t// * \"total measured items height\" is discarded and the new one is initialized.\r\n\t// * Could such situation happen in real life? I guess, it's unlikely.\r\n\t// * So I'm commenting out this code, but still keeping it just in case.\r\n\t// */\r\n\t// updateAverageItemHeight() {\r\n\t// \tthis.averageItemHeightSamplesCount = this.lastMeasuredItemIndex - this.firstMeasuredItemIndex + 1\r\n\t// \tthis.averageItemHeight = this.measuredItemsHeight / this.averageItemHeightSamplesCount\r\n\t// }\r\n\t//\r\n\t// /**\r\n\t// * Public API: is called by `VirtualScroller`.\r\n\t// * @return {number}\r\n\t// */\r\n\t// getAverage() {\r\n\t// \t// Previously measured average item height might still be\r\n\t// \t// more precise if it contains more measured items (\"samples\").\r\n\t// \tif (this.previousAverageItemHeight) {\r\n\t// \t\tif (this.previousAverageItemHeightSamplesCount > this.averageItemHeightSamplesCount) {\r\n\t// \t\t\treturn this.previousAverageItemHeight\r\n\t// \t\t}\r\n\t// \t}\r\n\t// \treturn this.averageItemHeight || 0\r\n\t// }\r\n\r\n\t/**\r\n\t * Public API: is called by `VirtualScroller`.\r\n\t * @return {number}\r\n\t */\r\n\tgetAverage() {\r\n\t\tif (this.lastMeasuredItemIndex === undefined) {\r\n\t\t\treturn 0\r\n\t\t}\r\n\t\treturn this.measuredItemsHeight / (this.lastMeasuredItemIndex - this.firstMeasuredItemIndex + 1)\r\n\t}\r\n\r\n\tonPrepend(count) {\r\n\t\tif (this.firstMeasuredItemIndex !== undefined) {\r\n\t\t\tthis.firstMeasuredItemIndex += count\r\n\t\t\tthis.lastMeasuredItemIndex += count\r\n\t\t}\r\n\t}\r\n}"],"file":"ItemHeights.js"}
|
|
1
|
+
{"version":3,"sources":["../source/ItemHeights.js"],"names":["ItemHeights","container","getItemHeight","setItemHeight","_get","_set","reset","measuredItemsHeight","firstMeasuredItemIndex","undefined","lastMeasuredItemIndex","itemHeights","i","length","firstShownItemIndex","getNthRenderedItemHeight","lastShownItemIndex","nonPreviouslyMeasuredItemIndexes","previousFirstMeasuredItemIndex","previousLastMeasuredItemIndex","firstMeasuredItemIndexHasBeenUpdated","push","height","_measureItemHeight","previousHeight","count"],"mappings":";;;;;;;;;AAAA;;;;;;;;;;;;IAEqBA,W;AACpB,uBAAYC,SAAZ,EAAuBC,aAAvB,EAAsCC,aAAtC,EAAqD;AAAA;;AACpD,SAAKF,SAAL,GAAiBA,SAAjB;AACA,SAAKG,IAAL,GAAYF,aAAZ;AACA,SAAKG,IAAL,GAAYF,aAAZ;AACA,SAAKG,KAAL;AACA;;;;WAED,iBAAQ;AACP,WAAKC,mBAAL,GAA2B,CAA3B,CADO,CAEP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,WAAKC,sBAAL,GAA8BC,SAA9B;AACA,WAAKC,qBAAL,GAA6BD,SAA7B;AACA;AAED;AACD;AACA;AACA;AACA;AACA;AACA;AACA;;;;WACC,oBAAWE,WAAX,EAAwB;AACvB,UAAIC,CAAC,GAAG,CAAR;;AACA,aAAOA,CAAC,GAAGD,WAAW,CAACE,MAAvB,EAA+B;AAC9B,YAAIF,WAAW,CAACC,CAAD,CAAX,KAAmBH,SAAvB,EAAkC;AACjC,cAAI,KAAKD,sBAAL,KAAgCC,SAApC,EAA+C;AAC9C,iBAAKC,qBAAL,GAA6BE,CAAC,GAAG,CAAjC;AACA;AACA;AACD,SALD,MAKO;AACN,cAAI,KAAKJ,sBAAL,KAAgCC,SAApC,EAA+C;AAC9C,iBAAKD,sBAAL,GAA8BI,CAA9B;AACA;;AACD,eAAKL,mBAAL,IAA4BI,WAAW,CAACC,CAAD,CAAvC;AACA;;AACDA,QAAAA,CAAC;AACD;AACD,K,CAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;WAEA,4BAAmBA,CAAnB,EAAsBE,mBAAtB,EAA2C;AAC1C,aAAO,KAAKb,SAAL,CAAec,wBAAf,CAAwCH,CAAC,GAAGE,mBAA5C,CAAP;AACA;AAED;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;WACC,4BAAmBA,mBAAnB,EAAwCE,kBAAxC,EAA4D;AAC3D,6BAAI,0BAAJ,EAD2D,CAE3D;;AACA,UAAIF,mBAAmB,KAAKL,SAA5B,EAAuC;AACtC;AACA,OAL0D,CAM3D;AACA;AACA;AACA;AACA;;;AACA,UAAI,KAAKD,sBAAL,KAAgCC,SAApC,EAA+C;AAC9C,YACCK,mBAAmB,GAAG,KAAKJ,qBAAL,GAA6B,CAAnD,IACAM,kBAAkB,GAAG,KAAKR,sBAAL,GAA8B,CAFpD,EAGE;AACD;AACA,iCAAI,8EAAJ;AACA,eAAKF,KAAL;AACA;AACD;;AACD,UAAMW,gCAAgC,GAAG,EAAzC;AACA,UAAMC,8BAA8B,GAAG,KAAKV,sBAA5C;AACA,UAAMW,6BAA6B,GAAG,KAAKT,qBAA3C;AACA,UAAIU,oCAAoC,GAAG,KAA3C;AACA,UAAIR,CAAC,GAAGE,mBAAR;;AACA,aAAOF,CAAC,IAAII,kBAAZ,EAAgC;AAC/B;AACA;AACA;AACA;AACA;AACA;AACA,YAAI,KAAKZ,IAAL,CAAUQ,CAAV,MAAiBH,SAArB,EAAgC;AAC/BQ,UAAAA,gCAAgC,CAACI,IAAjC,CAAsCT,CAAtC;;AACA,cAAMU,MAAM,GAAG,KAAKC,kBAAL,CAAwBX,CAAxB,EAA2BE,mBAA3B,CAAf;;AACA,iCAAI,YAAJ,EAAkBF,CAAlB,EAAqB,QAArB,EAA+BU,MAA/B;;AACA,eAAKjB,IAAL,CAAUO,CAAV,EAAaU,MAAb,EAJ+B,CAK/B;AACA;AACA;AACA;AACA;;;AACA,cAAIJ,8BAA8B,KAAKT,SAAnC,IAAgDG,CAAC,GAAGM,8BAAxD,EAAwF;AACvF,iBAAKX,mBAAL,IAA4Be,MAA5B,CADuF,CAEvF;;AACA,gBAAI,CAACF,oCAAL,EAA2C;AAC1C;AACA,mBAAKZ,sBAAL,GAA8BI,CAA9B;AACAQ,cAAAA,oCAAoC,GAAG,IAAvC;AACA;AACD,WAlB8B,CAmB/B;AACA;AACA;AACA;AACA;;;AACA,cAAID,6BAA6B,KAAKV,SAAlC,IAA+CG,CAAC,GAAGO,6BAAvD,EAAsF;AACrF;AACA;AACA;AACA;AACA;AACA;AACA,gBAAIA,6BAA6B,KAAKV,SAAtC,EAAiD;AAChD;AACA,mBAAKF,mBAAL,IAA4Be,MAA5B;AACA,aAVoF,CAWrF;;;AACA,iBAAKZ,qBAAL,GAA6BE,CAA7B;AACA;AACD,SAtCD,MAsCO;AACN;AACA;AACA;AACA;AACA;AACA,cAAMY,cAAc,GAAG,KAAKpB,IAAL,CAAUQ,CAAV,CAAvB;;AACA,cAAMU,OAAM,GAAG,KAAKC,kBAAL,CAAwBX,CAAxB,EAA2BE,mBAA3B,CAAf;;AACA,cAAIU,cAAc,KAAKF,OAAvB,EAA+B;AAC9B,6BAAK,YAAL,EAAmBV,CAAnB,EAAsB,qCAAtB,EAA6DY,cAA7D,EAA6E,uBAA7E,EAAsGF,OAAtG,EAA8G,6gBAA9G,EAD8B,CAE9B;;AACA,iBAAKjB,IAAL,CAAUO,CAAV,EAAaU,OAAb;AACA;AACD;;AACDV,QAAAA,CAAC;AACD,OAtF0D,CAuF3D;AACA;;;AACA,aAAOK,gCAAP;AACA;AAED;AACD;AACA;AACA;AACA;;;;WACC,6BAAoBL,CAApB,EAAuBE,mBAAvB,EAA4C;AAC3C,UAAMU,cAAc,GAAG,KAAKpB,IAAL,CAAUQ,CAAV,CAAvB;;AACA,UAAMU,MAAM,GAAG,KAAKC,kBAAL,CAAwBX,CAAxB,EAA2BE,mBAA3B,CAAf,CAF2C,CAG3C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,WAAKT,IAAL,CAAUO,CAAV,EAAaU,MAAb;;AACA,WAAKf,mBAAL,IAA4Be,MAAM,GAAGE,cAArC;AACA,aAAOF,MAAP;AACA,K,CAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACD;AACA;AACA;;;;WACC,sBAAa;AACZ,UAAI,KAAKZ,qBAAL,KAA+BD,SAAnC,EAA8C;AAC7C,eAAO,CAAP;AACA;;AACD,aAAO,KAAKF,mBAAL,IAA4B,KAAKG,qBAAL,GAA6B,KAAKF,sBAAlC,GAA2D,CAAvF,CAAP;AACA;;;WAED,mBAAUiB,KAAV,EAAiB;AAChB,UAAI,KAAKjB,sBAAL,KAAgCC,SAApC,EAA+C;AAC9C,aAAKD,sBAAL,IAA+BiB,KAA/B;AACA,aAAKf,qBAAL,IAA8Be,KAA9B;AACA;AACD","sourcesContent":["import log, { warn, isDebug, reportError } from './utility/debug'\r\n\r\nexport default class ItemHeights {\r\n\tconstructor(container, getItemHeight, setItemHeight) {\r\n\t\tthis.container = container\r\n\t\tthis._get = getItemHeight\r\n\t\tthis._set = setItemHeight\r\n\t\tthis.reset()\r\n\t}\r\n\r\n\treset() {\r\n\t\tthis.measuredItemsHeight = 0\r\n\t\t// \"First measured item index\" variable was introduced\r\n\t\t// because it's not always `0`: when `virtualScroller.setItems()`\r\n\t\t// is called, some items might get prepended, in which case\r\n\t\t// `this.lastMeasuredItemIndex` is updated. If there was no\r\n\t\t// `this.firstMeasuredItemIndex`, then the average item height\r\n\t\t// calculated in `.getAverage()` would be incorrect in the timeframe\r\n\t\t// between `.setItems()` is called and those changes have been rendered.\r\n\t\t// And in that timeframe, `.getAverage()` is used to calculate the \"layout\":\r\n\t\t// stuff like \"before/after items height\" and \"estimated items count on screen\".\r\n\t\tthis.firstMeasuredItemIndex = undefined\r\n\t\tthis.lastMeasuredItemIndex = undefined\r\n\t}\r\n\r\n\t/**\r\n\t * Is called after `.reset()`.\r\n\t * Initializes `this.measuredItemsHeight`, `this.firstMeasuredItemIndex`\r\n\t * and `this.lastMeasuredItemIndex` instance variables from `VirtualScroller` `state`.\r\n\t * These instance variables are used when calculating \"average\" item height:\r\n\t * the \"average\" item height is simply `this.measuredItemsHeight` divided by\r\n\t * `this.lastMeasuredItemIndex` minus `this.firstMeasuredItemIndex` plus 1.\r\n\t */\r\n\tinitialize(itemHeights) {\r\n\t\tlet i = 0\r\n\t\twhile (i < itemHeights.length) {\r\n\t\t\tif (itemHeights[i] === undefined) {\r\n\t\t\t\tif (this.firstMeasuredItemIndex !== undefined) {\r\n\t\t\t\t\tthis.lastMeasuredItemIndex = i - 1\r\n\t\t\t\t\tbreak\r\n\t\t\t\t}\r\n\t\t\t} else {\r\n\t\t\t\tif (this.firstMeasuredItemIndex === undefined) {\r\n\t\t\t\t\tthis.firstMeasuredItemIndex = i\r\n\t\t\t\t}\r\n\t\t\t\tthis.measuredItemsHeight += itemHeights[i]\r\n\t\t\t}\r\n\t\t\ti++\r\n\t\t}\r\n\t}\r\n\r\n\t// Seems to be no longer used.\r\n\t// getItemHeight(i, firstShownItemIndex) {\r\n\t// \tif (this._get(i)) {\r\n\t// \t\treturn this._get(i)\r\n\t// \t}\r\n\t// \tconst itemHeight = this._measureItemHeight(i, firstShownItemIndex)\r\n\t// \tif (itemHeight) {\r\n\t// \t\tthis._set(i, itemHeight)\r\n\t// \t\treturn itemHeight\r\n\t// \t}\r\n\t// \treturn this.getAverage()\r\n\t// }\r\n\r\n\t_measureItemHeight(i, firstShownItemIndex) {\r\n\t\treturn this.container.getNthRenderedItemHeight(i - firstShownItemIndex)\r\n\t}\r\n\r\n\t/**\r\n\t * Measures item heights:\r\n\t *\r\n\t * * For the items that haven't been previously measured,\r\n\t * measures them for the first time.\r\n\t *\r\n\t * * For the items that have been previoulsy measured,\r\n\t * validate that their previously measured height\r\n\t * is still equal to their current height.\r\n\t * The unequalness may not necessarily be caused by\r\n\t * incorrect use of `virtual-scroller`: there are\r\n\t * also some valid use cases when such unequalness\r\n\t * could happen (see the comments in the code).\r\n\t *\r\n\t * @param {number} firstShownItemIndex\r\n\t * @param {number} lastShownItemIndex\r\n\t * @return {number[]} The indexes of the items that have not previously been measured and have been measured now.\r\n\t */\r\n\tmeasureItemHeights(firstShownItemIndex, lastShownItemIndex) {\r\n\t\tlog('~ Measure item heights ~')\r\n\t\t// If no items are rendered, don't measure anything.\r\n\t\tif (firstShownItemIndex === undefined) {\r\n\t\t\treturn\r\n\t\t}\r\n\t\t// Reset `this.measuredItemsHeight` if it's not a \"continuous\" measured items list:\r\n\t\t// if a group of items has been measured previously, and now it has rendered a completely\r\n\t\t// different group of items, and there's a non-measured \"gap\" between those two groups,\r\n\t\t// then reset `this.measuredItemsHeight` and \"first measured\"/\"last measured\" item indexes.\r\n\t\t// For example, this could happen when `.setItems()` prepends a lot of new items.\r\n\t\tif (this.firstMeasuredItemIndex !== undefined) {\r\n\t\t\tif (\r\n\t\t\t\tfirstShownItemIndex > this.lastMeasuredItemIndex + 1 ||\r\n\t\t\t\tlastShownItemIndex < this.firstMeasuredItemIndex - 1\r\n\t\t\t) {\r\n\t\t\t\t// Reset.\r\n\t\t\t\tlog('Non-measured items gap detected. Reset first and last measured item indexes.')\r\n\t\t\t\tthis.reset()\r\n\t\t\t}\r\n\t\t}\r\n\t\tconst nonPreviouslyMeasuredItemIndexes = []\r\n\t\tconst previousFirstMeasuredItemIndex = this.firstMeasuredItemIndex\r\n\t\tconst previousLastMeasuredItemIndex = this.lastMeasuredItemIndex\r\n\t\tlet firstMeasuredItemIndexHasBeenUpdated = false\r\n\t\tlet i = firstShownItemIndex\r\n\t\twhile (i <= lastShownItemIndex) {\r\n\t\t\t// Measure item heights that haven't been measured previously.\r\n\t\t\t// Don't re-measure item heights that have been measured previously.\r\n\t\t\t// The rationale is that developers are supposed to manually call\r\n\t\t\t// `.onItemHeightChange()` every time an item's height changes.\r\n\t\t\t// If developers don't neglect that rule, item heights won't\r\n\t\t\t// change unexpectedly.\r\n\t\t\tif (this._get(i) === undefined) {\r\n\t\t\t\tnonPreviouslyMeasuredItemIndexes.push(i)\r\n\t\t\t\tconst height = this._measureItemHeight(i, firstShownItemIndex)\r\n\t\t\t\tlog('Item index', i, 'height', height)\r\n\t\t\t\tthis._set(i, height)\r\n\t\t\t\t// Update average item height calculation variables\r\n\t\t\t\t// related to the previously measured items\r\n\t\t\t\t// that're above the items currently being shown.\r\n\t\t\t\t// It is known to be a \"continuous\" measured items list,\r\n\t\t\t\t// because the code at the start of this function checks that.\r\n\t\t\t\tif (previousFirstMeasuredItemIndex === undefined || i < previousFirstMeasuredItemIndex) {\r\n\t\t\t\t\tthis.measuredItemsHeight += height\r\n\t\t\t\t\t// Update first measured item index.\r\n\t\t\t\t\tif (!firstMeasuredItemIndexHasBeenUpdated) {\r\n\t\t\t\t\t\t// log('Set first measured item index', i)\r\n\t\t\t\t\t\tthis.firstMeasuredItemIndex = i\r\n\t\t\t\t\t\tfirstMeasuredItemIndexHasBeenUpdated = true\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t\t// Update average item height calculation variables\r\n\t\t\t\t// related to the previously measured items\r\n\t\t\t\t// that're below the items currently being shown.\r\n\t\t\t\t// It is known to be a \"continuous\" measured items list,\r\n\t\t\t\t// because the code at the start of this function checks that.\r\n\t\t\t\tif (previousLastMeasuredItemIndex === undefined || i > previousLastMeasuredItemIndex) {\r\n\t\t\t\t\t// If `previousLastMeasuredItemIndex` is `undefined`\r\n\t\t\t\t\t// then `previousFirstMeasuredItemIndex` is also `undefined`\r\n\t\t\t\t\t// which means that the item's `height` has already been added\r\n\t\t\t\t\t// to `this.measuredItemsHeight` in the code above,\r\n\t\t\t\t\t// so this condition guards against counting the item's `height`\r\n\t\t\t\t\t// twice in `this.measuredItemsHeight`.\r\n\t\t\t\t\tif (previousLastMeasuredItemIndex !== undefined) {\r\n\t\t\t\t\t\t// Add newly shown item height.\r\n\t\t\t\t\t\tthis.measuredItemsHeight += height\r\n\t\t\t\t\t}\r\n\t\t\t\t\t// Update last measured item index.\r\n\t\t\t\t\tthis.lastMeasuredItemIndex = i\r\n\t\t\t\t}\r\n\t\t\t} else {\r\n\t\t\t\t// Validate that the item's height didn't change since it was last measured.\r\n\t\t\t\t// If it did, then display a warning and update the item's height\r\n\t\t\t\t// as an attempt to fix things.\r\n\t\t\t\t// If an item's height changes unexpectedly then it means that there'll\r\n\t\t\t\t// likely be \"content jumping\".\r\n\t\t\t\tconst previousHeight = this._get(i)\r\n\t\t\t\tconst height = this._measureItemHeight(i, firstShownItemIndex)\r\n\t\t\t\tif (previousHeight !== height) {\r\n\t\t\t\t\twarn('Item index', i, 'height changed unexpectedly: it was', previousHeight, 'before, but now it is', height, '. An item\\'s height is allowed to change only in two cases: when the item\\'s \"state\" changes and the developer calls `onItemStateChange(i, newState)`, or when the item\\'s height changes for some other reason and the developer calls `onItemHeightChange(i)`. Perhaps you forgot to persist the item\\'s \"state\" by calling `onItemStateChange(i, newState)` when it changed, and that \"state\" got lost when the item element was unmounted, which resulted in a different height when the item was shown again having its \"state\" reset.')\r\n\t\t\t\t\t// Update the item's height as an attempt to fix things.\r\n\t\t\t\t\tthis._set(i, height)\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t\ti++\r\n\t\t}\r\n\t\t// // Update average item height.\r\n\t\t// this.updateAverageItemHeight()\r\n\t\treturn nonPreviouslyMeasuredItemIndexes\r\n\t}\r\n\r\n\t/**\r\n\t * Re-measures item height.\r\n\t * @param {number} i — Item index.\r\n\t * @param {number} firstShownItemIndex\r\n\t */\r\n\tremeasureItemHeight(i, firstShownItemIndex) {\r\n\t\tconst previousHeight = this._get(i)\r\n\t\tconst height = this._measureItemHeight(i, firstShownItemIndex)\r\n\t\t// // Because this function is called from `.onItemHeightChange()`,\r\n\t\t// // there're no guarantees in which circumstances a developer calls it,\r\n\t\t// // and for which item indexes.\r\n\t\t// // Therefore, to guard against cases of incorrect usage,\r\n\t\t// // this function won't crash anything if the item isn't rendered\r\n\t\t// // or hasn't been previously rendered.\r\n\t\t// if (height !== undefined) {\r\n\t\t// \treportError(`\"onItemHeightChange()\" has been called for item ${i}, but that item isn't rendered.`)\r\n\t\t// \treturn\r\n\t\t// }\r\n\t\t// if (previousHeight === undefined) {\r\n\t\t// \treportError(`\"onItemHeightChange()\" has been called for item ${i}, but that item hasn't been rendered before.`)\r\n\t\t// \treturn\r\n\t\t// }\r\n\t\tthis._set(i, height)\r\n\t\tthis.measuredItemsHeight += height - previousHeight\r\n\t\treturn height\r\n\t}\r\n\r\n\t// /**\r\n\t// * \"Average\" item height is stored as an instance variable.\r\n\t// * For example, for caching, so that it isn't calculated every time it's requested.\r\n\t// * But that would be negligible performance gain, not really worth the extra code.\r\n\t// * Another thing it's stored for as an instance variable is\r\n\t// * keeping \"previous\" \"average\" item height, because it can be more precise\r\n\t// * than the newly calculated \"average\" item height, provided it had\r\n\t// * more \"samples\" (measured items). The newly calculated average item height\r\n\t// * could get less samples in a scenario when the scroll somehow jumps\r\n\t// * from one position to some other distant position: in that case previous\r\n\t// * \"total measured items height\" is discarded and the new one is initialized.\r\n\t// * Could such situation happen in real life? I guess, it's unlikely.\r\n\t// * So I'm commenting out this code, but still keeping it just in case.\r\n\t// */\r\n\t// updateAverageItemHeight() {\r\n\t// \tthis.averageItemHeightSamplesCount = this.lastMeasuredItemIndex - this.firstMeasuredItemIndex + 1\r\n\t// \tthis.averageItemHeight = this.measuredItemsHeight / this.averageItemHeightSamplesCount\r\n\t// }\r\n\t//\r\n\t// /**\r\n\t// * Public API: is called by `VirtualScroller`.\r\n\t// * @return {number}\r\n\t// */\r\n\t// getAverage() {\r\n\t// \t// Previously measured average item height might still be\r\n\t// \t// more precise if it contains more measured items (\"samples\").\r\n\t// \tif (this.previousAverageItemHeight) {\r\n\t// \t\tif (this.previousAverageItemHeightSamplesCount > this.averageItemHeightSamplesCount) {\r\n\t// \t\t\treturn this.previousAverageItemHeight\r\n\t// \t\t}\r\n\t// \t}\r\n\t// \treturn this.averageItemHeight || 0\r\n\t// }\r\n\r\n\t/**\r\n\t * Public API: is called by `VirtualScroller`.\r\n\t * @return {number}\r\n\t */\r\n\tgetAverage() {\r\n\t\tif (this.lastMeasuredItemIndex === undefined) {\r\n\t\t\treturn 0\r\n\t\t}\r\n\t\treturn this.measuredItemsHeight / (this.lastMeasuredItemIndex - this.firstMeasuredItemIndex + 1)\r\n\t}\r\n\r\n\tonPrepend(count) {\r\n\t\tif (this.firstMeasuredItemIndex !== undefined) {\r\n\t\t\tthis.firstMeasuredItemIndex += count\r\n\t\t\tthis.lastMeasuredItemIndex += count\r\n\t\t}\r\n\t}\r\n}"],"file":"ItemHeights.js"}
|