List.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = void 0;
  7. var _vue = require("vue");
  8. var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
  9. var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
  10. var _objectSpread3 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
  11. var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
  12. var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
  13. var _Filler = _interopRequireDefault(require("./Filler"));
  14. var _Item = _interopRequireDefault(require("./Item"));
  15. var _ScrollBar = _interopRequireDefault(require("./ScrollBar"));
  16. var _useHeights3 = _interopRequireDefault(require("./hooks/useHeights"));
  17. var _useScrollTo = _interopRequireDefault(require("./hooks/useScrollTo"));
  18. var _useFrameWheel3 = _interopRequireDefault(require("./hooks/useFrameWheel"));
  19. var _useMobileTouchMove = _interopRequireDefault(require("./hooks/useMobileTouchMove"));
  20. var _useOriginScroll = _interopRequireDefault(require("./hooks/useOriginScroll"));
  21. var _vueTypes = _interopRequireDefault(require("../_util/vue-types"));
  22. var _classNames = _interopRequireDefault(require("../_util/classNames"));
  23. var _supportsPassive = _interopRequireDefault(require("../_util/supportsPassive"));
  24. var _excluded = ["prefixCls", "height", "itemHeight", "fullHeight", "data", "itemKey", "virtual", "component", "onScroll", "children", "style", "class"];
  25. var EMPTY_DATA = [];
  26. var ScrollStyle = {
  27. overflowY: 'auto',
  28. overflowAnchor: 'none'
  29. };
  30. function renderChildren(list, startIndex, endIndex, setNodeRef, renderFunc, _ref) {
  31. var getKey = _ref.getKey;
  32. return list.slice(startIndex, endIndex + 1).map(function (item, index) {
  33. var eleIndex = startIndex + index;
  34. var node = renderFunc(item, eleIndex, {
  35. // style: status === 'MEASURE_START' ? { visibility: 'hidden' } : {},
  36. });
  37. var key = getKey(item);
  38. return (0, _vue.createVNode)(_Item.default, {
  39. "key": key,
  40. "setRef": function setRef(ele) {
  41. return setNodeRef(item, ele);
  42. }
  43. }, {
  44. default: function _default() {
  45. return [node];
  46. }
  47. });
  48. });
  49. }
  50. var List = (0, _vue.defineComponent)({
  51. compatConfig: {
  52. MODE: 3
  53. },
  54. name: 'List',
  55. inheritAttrs: false,
  56. props: {
  57. prefixCls: String,
  58. data: _vueTypes.default.array,
  59. height: Number,
  60. itemHeight: Number,
  61. /** If not match virtual scroll condition, Set List still use height of container. */
  62. fullHeight: {
  63. type: Boolean,
  64. default: undefined
  65. },
  66. itemKey: {
  67. type: [String, Number, Function],
  68. required: true
  69. },
  70. component: {
  71. type: [String, Object]
  72. },
  73. /** Set `false` will always use real scroll instead of virtual one */
  74. virtual: {
  75. type: Boolean,
  76. default: undefined
  77. },
  78. children: Function,
  79. onScroll: Function,
  80. onMousedown: Function,
  81. onMouseenter: Function,
  82. onVisibleChange: Function
  83. },
  84. setup: function setup(props, _ref2) {
  85. var expose = _ref2.expose;
  86. // ================================= MISC =================================
  87. var useVirtual = (0, _vue.computed)(function () {
  88. var height = props.height,
  89. itemHeight = props.itemHeight,
  90. virtual = props.virtual;
  91. return !!(virtual !== false && height && itemHeight);
  92. });
  93. var inVirtual = (0, _vue.computed)(function () {
  94. var height = props.height,
  95. itemHeight = props.itemHeight,
  96. data = props.data;
  97. return useVirtual.value && data && itemHeight * data.length > height;
  98. });
  99. var state = (0, _vue.reactive)({
  100. scrollTop: 0,
  101. scrollMoving: false
  102. });
  103. var data = (0, _vue.computed)(function () {
  104. return props.data || EMPTY_DATA;
  105. });
  106. var mergedData = (0, _vue.shallowRef)([]);
  107. (0, _vue.watch)(data, function () {
  108. mergedData.value = (0, _vue.toRaw)(data.value).slice();
  109. }, {
  110. immediate: true
  111. });
  112. // eslint-disable-next-line @typescript-eslint/no-unused-vars
  113. var itemKey = (0, _vue.shallowRef)(function (_item) {
  114. return undefined;
  115. });
  116. (0, _vue.watch)(function () {
  117. return props.itemKey;
  118. }, function (val) {
  119. if (typeof val === 'function') {
  120. itemKey.value = val;
  121. } else {
  122. itemKey.value = function (item) {
  123. return item === null || item === void 0 ? void 0 : item[val];
  124. };
  125. }
  126. }, {
  127. immediate: true
  128. });
  129. var componentRef = (0, _vue.ref)();
  130. var fillerInnerRef = (0, _vue.ref)();
  131. var scrollBarRef = (0, _vue.ref)(); // Hack on scrollbar to enable flash call
  132. // =============================== Item Key ===============================
  133. var getKey = function getKey(item) {
  134. return itemKey.value(item);
  135. };
  136. var sharedConfig = {
  137. getKey: getKey
  138. };
  139. // ================================ Scroll ================================
  140. function syncScrollTop(newTop) {
  141. var value;
  142. if (typeof newTop === 'function') {
  143. value = newTop(state.scrollTop);
  144. } else {
  145. value = newTop;
  146. }
  147. var alignedTop = keepInRange(value);
  148. if (componentRef.value) {
  149. componentRef.value.scrollTop = alignedTop;
  150. }
  151. state.scrollTop = alignedTop;
  152. }
  153. // ================================ Height ================================
  154. var _useHeights = (0, _useHeights3.default)(mergedData, getKey, null, null),
  155. _useHeights2 = (0, _slicedToArray2.default)(_useHeights, 4),
  156. setInstance = _useHeights2[0],
  157. collectHeight = _useHeights2[1],
  158. heights = _useHeights2[2],
  159. updatedMark = _useHeights2[3];
  160. var calRes = (0, _vue.reactive)({
  161. scrollHeight: undefined,
  162. start: 0,
  163. end: 0,
  164. offset: undefined
  165. });
  166. var offsetHeight = (0, _vue.ref)(0);
  167. (0, _vue.onMounted)(function () {
  168. (0, _vue.nextTick)(function () {
  169. var _fillerInnerRef$value;
  170. offsetHeight.value = ((_fillerInnerRef$value = fillerInnerRef.value) === null || _fillerInnerRef$value === void 0 ? void 0 : _fillerInnerRef$value.offsetHeight) || 0;
  171. });
  172. });
  173. (0, _vue.onUpdated)(function () {
  174. (0, _vue.nextTick)(function () {
  175. var _fillerInnerRef$value2;
  176. offsetHeight.value = ((_fillerInnerRef$value2 = fillerInnerRef.value) === null || _fillerInnerRef$value2 === void 0 ? void 0 : _fillerInnerRef$value2.offsetHeight) || 0;
  177. });
  178. });
  179. (0, _vue.watch)([useVirtual, mergedData], function () {
  180. if (!useVirtual.value) {
  181. (0, _extends2.default)(calRes, {
  182. scrollHeight: undefined,
  183. start: 0,
  184. end: mergedData.value.length - 1,
  185. offset: undefined
  186. });
  187. }
  188. }, {
  189. immediate: true
  190. });
  191. (0, _vue.watch)([useVirtual, mergedData, offsetHeight, inVirtual], function () {
  192. // Always use virtual scroll bar in avoid shaking
  193. if (useVirtual.value && !inVirtual.value) {
  194. (0, _extends2.default)(calRes, {
  195. scrollHeight: offsetHeight.value,
  196. start: 0,
  197. end: mergedData.value.length - 1,
  198. offset: undefined
  199. });
  200. }
  201. }, {
  202. immediate: true
  203. });
  204. (0, _vue.watch)([inVirtual, useVirtual, function () {
  205. return state.scrollTop;
  206. }, mergedData, updatedMark, function () {
  207. return props.height;
  208. }, offsetHeight], function () {
  209. if (!useVirtual.value || !inVirtual.value) {
  210. return;
  211. }
  212. var itemTop = 0;
  213. var startIndex;
  214. var startOffset;
  215. var endIndex;
  216. var dataLen = mergedData.value.length;
  217. var data = mergedData.value;
  218. var scrollTop = state.scrollTop;
  219. var itemHeight = props.itemHeight,
  220. height = props.height;
  221. var scrollTopHeight = scrollTop + height;
  222. for (var i = 0; i < dataLen; i += 1) {
  223. var item = data[i];
  224. var key = getKey(item);
  225. var cacheHeight = heights.get(key);
  226. if (cacheHeight === undefined) {
  227. cacheHeight = itemHeight;
  228. }
  229. var currentItemBottom = itemTop + cacheHeight;
  230. if (startIndex === undefined && currentItemBottom >= scrollTop) {
  231. startIndex = i;
  232. startOffset = itemTop;
  233. }
  234. // Check item bottom in the range. We will render additional one item for motion usage
  235. if (endIndex === undefined && currentItemBottom > scrollTopHeight) {
  236. endIndex = i;
  237. }
  238. itemTop = currentItemBottom;
  239. }
  240. // Fallback to normal if not match. This code should never reach
  241. /* istanbul ignore next */
  242. if (startIndex === undefined) {
  243. startIndex = 0;
  244. startOffset = 0;
  245. }
  246. if (endIndex === undefined) {
  247. endIndex = dataLen - 1;
  248. }
  249. // Give cache to improve scroll experience
  250. endIndex = Math.min(endIndex + 1, dataLen);
  251. (0, _extends2.default)(calRes, {
  252. scrollHeight: itemTop,
  253. start: startIndex,
  254. end: endIndex,
  255. offset: startOffset
  256. });
  257. }, {
  258. immediate: true
  259. });
  260. // =============================== In Range ===============================
  261. var maxScrollHeight = (0, _vue.computed)(function () {
  262. return calRes.scrollHeight - props.height;
  263. });
  264. function keepInRange(newScrollTop) {
  265. var newTop = newScrollTop;
  266. if (!Number.isNaN(maxScrollHeight.value)) {
  267. newTop = Math.min(newTop, maxScrollHeight.value);
  268. }
  269. newTop = Math.max(newTop, 0);
  270. return newTop;
  271. }
  272. var isScrollAtTop = (0, _vue.computed)(function () {
  273. return state.scrollTop <= 0;
  274. });
  275. var isScrollAtBottom = (0, _vue.computed)(function () {
  276. return state.scrollTop >= maxScrollHeight.value;
  277. });
  278. var originScroll = (0, _useOriginScroll.default)(isScrollAtTop, isScrollAtBottom);
  279. // ================================ Scroll ================================
  280. function onScrollBar(newScrollTop) {
  281. var newTop = newScrollTop;
  282. syncScrollTop(newTop);
  283. }
  284. // When data size reduce. It may trigger native scroll event back to fit scroll position
  285. function onFallbackScroll(e) {
  286. var _props$onScroll;
  287. var newScrollTop = e.currentTarget.scrollTop;
  288. if (Math.abs(newScrollTop - state.scrollTop) >= 1) {
  289. syncScrollTop(newScrollTop);
  290. }
  291. // Trigger origin onScroll
  292. (_props$onScroll = props.onScroll) === null || _props$onScroll === void 0 ? void 0 : _props$onScroll.call(props, e);
  293. }
  294. // Since this added in global,should use ref to keep update
  295. var _useFrameWheel = (0, _useFrameWheel3.default)(useVirtual, isScrollAtTop, isScrollAtBottom, function (offsetY) {
  296. syncScrollTop(function (top) {
  297. var newTop = top + offsetY;
  298. return newTop;
  299. });
  300. }),
  301. _useFrameWheel2 = (0, _slicedToArray2.default)(_useFrameWheel, 2),
  302. onRawWheel = _useFrameWheel2[0],
  303. onFireFoxScroll = _useFrameWheel2[1];
  304. // Mobile touch move
  305. (0, _useMobileTouchMove.default)(useVirtual, componentRef, function (deltaY, smoothOffset) {
  306. if (originScroll(deltaY, smoothOffset)) {
  307. return false;
  308. }
  309. onRawWheel({
  310. preventDefault: function preventDefault() {},
  311. deltaY: deltaY
  312. });
  313. return true;
  314. });
  315. // Firefox only
  316. function onMozMousePixelScroll(e) {
  317. if (useVirtual.value) {
  318. e.preventDefault();
  319. }
  320. }
  321. var removeEventListener = function removeEventListener() {
  322. if (componentRef.value) {
  323. componentRef.value.removeEventListener('wheel', onRawWheel, _supportsPassive.default ? {
  324. passive: false
  325. } : false);
  326. componentRef.value.removeEventListener('DOMMouseScroll', onFireFoxScroll);
  327. componentRef.value.removeEventListener('MozMousePixelScroll', onMozMousePixelScroll);
  328. }
  329. };
  330. (0, _vue.watchEffect)(function () {
  331. (0, _vue.nextTick)(function () {
  332. if (componentRef.value) {
  333. removeEventListener();
  334. componentRef.value.addEventListener('wheel', onRawWheel, _supportsPassive.default ? {
  335. passive: false
  336. } : false);
  337. componentRef.value.addEventListener('DOMMouseScroll', onFireFoxScroll);
  338. componentRef.value.addEventListener('MozMousePixelScroll', onMozMousePixelScroll);
  339. }
  340. });
  341. });
  342. (0, _vue.onBeforeUnmount)(function () {
  343. removeEventListener();
  344. });
  345. // ================================= Ref ==================================
  346. var scrollTo = (0, _useScrollTo.default)(componentRef, mergedData, heights, props, getKey, collectHeight, syncScrollTop, function () {
  347. var _scrollBarRef$value;
  348. (_scrollBarRef$value = scrollBarRef.value) === null || _scrollBarRef$value === void 0 ? void 0 : _scrollBarRef$value.delayHidden();
  349. });
  350. expose({
  351. scrollTo: scrollTo
  352. });
  353. var componentStyle = (0, _vue.computed)(function () {
  354. var cs = null;
  355. if (props.height) {
  356. cs = (0, _objectSpread3.default)((0, _defineProperty2.default)({}, props.fullHeight ? 'height' : 'maxHeight', props.height + 'px'), ScrollStyle);
  357. if (useVirtual.value) {
  358. cs.overflowY = 'hidden';
  359. if (state.scrollMoving) {
  360. cs.pointerEvents = 'none';
  361. }
  362. }
  363. }
  364. return cs;
  365. });
  366. // ================================ Effect ================================
  367. /** We need told outside that some list not rendered */
  368. (0, _vue.watch)([function () {
  369. return calRes.start;
  370. }, function () {
  371. return calRes.end;
  372. }, mergedData], function () {
  373. if (props.onVisibleChange) {
  374. var renderList = mergedData.value.slice(calRes.start, calRes.end + 1);
  375. props.onVisibleChange(renderList, mergedData.value);
  376. }
  377. }, {
  378. flush: 'post'
  379. });
  380. return {
  381. state: state,
  382. mergedData: mergedData,
  383. componentStyle: componentStyle,
  384. onFallbackScroll: onFallbackScroll,
  385. onScrollBar: onScrollBar,
  386. componentRef: componentRef,
  387. useVirtual: useVirtual,
  388. calRes: calRes,
  389. collectHeight: collectHeight,
  390. setInstance: setInstance,
  391. sharedConfig: sharedConfig,
  392. scrollBarRef: scrollBarRef,
  393. fillerInnerRef: fillerInnerRef
  394. };
  395. },
  396. render: function render() {
  397. var _this = this;
  398. var _this$$props$this$$at = (0, _objectSpread3.default)((0, _objectSpread3.default)({}, this.$props), this.$attrs),
  399. _this$$props$this$$at2 = _this$$props$this$$at.prefixCls,
  400. prefixCls = _this$$props$this$$at2 === void 0 ? 'rc-virtual-list' : _this$$props$this$$at2,
  401. height = _this$$props$this$$at.height,
  402. itemHeight = _this$$props$this$$at.itemHeight,
  403. fullHeight = _this$$props$this$$at.fullHeight,
  404. data = _this$$props$this$$at.data,
  405. itemKey = _this$$props$this$$at.itemKey,
  406. virtual = _this$$props$this$$at.virtual,
  407. _this$$props$this$$at3 = _this$$props$this$$at.component,
  408. Component = _this$$props$this$$at3 === void 0 ? 'div' : _this$$props$this$$at3,
  409. onScroll = _this$$props$this$$at.onScroll,
  410. _this$$props$this$$at4 = _this$$props$this$$at.children,
  411. children = _this$$props$this$$at4 === void 0 ? this.$slots.default : _this$$props$this$$at4,
  412. style = _this$$props$this$$at.style,
  413. className = _this$$props$this$$at.class,
  414. restProps = (0, _objectWithoutProperties2.default)(_this$$props$this$$at, _excluded);
  415. var mergedClassName = (0, _classNames.default)(prefixCls, className);
  416. var scrollTop = this.state.scrollTop;
  417. var _this$calRes = this.calRes,
  418. scrollHeight = _this$calRes.scrollHeight,
  419. offset = _this$calRes.offset,
  420. start = _this$calRes.start,
  421. end = _this$calRes.end;
  422. var componentStyle = this.componentStyle,
  423. onFallbackScroll = this.onFallbackScroll,
  424. onScrollBar = this.onScrollBar,
  425. useVirtual = this.useVirtual,
  426. collectHeight = this.collectHeight,
  427. sharedConfig = this.sharedConfig,
  428. setInstance = this.setInstance,
  429. mergedData = this.mergedData;
  430. return (0, _vue.createVNode)("div", (0, _objectSpread3.default)({
  431. "style": (0, _objectSpread3.default)((0, _objectSpread3.default)({}, style), {}, {
  432. position: 'relative'
  433. }),
  434. "class": mergedClassName
  435. }, restProps), [(0, _vue.createVNode)(Component, {
  436. "class": "".concat(prefixCls, "-holder"),
  437. "style": componentStyle,
  438. "ref": "componentRef",
  439. "onScroll": onFallbackScroll
  440. }, {
  441. default: function _default() {
  442. return [(0, _vue.createVNode)(_Filler.default, {
  443. "prefixCls": prefixCls,
  444. "height": scrollHeight,
  445. "offset": offset,
  446. "onInnerResize": collectHeight,
  447. "ref": "fillerInnerRef"
  448. }, {
  449. default: function _default() {
  450. return renderChildren(mergedData, start, end, setInstance, children, sharedConfig);
  451. }
  452. })];
  453. }
  454. }), useVirtual && (0, _vue.createVNode)(_ScrollBar.default, {
  455. "ref": "scrollBarRef",
  456. "prefixCls": prefixCls,
  457. "scrollTop": scrollTop,
  458. "height": height,
  459. "scrollHeight": scrollHeight,
  460. "count": mergedData.length,
  461. "onScroll": onScrollBar,
  462. "onStartMove": function onStartMove() {
  463. _this.state.scrollMoving = true;
  464. },
  465. "onStopMove": function onStopMove() {
  466. _this.state.scrollMoving = false;
  467. }
  468. }, null)]);
  469. }
  470. });
  471. var _default2 = List;
  472. exports.default = _default2;