@cleartrip/ct-design-list 4.0.0-SNAPSHOT-test.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +63 -0
- package/dist/List.d.ts +8 -0
- package/dist/List.d.ts.map +1 -0
- package/dist/List.native.d.ts +8 -0
- package/dist/List.native.d.ts.map +1 -0
- package/dist/ListItemContext.d.ts +12 -0
- package/dist/ListItemContext.d.ts.map +1 -0
- package/dist/ct-design-list.browser.cjs.js +2 -0
- package/dist/ct-design-list.browser.cjs.js.map +1 -0
- package/dist/ct-design-list.browser.esm.js +2 -0
- package/dist/ct-design-list.browser.esm.js.map +1 -0
- package/dist/ct-design-list.cjs.js +57 -0
- package/dist/ct-design-list.cjs.js.map +1 -0
- package/dist/ct-design-list.esm.js +49 -0
- package/dist/ct-design-list.esm.js.map +1 -0
- package/dist/ct-design-list.umd.js +58 -0
- package/dist/ct-design-list.umd.js.map +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.native.d.ts +4 -0
- package/dist/index.native.d.ts.map +1 -0
- package/dist/type.d.ts +56 -0
- package/dist/type.d.ts.map +1 -0
- package/dist/utils.d.ts +2 -0
- package/dist/utils.d.ts.map +1 -0
- package/package.json +61 -0
- package/src/List.native.tsx +317 -0
- package/src/List.tsx +109 -0
- package/src/ListItemContext.tsx +33 -0
- package/src/index.native.ts +3 -0
- package/src/index.ts +3 -0
- package/src/type.ts +129 -0
- package/src/utils.ts +12 -0
package/README.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# List
|
|
2
|
+
|
|
3
|
+
A list component for displaying collections of items.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @cleartrip/ct-design-list
|
|
11
|
+
# or
|
|
12
|
+
pnpm add @cleartrip/ct-design-list
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Peer dependencies
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Required for all targets
|
|
19
|
+
npm install react
|
|
20
|
+
|
|
21
|
+
# Web only
|
|
22
|
+
npm install react-dom
|
|
23
|
+
|
|
24
|
+
# React Native only
|
|
25
|
+
npm install react-native
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
### Basic
|
|
33
|
+
|
|
34
|
+
```tsx
|
|
35
|
+
import { List } from '@cleartrip/ct-design-list';
|
|
36
|
+
|
|
37
|
+
function Example() {
|
|
38
|
+
return (
|
|
39
|
+
<List>
|
|
40
|
+
{/* Basic usage */}
|
|
41
|
+
</List>
|
|
42
|
+
);
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Accessibility
|
|
49
|
+
|
|
50
|
+
- The component follows accessibility best practices
|
|
51
|
+
- Ensure proper ARIA attributes are provided where needed
|
|
52
|
+
- Test with screen readers to ensure usability
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Migration
|
|
57
|
+
|
|
58
|
+
If migrating from a previous version:
|
|
59
|
+
|
|
60
|
+
```diff
|
|
61
|
+
- import { List } from 'yagami/core/components';
|
|
62
|
+
+ import { List } from '@cleartrip/ct-design-list';
|
|
63
|
+
```
|
package/dist/List.d.ts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { IVariableSizedListProps, ListRef } from './type';
|
|
2
|
+
declare const List: <T, U extends {
|
|
3
|
+
data: T[];
|
|
4
|
+
}>(props: IVariableSizedListProps<T, U> & {
|
|
5
|
+
ref?: React.Ref<ListRef>;
|
|
6
|
+
}) => React.JSX.Element;
|
|
7
|
+
export default List;
|
|
8
|
+
//# sourceMappingURL=List.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"List.d.ts","sourceRoot":"","sources":["../packages/components/List/src/List.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAS1D,QAAA,MAAM,IAAI,EAwFM,CAAC,CAAC,EAAE,CAAC,SAAS;IAAE,IAAI,EAAE,CAAC,EAAE,CAAA;CAAE,EACzC,KAAK,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;CAAE,KAChE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC;AAIvB,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { IVariableSizedListProps, ListRef } from './type';
|
|
2
|
+
declare const List: <T, U extends {
|
|
3
|
+
data: T[];
|
|
4
|
+
}>(props: IVariableSizedListProps<T, U> & {
|
|
5
|
+
ref?: React.Ref<ListRef>;
|
|
6
|
+
}) => React.JSX.Element;
|
|
7
|
+
export default List;
|
|
8
|
+
//# sourceMappingURL=List.native.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"List.native.d.ts","sourceRoot":"","sources":["../packages/components/List/src/List.native.tsx"],"names":[],"mappings":"AAOA,OAAO,EAA0B,uBAAuB,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AA8ClF,QAAA,MAAM,IAAI,EAiQM,CAAC,CAAC,EAAE,CAAC,SAAS;IAAE,IAAI,EAAE,CAAC,EAAE,CAAA;CAAE,EACzC,KAAK,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;CAAE,KAChE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC;AAIvB,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { FC, ReactNode } from 'react';
|
|
2
|
+
interface ListItemContextType {
|
|
3
|
+
listId: number;
|
|
4
|
+
}
|
|
5
|
+
interface ListItemProviderProps {
|
|
6
|
+
children: ReactNode;
|
|
7
|
+
listId: number;
|
|
8
|
+
}
|
|
9
|
+
export declare const ListItemProvider: FC<ListItemProviderProps>;
|
|
10
|
+
export declare const useListItem: () => ListItemContextType;
|
|
11
|
+
export {};
|
|
12
|
+
//# sourceMappingURL=ListItemContext.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ListItemContext.d.ts","sourceRoot":"","sources":["../packages/components/List/src/ListItemContext.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,EAAE,EAAE,SAAS,EAAc,MAAM,OAAO,CAAC;AAOjE,UAAU,mBAAmB;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAID,UAAU,qBAAqB;IAC7B,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,eAAO,MAAM,gBAAgB,EAAE,EAAE,CAAC,qBAAqB,CAEtD,CAAC;AAMF,eAAO,MAAM,WAAW,2BAMvB,CAAC"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";var e=require("react/jsx-runtime"),t=require("react"),i=require("react-window");function r(e){return e&&e.__esModule?e:{default:e}}var o=r(require("react-window-infinite-loader"));const l=t.memo(t.forwardRef(({loadMoreItems:r,data:l,minimumBatchSize:s,threshold:n,itemCount:a,itemSize:d,itemData:c,RenderItem:u,height:m,width:h,style:f,outerElementType:x,overScanCount:I,onScroll:S},v)=>{const p=t.useRef(null),C=t.useCallback(({data:t,index:i})=>e.jsx(u,{item:t.data[i],index:i,itemData:c,isVisible:!1}),[]);return e.jsx(o.default,{isItemLoaded:e=>e<l.length,itemCount:a,loadMoreItems:r,minimumBatchSize:s,threshold:n,children:({onItemsRendered:t})=>e.jsx(i.VariableSizeList,{height:m,width:h,itemCount:a,itemSize:d,itemData:c,ref:p,style:f,outerElementType:x,overscanCount:I,useIsScrolling:!0,onItemsRendered:e=>{t(e)},onScroll:e=>{null==S||S({currentTarget:{scrollTop:e.scrollOffset,scrollLeft:0,scrollHeight:0,scrollWidth:0,clientHeight:0,clientWidth:0,offsetLeft:0,offsetTop:0,horizontalScrollVelocity:0}})},children:C})})}));l.displayName="List";const s=t.createContext(void 0);exports.List=l,exports.ListItemProvider=({children:t,listId:i})=>e.jsx(s.Provider,{value:{listId:i},children:t}),exports.useListItem=()=>{const e=t.useContext(s);return void 0===e?{listId:-1}:e};
|
|
2
|
+
//# sourceMappingURL=ct-design-list.browser.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ct-design-list.browser.cjs.js","sources":["../packages/components/List/src/List.tsx","../packages/components/List/src/ListItemContext.tsx"],"sourcesContent":[null,null],"names":["List","memo","forwardRef","loadMoreItems","data","minimumBatchSize","threshold","itemCount","itemSize","itemData","RenderItem","height","width","style","outerElementType","overScanCount","onScroll","_forwardedRef","listRef","useRef","RenderListItem","useCallback","listData","index","_jsx","item","isVisible","InfiniteLoader","isItemLoaded","length","children","onItemsRendered","ReactWindowList","ref","overscanCount","useIsScrolling","params","e","currentTarget","scrollTop","scrollOffset","scrollLeft","scrollHeight","scrollWidth","clientHeight","clientWidth","offsetLeft","offsetTop","horizontalScrollVelocity","displayName","ListItemContext","createContext","undefined","listId","jsx","Provider","value","context","useContext"],"mappings":"iMAcA,MAAMA,EAAOC,EAAAA,KACXC,EAAAA,WACE,EAEIC,gBACAC,OACAC,mBACAC,YACAC,YACAC,WACAC,WACAC,aACAC,SACAC,QACAC,QACAC,mBACAC,gBACAC,YAMFC,KAEA,MAAMC,EAAUC,SAA6C,MAOvDC,EAAiBC,EAAAA,YAAY,EAAGjB,KAAMkB,EAAUC,WAC7CC,EAAAA,IAACd,EAAU,CAACe,KAAMH,EAASlB,KAAKmB,GAAQA,MAAOA,EAAOd,SAAUA,EAAUiB,WAAW,IAE3F,IAEH,OAEEF,EAAAA,IAACG,EAAAA,QAAc,CACbC,aAbiBL,GACZA,EAAQnB,EAAKyB,OAalBtB,UAAWA,EACXJ,cAAeA,EACfE,iBAAkBA,EAClBC,UAAWA,EAASwB,SAEnB,EAAGC,qBAGAP,MAACQ,EAAAA,iBAAe,CACdrB,OAAQA,EACRC,MAAOA,EACPL,UAAWA,EACXC,SAAUA,EACVC,SAAUA,EACVwB,IAAKf,EACLL,MAAOA,EAEPC,iBAAkBA,EAClBoB,cAAenB,EACfoB,gBAAc,EACdJ,gBAAkBK,IAChBL,EAAgBK,IAElBpB,SAAWqB,IACTrB,SAAAA,EAAW,CACTsB,cAAe,CACbC,UAAWF,EAAEG,aACbC,WAAY,EACZC,aAAc,EACdC,YAAa,EACbC,aAAc,EACdC,YAAa,EACbC,WAAY,EACZC,UAAW,EACXC,yBAA0B,MAK/BlB,SAAAV,SAYhBpB,EAA4CiD,YAAc,OC/F3D,MAAMC,EAAkBC,EAAAA,mBAA+CC,2CAOZ,EAAGtB,WAAUuB,YAC/D7B,EAAC8B,IAAAJ,EAAgBK,SAAS,CAAAC,MAAO,CAAEH,UAAWvB,SAAAA,wBAO5B,KACzB,MAAM2B,EAAUC,aAAWR,GAC3B,YAAgBE,IAAZK,EACK,CAAEJ,QAAS,GAEbI"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{jsx as e}from"react/jsx-runtime";import{memo as t,forwardRef as i,useRef as o,useCallback as r,createContext as l,useContext as n}from"react";import{VariableSizeList as d}from"react-window";import m from"react-window-infinite-loader";const s=t(i(({loadMoreItems:t,data:i,minimumBatchSize:l,threshold:n,itemCount:s,itemSize:a,itemData:c,RenderItem:h,height:u,width:f,style:p,outerElementType:I,overScanCount:S,onScroll:g},v)=>{const w=o(null),y=r(({data:t,index:i})=>e(h,{item:t.data[i],index:i,itemData:c,isVisible:!1}),[]);return e(m,{isItemLoaded:e=>e<i.length,itemCount:s,loadMoreItems:t,minimumBatchSize:l,threshold:n,children:({onItemsRendered:t})=>e(d,{height:u,width:f,itemCount:s,itemSize:a,itemData:c,ref:w,style:p,outerElementType:I,overscanCount:S,useIsScrolling:!0,onItemsRendered:e=>{t(e)},onScroll:e=>{null==g||g({currentTarget:{scrollTop:e.scrollOffset,scrollLeft:0,scrollHeight:0,scrollWidth:0,clientHeight:0,clientWidth:0,offsetLeft:0,offsetTop:0,horizontalScrollVelocity:0}})},children:y})})}));s.displayName="List";const a=l(void 0),c=({children:t,listId:i})=>e(a.Provider,{value:{listId:i},children:t}),h=()=>{const e=n(a);return void 0===e?{listId:-1}:e};export{s as List,c as ListItemProvider,h as useListItem};
|
|
2
|
+
//# sourceMappingURL=ct-design-list.browser.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ct-design-list.browser.esm.js","sources":["../packages/components/List/src/List.tsx","../packages/components/List/src/ListItemContext.tsx"],"sourcesContent":[null,null],"names":["List","memo","forwardRef","loadMoreItems","data","minimumBatchSize","threshold","itemCount","itemSize","itemData","RenderItem","height","width","style","outerElementType","overScanCount","onScroll","_forwardedRef","listRef","useRef","RenderListItem","useCallback","listData","index","_jsx","item","isVisible","InfiniteLoader","isItemLoaded","length","children","onItemsRendered","ReactWindowList","ref","overscanCount","useIsScrolling","params","e","currentTarget","scrollTop","scrollOffset","scrollLeft","scrollHeight","scrollWidth","clientHeight","clientWidth","offsetLeft","offsetTop","horizontalScrollVelocity","displayName","ListItemContext","createContext","undefined","ListItemProvider","listId","Provider","value","useListItem","context","useContext"],"mappings":"iPAcA,MAAMA,EAAOC,EACXC,EACE,EAEIC,gBACAC,OACAC,mBACAC,YACAC,YACAC,WACAC,WACAC,aACAC,SACAC,QACAC,QACAC,mBACAC,gBACAC,YAMFC,KAEA,MAAMC,EAAUC,EAA6C,MAOvDC,EAAiBC,EAAY,EAAGjB,KAAMkB,EAAUC,WAC7CC,EAACd,EAAU,CAACe,KAAMH,EAASlB,KAAKmB,GAAQA,MAAOA,EAAOd,SAAUA,EAAUiB,WAAW,IAE3F,IAEH,OAEEF,EAACG,EAAc,CACbC,aAbiBL,GACZA,EAAQnB,EAAKyB,OAalBtB,UAAWA,EACXJ,cAAeA,EACfE,iBAAkBA,EAClBC,UAAWA,EAASwB,SAEnB,EAAGC,qBAGAP,EAACQ,EAAe,CACdrB,OAAQA,EACRC,MAAOA,EACPL,UAAWA,EACXC,SAAUA,EACVC,SAAUA,EACVwB,IAAKf,EACLL,MAAOA,EAEPC,iBAAkBA,EAClBoB,cAAenB,EACfoB,gBAAc,EACdJ,gBAAkBK,IAChBL,EAAgBK,IAElBpB,SAAWqB,IACTrB,SAAAA,EAAW,CACTsB,cAAe,CACbC,UAAWF,EAAEG,aACbC,WAAY,EACZC,aAAc,EACdC,YAAa,EACbC,aAAc,EACdC,YAAa,EACbC,WAAY,EACZC,UAAW,EACXC,yBAA0B,MAK/BlB,SAAAV,SAYhBpB,EAA4CiD,YAAc,OC/F3D,MAAMC,EAAkBC,OAA+CC,GAO1DC,EAA8C,EAAGvB,WAAUwB,YAC/D9B,EAAC0B,EAAgBK,SAAS,CAAAC,MAAO,CAAEF,UAAWxB,SAAAA,IAO1C2B,EAAc,KACzB,MAAMC,EAAUC,EAAWT,GAC3B,YAAgBE,IAAZM,EACK,CAAEJ,QAAS,GAEbI"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var jsxRuntime = require('react/jsx-runtime');
|
|
4
|
+
var react = require('react');
|
|
5
|
+
var reactWindow = require('react-window');
|
|
6
|
+
var InfiniteLoader = require('react-window-infinite-loader');
|
|
7
|
+
|
|
8
|
+
function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
|
|
9
|
+
|
|
10
|
+
var InfiniteLoader__default = /*#__PURE__*/_interopDefault(InfiniteLoader);
|
|
11
|
+
|
|
12
|
+
const List = react.memo(react.forwardRef(({ loadMoreItems, data, minimumBatchSize, threshold, itemCount, itemSize, itemData, RenderItem, height, width, style, outerElementType, overScanCount, onScroll, }, _forwardedRef) => {
|
|
13
|
+
const listRef = react.useRef(null);
|
|
14
|
+
const isRowLoaded = (index) => {
|
|
15
|
+
return index < data.length;
|
|
16
|
+
};
|
|
17
|
+
const RenderListItem = react.useCallback(({ data: listData, index }) => {
|
|
18
|
+
return jsxRuntime.jsx(RenderItem, { item: listData.data[index], index: index, itemData: itemData, isVisible: false });
|
|
19
|
+
}, []);
|
|
20
|
+
return (jsxRuntime.jsx(InfiniteLoader__default.default, { isItemLoaded: isRowLoaded, itemCount: itemCount, loadMoreItems: loadMoreItems, minimumBatchSize: minimumBatchSize, threshold: threshold, children: ({ onItemsRendered }) => {
|
|
21
|
+
return (jsxRuntime.jsx(reactWindow.VariableSizeList, { height: height, width: width, itemCount: itemCount, itemSize: itemSize, itemData: itemData, ref: listRef, style: style, outerElementType: outerElementType, overscanCount: overScanCount, useIsScrolling: true, onItemsRendered: (params) => {
|
|
22
|
+
onItemsRendered(params);
|
|
23
|
+
}, onScroll: (e) => {
|
|
24
|
+
onScroll === null || onScroll === void 0 ? void 0 : onScroll({
|
|
25
|
+
currentTarget: {
|
|
26
|
+
scrollTop: e.scrollOffset,
|
|
27
|
+
scrollLeft: 0,
|
|
28
|
+
scrollHeight: 0,
|
|
29
|
+
scrollWidth: 0,
|
|
30
|
+
clientHeight: 0,
|
|
31
|
+
clientWidth: 0,
|
|
32
|
+
offsetLeft: 0,
|
|
33
|
+
offsetTop: 0,
|
|
34
|
+
horizontalScrollVelocity: 0,
|
|
35
|
+
},
|
|
36
|
+
});
|
|
37
|
+
}, children: RenderListItem }));
|
|
38
|
+
} }));
|
|
39
|
+
}));
|
|
40
|
+
List.displayName = 'List';
|
|
41
|
+
|
|
42
|
+
const ListItemContext = react.createContext(undefined);
|
|
43
|
+
const ListItemProvider = ({ children, listId }) => {
|
|
44
|
+
return jsxRuntime.jsx(ListItemContext.Provider, { value: { listId }, children: children });
|
|
45
|
+
};
|
|
46
|
+
const useListItem = () => {
|
|
47
|
+
const context = react.useContext(ListItemContext);
|
|
48
|
+
if (context === undefined) {
|
|
49
|
+
return { listId: -1 };
|
|
50
|
+
}
|
|
51
|
+
return context;
|
|
52
|
+
};
|
|
53
|
+
|
|
54
|
+
exports.List = List;
|
|
55
|
+
exports.ListItemProvider = ListItemProvider;
|
|
56
|
+
exports.useListItem = useListItem;
|
|
57
|
+
//# sourceMappingURL=ct-design-list.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ct-design-list.cjs.js","sources":["../packages/components/List/src/List.tsx","../packages/components/List/src/ListItemContext.tsx"],"sourcesContent":[null,null],"names":["memo","forwardRef","useRef","useCallback","_jsx","InfiniteLoader","ReactWindowList","createContext","useContext"],"mappings":";;;;;;;;;;;AAcA,MAAM,IAAI,GAAGA,UAAI,CACfC,gBAAU,CACR,CACE,EACE,aAAa,EACb,IAAI,EACJ,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,MAAM,EACN,KAAK,EACL,KAAK,EACL,gBAAgB,EAChB,aAAa,EACb,QAAQ,GACT,EAKD,aAAa,KACX;AACF,IAAA,MAAM,OAAO,GAAGC,YAAM,CAAuC,IAAI,CAAC,CAAC;AAEnE,IAAA,MAAM,WAAW,GAAG,CAAC,KAAa,KAAI;AACpC,QAAA,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;AAC7B,KAAC,CAAC;AAGF,IAAA,MAAM,cAAc,GAAGC,iBAAW,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAgD,KAAI;QAC7G,OAAOC,cAAA,CAAC,UAAU,EAAA,EAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAA,CAAI,CAAC;KAEvG,EAAE,EAAE,CAAC,CAAC;AAEP,IAAA,QAEEA,cAAA,CAACC,+BAAc,EAAA,EACb,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,gBAAgB,EAAE,gBAAgB,EAClC,SAAS,EAAE,SAAS,EAAA,QAAA,EAEnB,CAAC,EAAE,eAAe,EAAE,KAAI;YACvB,QAEED,eAACE,4BAAe,EAAA,EACd,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,KAAsB,EAE7B,gBAAgB,EAAE,gBAAgB,EAClC,aAAa,EAAE,aAAa,EAC5B,cAAc,EAAA,IAAA,EACd,eAAe,EAAE,CAAC,MAAM,KAAI;oBAC1B,eAAe,CAAC,MAAM,CAAC,CAAC;AAC1B,iBAAC,EACD,QAAQ,EAAE,CAAC,CAAoB,KAAI;AACjC,oBAAA,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAG;AACT,wBAAA,aAAa,EAAE;4BACb,SAAS,EAAE,CAAC,CAAC,YAAY;AACzB,4BAAA,UAAU,EAAE,CAAC;AACb,4BAAA,YAAY,EAAE,CAAC;AACf,4BAAA,WAAW,EAAE,CAAC;AACd,4BAAA,YAAY,EAAE,CAAC;AACf,4BAAA,WAAW,EAAE,CAAC;AACd,4BAAA,UAAU,EAAE,CAAC;AACb,4BAAA,SAAS,EAAE,CAAC;AACZ,4BAAA,wBAAwB,EAAE,CAAC;AAC5B,yBAAA;AACF,qBAAA,CAAC,CAAC;AACL,iBAAC,EAEA,QAAA,EAAA,cAAc,EACC,CAAA,EAClB;SACH,EAAA,CACc,EACjB;AACJ,CAAC,CACF,EAGoB;AAEtB,IAA2C,CAAC,WAAW,GAAG,MAAM;;AC/FjE,MAAM,eAAe,GAAGC,mBAAa,CAAkC,SAAS,CAAC,CAAC;AAOrE,MAAA,gBAAgB,GAA8B,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAI;AAClF,IAAA,OAAOH,cAAC,CAAA,eAAe,CAAC,QAAQ,EAAC,EAAA,KAAK,EAAE,EAAE,MAAM,EAAE,EAAG,QAAA,EAAA,QAAQ,GAA4B,CAAC;AAC5F,EAAE;AAMK,MAAM,WAAW,GAAG,MAAK;AAC9B,IAAA,MAAM,OAAO,GAAGI,gBAAU,CAAC,eAAe,CAAC,CAAC;AAC5C,IAAA,IAAI,OAAO,KAAK,SAAS,EAAE;AACzB,QAAA,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC;KACvB;AACD,IAAA,OAAO,OAAO,CAAC;AACjB;;;;;;"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { jsx } from 'react/jsx-runtime';
|
|
2
|
+
import { memo, forwardRef, useRef, useCallback, createContext, useContext } from 'react';
|
|
3
|
+
import { VariableSizeList } from 'react-window';
|
|
4
|
+
import InfiniteLoader from 'react-window-infinite-loader';
|
|
5
|
+
|
|
6
|
+
const List = memo(forwardRef(({ loadMoreItems, data, minimumBatchSize, threshold, itemCount, itemSize, itemData, RenderItem, height, width, style, outerElementType, overScanCount, onScroll, }, _forwardedRef) => {
|
|
7
|
+
const listRef = useRef(null);
|
|
8
|
+
const isRowLoaded = (index) => {
|
|
9
|
+
return index < data.length;
|
|
10
|
+
};
|
|
11
|
+
const RenderListItem = useCallback(({ data: listData, index }) => {
|
|
12
|
+
return jsx(RenderItem, { item: listData.data[index], index: index, itemData: itemData, isVisible: false });
|
|
13
|
+
}, []);
|
|
14
|
+
return (jsx(InfiniteLoader, { isItemLoaded: isRowLoaded, itemCount: itemCount, loadMoreItems: loadMoreItems, minimumBatchSize: minimumBatchSize, threshold: threshold, children: ({ onItemsRendered }) => {
|
|
15
|
+
return (jsx(VariableSizeList, { height: height, width: width, itemCount: itemCount, itemSize: itemSize, itemData: itemData, ref: listRef, style: style, outerElementType: outerElementType, overscanCount: overScanCount, useIsScrolling: true, onItemsRendered: (params) => {
|
|
16
|
+
onItemsRendered(params);
|
|
17
|
+
}, onScroll: (e) => {
|
|
18
|
+
onScroll === null || onScroll === void 0 ? void 0 : onScroll({
|
|
19
|
+
currentTarget: {
|
|
20
|
+
scrollTop: e.scrollOffset,
|
|
21
|
+
scrollLeft: 0,
|
|
22
|
+
scrollHeight: 0,
|
|
23
|
+
scrollWidth: 0,
|
|
24
|
+
clientHeight: 0,
|
|
25
|
+
clientWidth: 0,
|
|
26
|
+
offsetLeft: 0,
|
|
27
|
+
offsetTop: 0,
|
|
28
|
+
horizontalScrollVelocity: 0,
|
|
29
|
+
},
|
|
30
|
+
});
|
|
31
|
+
}, children: RenderListItem }));
|
|
32
|
+
} }));
|
|
33
|
+
}));
|
|
34
|
+
List.displayName = 'List';
|
|
35
|
+
|
|
36
|
+
const ListItemContext = createContext(undefined);
|
|
37
|
+
const ListItemProvider = ({ children, listId }) => {
|
|
38
|
+
return jsx(ListItemContext.Provider, { value: { listId }, children: children });
|
|
39
|
+
};
|
|
40
|
+
const useListItem = () => {
|
|
41
|
+
const context = useContext(ListItemContext);
|
|
42
|
+
if (context === undefined) {
|
|
43
|
+
return { listId: -1 };
|
|
44
|
+
}
|
|
45
|
+
return context;
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
export { List, ListItemProvider, useListItem };
|
|
49
|
+
//# sourceMappingURL=ct-design-list.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ct-design-list.esm.js","sources":["../packages/components/List/src/List.tsx","../packages/components/List/src/ListItemContext.tsx"],"sourcesContent":[null,null],"names":["_jsx","ReactWindowList"],"mappings":";;;;;AAcA,MAAM,IAAI,GAAG,IAAI,CACf,UAAU,CACR,CACE,EACE,aAAa,EACb,IAAI,EACJ,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,MAAM,EACN,KAAK,EACL,KAAK,EACL,gBAAgB,EAChB,aAAa,EACb,QAAQ,GACT,EAKD,aAAa,KACX;AACF,IAAA,MAAM,OAAO,GAAG,MAAM,CAAuC,IAAI,CAAC,CAAC;AAEnE,IAAA,MAAM,WAAW,GAAG,CAAC,KAAa,KAAI;AACpC,QAAA,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;AAC7B,KAAC,CAAC;AAGF,IAAA,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAgD,KAAI;QAC7G,OAAOA,GAAA,CAAC,UAAU,EAAA,EAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAA,CAAI,CAAC;KAEvG,EAAE,EAAE,CAAC,CAAC;AAEP,IAAA,QAEEA,GAAA,CAAC,cAAc,EAAA,EACb,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,gBAAgB,EAAE,gBAAgB,EAClC,SAAS,EAAE,SAAS,EAAA,QAAA,EAEnB,CAAC,EAAE,eAAe,EAAE,KAAI;YACvB,QAEEA,IAACC,gBAAe,EAAA,EACd,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,KAAsB,EAE7B,gBAAgB,EAAE,gBAAgB,EAClC,aAAa,EAAE,aAAa,EAC5B,cAAc,EAAA,IAAA,EACd,eAAe,EAAE,CAAC,MAAM,KAAI;oBAC1B,eAAe,CAAC,MAAM,CAAC,CAAC;AAC1B,iBAAC,EACD,QAAQ,EAAE,CAAC,CAAoB,KAAI;AACjC,oBAAA,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAG;AACT,wBAAA,aAAa,EAAE;4BACb,SAAS,EAAE,CAAC,CAAC,YAAY;AACzB,4BAAA,UAAU,EAAE,CAAC;AACb,4BAAA,YAAY,EAAE,CAAC;AACf,4BAAA,WAAW,EAAE,CAAC;AACd,4BAAA,YAAY,EAAE,CAAC;AACf,4BAAA,WAAW,EAAE,CAAC;AACd,4BAAA,UAAU,EAAE,CAAC;AACb,4BAAA,SAAS,EAAE,CAAC;AACZ,4BAAA,wBAAwB,EAAE,CAAC;AAC5B,yBAAA;AACF,qBAAA,CAAC,CAAC;AACL,iBAAC,EAEA,QAAA,EAAA,cAAc,EACC,CAAA,EAClB;SACH,EAAA,CACc,EACjB;AACJ,CAAC,CACF,EAGoB;AAEtB,IAA2C,CAAC,WAAW,GAAG,MAAM;;AC/FjE,MAAM,eAAe,GAAG,aAAa,CAAkC,SAAS,CAAC,CAAC;AAOrE,MAAA,gBAAgB,GAA8B,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAI;AAClF,IAAA,OAAOD,GAAC,CAAA,eAAe,CAAC,QAAQ,EAAC,EAAA,KAAK,EAAE,EAAE,MAAM,EAAE,EAAG,QAAA,EAAA,QAAQ,GAA4B,CAAC;AAC5F,EAAE;AAMK,MAAM,WAAW,GAAG,MAAK;AAC9B,IAAA,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAC5C,IAAA,IAAI,OAAO,KAAK,SAAS,EAAE;AACzB,QAAA,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC;KACvB;AACD,IAAA,OAAO,OAAO,CAAC;AACjB;;;;"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
(function (global, factory) {
|
|
2
|
+
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react/jsx-runtime'), require('react'), require('react-window'), require('react-window-infinite-loader')) :
|
|
3
|
+
typeof define === 'function' && define.amd ? define(['exports', 'react/jsx-runtime', 'react', 'react-window', 'react-window-infinite-loader'], factory) :
|
|
4
|
+
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.CTDesignSystemList = {}, global.jsxRuntime, global.React, global.reactWindow, global.InfiniteLoader));
|
|
5
|
+
})(this, (function (exports, jsxRuntime, react, reactWindow, InfiniteLoader) { 'use strict';
|
|
6
|
+
|
|
7
|
+
function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
|
|
8
|
+
|
|
9
|
+
var InfiniteLoader__default = /*#__PURE__*/_interopDefault(InfiniteLoader);
|
|
10
|
+
|
|
11
|
+
const List = react.memo(react.forwardRef(({ loadMoreItems, data, minimumBatchSize, threshold, itemCount, itemSize, itemData, RenderItem, height, width, style, outerElementType, overScanCount, onScroll, }, _forwardedRef) => {
|
|
12
|
+
const listRef = react.useRef(null);
|
|
13
|
+
const isRowLoaded = (index) => {
|
|
14
|
+
return index < data.length;
|
|
15
|
+
};
|
|
16
|
+
const RenderListItem = react.useCallback(({ data: listData, index }) => {
|
|
17
|
+
return jsxRuntime.jsx(RenderItem, { item: listData.data[index], index: index, itemData: itemData, isVisible: false });
|
|
18
|
+
}, []);
|
|
19
|
+
return (jsxRuntime.jsx(InfiniteLoader__default.default, { isItemLoaded: isRowLoaded, itemCount: itemCount, loadMoreItems: loadMoreItems, minimumBatchSize: minimumBatchSize, threshold: threshold, children: ({ onItemsRendered }) => {
|
|
20
|
+
return (jsxRuntime.jsx(reactWindow.VariableSizeList, { height: height, width: width, itemCount: itemCount, itemSize: itemSize, itemData: itemData, ref: listRef, style: style, outerElementType: outerElementType, overscanCount: overScanCount, useIsScrolling: true, onItemsRendered: (params) => {
|
|
21
|
+
onItemsRendered(params);
|
|
22
|
+
}, onScroll: (e) => {
|
|
23
|
+
onScroll === null || onScroll === void 0 ? void 0 : onScroll({
|
|
24
|
+
currentTarget: {
|
|
25
|
+
scrollTop: e.scrollOffset,
|
|
26
|
+
scrollLeft: 0,
|
|
27
|
+
scrollHeight: 0,
|
|
28
|
+
scrollWidth: 0,
|
|
29
|
+
clientHeight: 0,
|
|
30
|
+
clientWidth: 0,
|
|
31
|
+
offsetLeft: 0,
|
|
32
|
+
offsetTop: 0,
|
|
33
|
+
horizontalScrollVelocity: 0,
|
|
34
|
+
},
|
|
35
|
+
});
|
|
36
|
+
}, children: RenderListItem }));
|
|
37
|
+
} }));
|
|
38
|
+
}));
|
|
39
|
+
List.displayName = 'List';
|
|
40
|
+
|
|
41
|
+
const ListItemContext = react.createContext(undefined);
|
|
42
|
+
const ListItemProvider = ({ children, listId }) => {
|
|
43
|
+
return jsxRuntime.jsx(ListItemContext.Provider, { value: { listId }, children: children });
|
|
44
|
+
};
|
|
45
|
+
const useListItem = () => {
|
|
46
|
+
const context = react.useContext(ListItemContext);
|
|
47
|
+
if (context === undefined) {
|
|
48
|
+
return { listId: -1 };
|
|
49
|
+
}
|
|
50
|
+
return context;
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
exports.List = List;
|
|
54
|
+
exports.ListItemProvider = ListItemProvider;
|
|
55
|
+
exports.useListItem = useListItem;
|
|
56
|
+
|
|
57
|
+
}));
|
|
58
|
+
//# sourceMappingURL=ct-design-list.umd.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ct-design-list.umd.js","sources":["../packages/components/List/src/List.tsx","../packages/components/List/src/ListItemContext.tsx"],"sourcesContent":[null,null],"names":["memo","forwardRef","useRef","useCallback","_jsx","InfiniteLoader","ReactWindowList","createContext","useContext"],"mappings":";;;;;;;;;;AAcA,UAAM,IAAI,GAAGA,UAAI,CACfC,gBAAU,CACR,CACE,EACE,aAAa,EACb,IAAI,EACJ,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,MAAM,EACN,KAAK,EACL,KAAK,EACL,gBAAgB,EAChB,aAAa,EACb,QAAQ,GACT,EAKD,aAAa,KACX;IACF,IAAA,MAAM,OAAO,GAAGC,YAAM,CAAuC,IAAI,CAAC,CAAC;IAEnE,IAAA,MAAM,WAAW,GAAG,CAAC,KAAa,KAAI;IACpC,QAAA,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;IAC7B,KAAC,CAAC;IAGF,IAAA,MAAM,cAAc,GAAGC,iBAAW,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAgD,KAAI;YAC7G,OAAOC,cAAA,CAAC,UAAU,EAAA,EAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAA,CAAI,CAAC;SAEvG,EAAE,EAAE,CAAC,CAAC;IAEP,IAAA,QAEEA,cAAA,CAACC,+BAAc,EAAA,EACb,YAAY,EAAE,WAAW,EACzB,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,gBAAgB,EAAE,gBAAgB,EAClC,SAAS,EAAE,SAAS,EAAA,QAAA,EAEnB,CAAC,EAAE,eAAe,EAAE,KAAI;gBACvB,QAEED,eAACE,4BAAe,EAAA,EACd,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,KAAsB,EAE7B,gBAAgB,EAAE,gBAAgB,EAClC,aAAa,EAAE,aAAa,EAC5B,cAAc,EAAA,IAAA,EACd,eAAe,EAAE,CAAC,MAAM,KAAI;wBAC1B,eAAe,CAAC,MAAM,CAAC,CAAC;IAC1B,iBAAC,EACD,QAAQ,EAAE,CAAC,CAAoB,KAAI;IACjC,oBAAA,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAG;IACT,wBAAA,aAAa,EAAE;gCACb,SAAS,EAAE,CAAC,CAAC,YAAY;IACzB,4BAAA,UAAU,EAAE,CAAC;IACb,4BAAA,YAAY,EAAE,CAAC;IACf,4BAAA,WAAW,EAAE,CAAC;IACd,4BAAA,YAAY,EAAE,CAAC;IACf,4BAAA,WAAW,EAAE,CAAC;IACd,4BAAA,UAAU,EAAE,CAAC;IACb,4BAAA,SAAS,EAAE,CAAC;IACZ,4BAAA,wBAAwB,EAAE,CAAC;IAC5B,yBAAA;IACF,qBAAA,CAAC,CAAC;IACL,iBAAC,EAEA,QAAA,EAAA,cAAc,EACC,CAAA,EAClB;aACH,EAAA,CACc,EACjB;IACJ,CAAC,CACF,EAGoB;IAEtB,IAA2C,CAAC,WAAW,GAAG,MAAM;;IC/FjE,MAAM,eAAe,GAAGC,mBAAa,CAAkC,SAAS,CAAC,CAAC;AAOrE,UAAA,gBAAgB,GAA8B,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAI;IAClF,IAAA,OAAOH,cAAC,CAAA,eAAe,CAAC,QAAQ,EAAC,EAAA,KAAK,EAAE,EAAE,MAAM,EAAE,EAAG,QAAA,EAAA,QAAQ,GAA4B,CAAC;IAC5F,EAAE;AAMK,UAAM,WAAW,GAAG,MAAK;IAC9B,IAAA,MAAM,OAAO,GAAGI,gBAAU,CAAC,eAAe,CAAC,CAAC;IAC5C,IAAA,IAAI,OAAO,KAAK,SAAS,EAAE;IACzB,QAAA,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC;SACvB;IACD,IAAA,OAAO,OAAO,CAAC;IACjB;;;;;;;;;;"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../packages/components/List/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,QAAQ,CAAC;AACzC,cAAc,QAAQ,CAAC;AACvB,cAAc,mBAAmB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.native.d.ts","sourceRoot":"","sources":["../packages/components/List/src/index.native.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,eAAe,CAAC;AAChD,cAAc,QAAQ,CAAC;AACvB,cAAc,mBAAmB,CAAC"}
|
package/dist/type.d.ts
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type { FunctionComponent, Ref } from 'react';
|
|
2
|
+
import type { Styles } from '@cleartrip/ct-design-types';
|
|
3
|
+
export interface IListItemRendererProps<T, U> {
|
|
4
|
+
item: T;
|
|
5
|
+
index: number;
|
|
6
|
+
itemData: U;
|
|
7
|
+
isVisible: boolean;
|
|
8
|
+
}
|
|
9
|
+
export interface IVariableSizedListProps<T, U extends {
|
|
10
|
+
data: T[];
|
|
11
|
+
}> {
|
|
12
|
+
data: T[];
|
|
13
|
+
loadMoreItems: () => Promise<void> | void;
|
|
14
|
+
itemKey: (item: T, index: number) => string;
|
|
15
|
+
windowSize?: number;
|
|
16
|
+
minimumBatchSize?: number | undefined;
|
|
17
|
+
threshold?: number | undefined;
|
|
18
|
+
height: number | string;
|
|
19
|
+
itemCount: number;
|
|
20
|
+
width: number | string;
|
|
21
|
+
itemSize: (index: number) => number;
|
|
22
|
+
itemData: U;
|
|
23
|
+
style?: Styles;
|
|
24
|
+
overScanCount: number;
|
|
25
|
+
ref?: Ref<ListRef>;
|
|
26
|
+
RenderItem: FunctionComponent<IListItemRendererProps<T, U>>;
|
|
27
|
+
outerElementType?: FunctionComponent<unknown>;
|
|
28
|
+
isVirtualized?: boolean;
|
|
29
|
+
isRecycled?: boolean;
|
|
30
|
+
onScroll?: (props: ListScrollEvent) => void;
|
|
31
|
+
setCardHeight?: (index: number, size: number) => void;
|
|
32
|
+
handleItemsRendered?: (props: unknown) => void;
|
|
33
|
+
onItemsRendered?: (props: unknown) => void;
|
|
34
|
+
}
|
|
35
|
+
export type ListScrollEvent = {
|
|
36
|
+
currentTarget: {
|
|
37
|
+
scrollTop?: number;
|
|
38
|
+
scrollLeft?: number;
|
|
39
|
+
scrollHeight?: number;
|
|
40
|
+
scrollWidth?: number;
|
|
41
|
+
clientHeight?: number;
|
|
42
|
+
clientWidth?: number;
|
|
43
|
+
offsetHeight?: number;
|
|
44
|
+
offsetWidth?: number;
|
|
45
|
+
offsetLeft?: number;
|
|
46
|
+
offsetTop?: number;
|
|
47
|
+
horizontalScrollVelocity?: number;
|
|
48
|
+
verticalScrollVelocity?: number;
|
|
49
|
+
topTargetContentOffset?: number;
|
|
50
|
+
leftTargetContentOffset?: number;
|
|
51
|
+
};
|
|
52
|
+
};
|
|
53
|
+
export type ListRef = {
|
|
54
|
+
scrollToEnd: () => void;
|
|
55
|
+
};
|
|
56
|
+
//# sourceMappingURL=type.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../packages/components/List/src/type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAKzD,MAAM,WAAW,sBAAsB,CAAC,CAAC,EAAE,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC;IACR,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,CAAC,CAAC;IACZ,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB,CAAC,CAAC,EAAE,CAAC,SAAS;IAAE,IAAI,EAAE,CAAC,EAAE,CAAA;CAAE;IACjE,IAAI,EAAE,CAAC,EAAE,CAAC;IAMV,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAG1C,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IAM5C,UAAU,CAAC,EAAE,MAAM,CAAC;IAMpB,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAMtC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAO/B,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAGxB,SAAS,EAAE,MAAM,CAAC;IAMlB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAOvB,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IAOpC,QAAQ,EAAE,CAAC,CAAC;IAGZ,KAAK,CAAC,EAAE,MAAM,CAAC;IAMf,aAAa,EAAE,MAAM,CAAC;IAGtB,GAAG,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAGnB,UAAU,EAAE,iBAAiB,CAAC,sBAAsB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAO5D,gBAAgB,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAG9C,aAAa,CAAC,EAAE,OAAO,CAAC;IAGxB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAC5C,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/C,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CAC5C;AACD,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,EAAE;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAChC,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAChC,uBAAuB,CAAC,EAAE,MAAM,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}
|
package/dist/utils.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../packages/components/List/src/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,YAAY,GAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,YAM1D,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@cleartrip/ct-design-list",
|
|
3
|
+
"version": "4.0.0-SNAPSHOT-test.0",
|
|
4
|
+
"description": "List Component (virtualised)",
|
|
5
|
+
"types": "dist/index.d.ts",
|
|
6
|
+
"main": "./dist/ct-design-list.cjs.js",
|
|
7
|
+
"react-native": "src/index.native.ts",
|
|
8
|
+
"jsnext:main": "dist/ct-design-list.esm.js",
|
|
9
|
+
"module": "dist/ct-design-list.esm.js",
|
|
10
|
+
"sideEffects": false,
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"types": "./dist/ct-design-list.d.ts",
|
|
14
|
+
"import": "./dist/ct-design-list.esm.js",
|
|
15
|
+
"default": "./dist/ct-design-list.cjs.js"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"browser": {
|
|
19
|
+
"./dist/ct-design-list.esm.js": "./dist/ct-design-list.browser.esm.js",
|
|
20
|
+
"./dist/ct-design-list.cjs.js": "./dist/ct-design-list.browser.cjs.js"
|
|
21
|
+
},
|
|
22
|
+
"files": [
|
|
23
|
+
"dist",
|
|
24
|
+
"src"
|
|
25
|
+
],
|
|
26
|
+
"dependencies": {
|
|
27
|
+
"react-window": "^1.8.9",
|
|
28
|
+
"react-window-infinite-loader": "^1.0.9",
|
|
29
|
+
"@cleartrip/ct-design-scroll-container": "4.0.0-SNAPSHOT-test.0",
|
|
30
|
+
"@cleartrip/ct-design-style-manager": "4.0.0-SNAPSHOT-test.0",
|
|
31
|
+
"@cleartrip/ct-design-use-merge-refs": "4.0.0-SNAPSHOT-test.0",
|
|
32
|
+
"@cleartrip/ct-design-theme": "4.0.0-SNAPSHOT-test.0"
|
|
33
|
+
},
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"@types/react-window": "^1.8.8",
|
|
36
|
+
"@types/react-window-infinite-loader": "^1.0.9",
|
|
37
|
+
"@cleartrip/ct-design-types": "4.0.0-SNAPSHOT-test.0"
|
|
38
|
+
},
|
|
39
|
+
"peerDependencies": {
|
|
40
|
+
"react": ">=16.8.0",
|
|
41
|
+
"react-dom": ">=16.8.0",
|
|
42
|
+
"react-native": ">=0.78.0"
|
|
43
|
+
},
|
|
44
|
+
"peerDependenciesMeta": {
|
|
45
|
+
"react-native": {
|
|
46
|
+
"optional": true
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"publishConfig": {
|
|
50
|
+
"access": "public"
|
|
51
|
+
},
|
|
52
|
+
"author": "Cleartrip",
|
|
53
|
+
"license": "ISC",
|
|
54
|
+
"scripts": {
|
|
55
|
+
"test": "echo \"Error: no test specified\" && exit 1",
|
|
56
|
+
"watch-package": "rollup -c -w",
|
|
57
|
+
"build-package": "rollup -c",
|
|
58
|
+
"build-package:clean": "rm -rf dist && rollup -c",
|
|
59
|
+
"publish-package:local": "yalc publish"
|
|
60
|
+
}
|
|
61
|
+
}
|
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
import { forwardRef, memo, useCallback, useRef } from 'react';
|
|
2
|
+
|
|
3
|
+
import { makeStyles } from '@cleartrip/ct-design-style-manager';
|
|
4
|
+
import useMergeRefs from '@cleartrip/ct-design-use-merge-refs';
|
|
5
|
+
import { ScrollContextProvider, ScrollableObservableChild } from '@cleartrip/ct-design-scroll-container';
|
|
6
|
+
import { FlatList, ListRenderItemInfo, View, ViewToken } from 'react-native';
|
|
7
|
+
|
|
8
|
+
import { IListItemRendererProps, IVariableSizedListProps, ListRef } from './type';
|
|
9
|
+
import { ListItemProvider } from './ListItemContext';
|
|
10
|
+
import { areSetsEqual } from './utils';
|
|
11
|
+
|
|
12
|
+
const staticStyles = makeStyles(() => ({
|
|
13
|
+
itemSeparator: {
|
|
14
|
+
height: 24,
|
|
15
|
+
},
|
|
16
|
+
}));
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Memoised row shell — keeps individual row renders isolated from the
|
|
20
|
+
* outer FlatList re-render cycle.
|
|
21
|
+
*/
|
|
22
|
+
const ItemRenderer = memo(
|
|
23
|
+
<T, U>({
|
|
24
|
+
item,
|
|
25
|
+
index,
|
|
26
|
+
RenderItem,
|
|
27
|
+
itemData,
|
|
28
|
+
isVisible,
|
|
29
|
+
}: {
|
|
30
|
+
item: T;
|
|
31
|
+
index: number;
|
|
32
|
+
RenderItem: React.FC<IListItemRendererProps<T, U>>;
|
|
33
|
+
itemData: U;
|
|
34
|
+
isVisible: boolean;
|
|
35
|
+
}) => {
|
|
36
|
+
return <RenderItem item={item} index={index} itemData={itemData} isVisible={isVisible} />;
|
|
37
|
+
},
|
|
38
|
+
);
|
|
39
|
+
|
|
40
|
+
ItemRenderer.displayName = 'ItemRenderer';
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Native `List`
|
|
44
|
+
*
|
|
45
|
+
* Mapping from web (react-window) → native (FlatList):
|
|
46
|
+
* - `minimumBatchSize` → `initialNumToRender` (first-page size)
|
|
47
|
+
* - `threshold` → `onEndReachedThreshold`
|
|
48
|
+
* - `itemSize` → used at row layout time
|
|
49
|
+
* - `outerElementType` → `ListFooterComponent`
|
|
50
|
+
* - `overScanCount` → contributes to `maxToRenderPerBatch`
|
|
51
|
+
* - `onItemsRendered` → split into two `viewabilityConfigCallbackPairs`:
|
|
52
|
+
* one for visible-card impression accounting, one for 80% impression gating.
|
|
53
|
+
*/
|
|
54
|
+
const List = memo(
|
|
55
|
+
forwardRef(
|
|
56
|
+
<T, U extends { data: T[] }>(
|
|
57
|
+
{
|
|
58
|
+
loadMoreItems,
|
|
59
|
+
data,
|
|
60
|
+
minimumBatchSize,
|
|
61
|
+
threshold,
|
|
62
|
+
itemData,
|
|
63
|
+
RenderItem,
|
|
64
|
+
outerElementType,
|
|
65
|
+
itemKey,
|
|
66
|
+
overScanCount,
|
|
67
|
+
windowSize = 21,
|
|
68
|
+
onScroll,
|
|
69
|
+
style,
|
|
70
|
+
}: IVariableSizedListProps<T, U>,
|
|
71
|
+
forwardedRef: React.Ref<ListRef>,
|
|
72
|
+
) => {
|
|
73
|
+
const _ref = useRef<FlatList<T>>(null);
|
|
74
|
+
const mergedRef = useMergeRefs(_ref, forwardedRef);
|
|
75
|
+
|
|
76
|
+
const scrollMaintainingRef = useRef(false);
|
|
77
|
+
const observableChildRefs = useRef<Array<ScrollableObservableChild>>([]);
|
|
78
|
+
const isScrollToScrollingRef = useRef(false);
|
|
79
|
+
|
|
80
|
+
const viewableIndicesRef = useRef<Set<number>>(new Set());
|
|
81
|
+
|
|
82
|
+
const viewableItemsRef = useRef<Record<string, Record<string, unknown>>>({});
|
|
83
|
+
const initialRenderRef = useRef(false);
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* @description Collect viewable indices whose impression has not yet been
|
|
87
|
+
* fired for the current visibility pass.
|
|
88
|
+
*/
|
|
89
|
+
const getNonTriggeredViewableItems = useCallback(() => {
|
|
90
|
+
return new Set(
|
|
91
|
+
Object.keys(viewableItemsRef.current)
|
|
92
|
+
.filter((key) => {
|
|
93
|
+
return !viewableItemsRef.current[key].triggered;
|
|
94
|
+
})
|
|
95
|
+
.map((key) => {
|
|
96
|
+
return parseInt(key);
|
|
97
|
+
}),
|
|
98
|
+
);
|
|
99
|
+
}, []);
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* @description Flip the `triggered` flag to true across every currently
|
|
103
|
+
* tracked viewable item so we don't re-fire impressions until visibility
|
|
104
|
+
* changes again.
|
|
105
|
+
*/
|
|
106
|
+
const handleViewableItemsUpdate = useCallback(() => {
|
|
107
|
+
const updatedViewableItems = Object.keys(viewableItemsRef.current).reduce<
|
|
108
|
+
Record<string, Record<string, unknown>>
|
|
109
|
+
>((acc, curr) => {
|
|
110
|
+
acc[curr] = {
|
|
111
|
+
triggered: true,
|
|
112
|
+
};
|
|
113
|
+
return acc;
|
|
114
|
+
}, {});
|
|
115
|
+
|
|
116
|
+
viewableItemsRef.current = updatedViewableItems;
|
|
117
|
+
}, []);
|
|
118
|
+
|
|
119
|
+
const renderItem = useCallback(
|
|
120
|
+
({ item: row, index: rowIndex }: ListRenderItemInfo<T>) => {
|
|
121
|
+
return (
|
|
122
|
+
<ListItemProvider listId={rowIndex}>
|
|
123
|
+
<ItemRenderer
|
|
124
|
+
item={row}
|
|
125
|
+
index={rowIndex}
|
|
126
|
+
// @ts-expect-error - TODO: fix this
|
|
127
|
+
RenderItem={RenderItem}
|
|
128
|
+
itemData={itemData}
|
|
129
|
+
isVisible={false}
|
|
130
|
+
/>
|
|
131
|
+
</ListItemProvider>
|
|
132
|
+
);
|
|
133
|
+
},
|
|
134
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
135
|
+
[],
|
|
136
|
+
);
|
|
137
|
+
|
|
138
|
+
const getVisibleCards = (prevIndicesMap: Set<number>) => {
|
|
139
|
+
if (!areSetsEqual(prevIndicesMap, viewableIndicesRef.current)) {
|
|
140
|
+
return viewableIndicesRef.current;
|
|
141
|
+
}
|
|
142
|
+
return prevIndicesMap;
|
|
143
|
+
};
|
|
144
|
+
|
|
145
|
+
const onViewableItemsChanged = useCallback((props: { changed: ViewToken[]; viewableItems: ViewToken[] }) => {
|
|
146
|
+
let { viewableItems } = props;
|
|
147
|
+
const { changed } = props;
|
|
148
|
+
|
|
149
|
+
// Only keep the first item if multiple are viewable (rare with the
|
|
150
|
+
// 80% threshold used below for impressions, but common for the
|
|
151
|
+
// 60% gating threshold).
|
|
152
|
+
if (viewableItems.length > 1) {
|
|
153
|
+
const firstViewable = viewableItems.find((item) => item.isViewable);
|
|
154
|
+
viewableItems = firstViewable ? [firstViewable] : [];
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
const viewableItemsMap = new Set(
|
|
158
|
+
viewableItems.map((item) => item.index).filter((index): index is number => index !== null),
|
|
159
|
+
);
|
|
160
|
+
|
|
161
|
+
let changedList = false;
|
|
162
|
+
changed.forEach(({ index, isViewable }) => {
|
|
163
|
+
if (index !== null) {
|
|
164
|
+
if (!isViewable) {
|
|
165
|
+
viewableItemsMap.delete(index);
|
|
166
|
+
changedList = true;
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
if (changedList) {
|
|
172
|
+
observableChildRefs.current.forEach((child) => {
|
|
173
|
+
child.observe(getVisibleCards(viewableItemsMap), true);
|
|
174
|
+
});
|
|
175
|
+
}
|
|
176
|
+
viewableIndicesRef.current = viewableItemsMap;
|
|
177
|
+
}, []);
|
|
178
|
+
|
|
179
|
+
const impressionsOnViewableItemsChanged = useCallback(
|
|
180
|
+
(props: { changed: ViewToken[]; viewableItems: ViewToken[] }) => {
|
|
181
|
+
const { viewableItems } = props;
|
|
182
|
+
const { changed } = props;
|
|
183
|
+
|
|
184
|
+
viewableItems.forEach((item) => {
|
|
185
|
+
if (item.isViewable && item.index !== null && !viewableItemsRef.current.hasOwnProperty(item.index)) {
|
|
186
|
+
viewableItemsRef.current[item.index] = {
|
|
187
|
+
triggered: false,
|
|
188
|
+
};
|
|
189
|
+
}
|
|
190
|
+
});
|
|
191
|
+
|
|
192
|
+
changed.forEach((item) => {
|
|
193
|
+
if (!item.isViewable && item.index !== null && viewableItemsRef.current.hasOwnProperty(item.index)) {
|
|
194
|
+
delete viewableItemsRef.current[item.index];
|
|
195
|
+
}
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
if (!initialRenderRef.current) {
|
|
199
|
+
observableChildRefs.current.forEach((child) => {
|
|
200
|
+
child.observe(getNonTriggeredViewableItems());
|
|
201
|
+
});
|
|
202
|
+
handleViewableItemsUpdate();
|
|
203
|
+
initialRenderRef.current = true;
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
207
|
+
[],
|
|
208
|
+
);
|
|
209
|
+
|
|
210
|
+
const localViewabilityConfig = {
|
|
211
|
+
waitForInteraction: false,
|
|
212
|
+
minimumViewTime: 0,
|
|
213
|
+
itemVisiblePercentThreshold: 60,
|
|
214
|
+
};
|
|
215
|
+
|
|
216
|
+
const impressionsViewabilityConfig = {
|
|
217
|
+
waitForInteraction: false,
|
|
218
|
+
minimumViewTime: 100,
|
|
219
|
+
itemVisiblePercentThreshold: 80,
|
|
220
|
+
};
|
|
221
|
+
|
|
222
|
+
const viewabilityConfigCallbackPairs = useRef([
|
|
223
|
+
{ viewabilityConfig: localViewabilityConfig, onViewableItemsChanged },
|
|
224
|
+
{
|
|
225
|
+
viewabilityConfig: impressionsViewabilityConfig,
|
|
226
|
+
onViewableItemsChanged: impressionsOnViewableItemsChanged,
|
|
227
|
+
},
|
|
228
|
+
]);
|
|
229
|
+
|
|
230
|
+
return (
|
|
231
|
+
<ScrollContextProvider
|
|
232
|
+
isScrolling={false}
|
|
233
|
+
refs={{}}
|
|
234
|
+
isScrollToScrolling={isScrollToScrollingRef.current}
|
|
235
|
+
observableChildRefs={observableChildRefs.current}
|
|
236
|
+
horizontal={false}
|
|
237
|
+
isList={true}
|
|
238
|
+
>
|
|
239
|
+
<FlatList
|
|
240
|
+
data={data}
|
|
241
|
+
renderItem={renderItem}
|
|
242
|
+
onEndReached={loadMoreItems}
|
|
243
|
+
initialNumToRender={minimumBatchSize}
|
|
244
|
+
windowSize={windowSize}
|
|
245
|
+
maxToRenderPerBatch={(minimumBatchSize ?? 0) + (overScanCount ?? 0)}
|
|
246
|
+
onEndReachedThreshold={threshold}
|
|
247
|
+
keyExtractor={itemKey}
|
|
248
|
+
ListFooterComponent={outerElementType}
|
|
249
|
+
viewabilityConfig={localViewabilityConfig}
|
|
250
|
+
viewabilityConfigCallbackPairs={viewabilityConfigCallbackPairs.current}
|
|
251
|
+
ref={mergedRef}
|
|
252
|
+
ItemSeparatorComponent={() => <View style={staticStyles.itemSeparator} />}
|
|
253
|
+
contentContainerStyle={style}
|
|
254
|
+
removeClippedSubviews={true}
|
|
255
|
+
showsHorizontalScrollIndicator={false}
|
|
256
|
+
showsVerticalScrollIndicator={false}
|
|
257
|
+
alwaysBounceHorizontal={false}
|
|
258
|
+
alwaysBounceVertical={false}
|
|
259
|
+
onScroll={(e) => {
|
|
260
|
+
onScroll?.({
|
|
261
|
+
currentTarget: {
|
|
262
|
+
scrollTop: e.nativeEvent.contentOffset.y,
|
|
263
|
+
scrollLeft: e.nativeEvent.contentOffset.x,
|
|
264
|
+
scrollHeight: e.nativeEvent.contentSize.height,
|
|
265
|
+
scrollWidth: e.nativeEvent.contentSize.width,
|
|
266
|
+
clientHeight: e.nativeEvent.layoutMeasurement.height,
|
|
267
|
+
clientWidth: e.nativeEvent.layoutMeasurement.width,
|
|
268
|
+
offsetLeft: e.nativeEvent.contentOffset.x,
|
|
269
|
+
offsetTop: e.nativeEvent.contentOffset.y,
|
|
270
|
+
horizontalScrollVelocity: e.nativeEvent.velocity?.x,
|
|
271
|
+
verticalScrollVelocity: e.nativeEvent.velocity?.y,
|
|
272
|
+
},
|
|
273
|
+
});
|
|
274
|
+
scrollMaintainingRef.current = true;
|
|
275
|
+
}}
|
|
276
|
+
onScrollEndDrag={() => {
|
|
277
|
+
/**
|
|
278
|
+
* !NOTE:
|
|
279
|
+
* Drives impression events. Known caveat: video items at the 2nd
|
|
280
|
+
* carousel index are not yet handled. Revisit if the
|
|
281
|
+
* impression-on-scroll-end approach here causes issues.
|
|
282
|
+
*/
|
|
283
|
+
if (scrollMaintainingRef.current) {
|
|
284
|
+
setTimeout(() => {
|
|
285
|
+
observableChildRefs.current.forEach((child) => {
|
|
286
|
+
child.observe(getNonTriggeredViewableItems());
|
|
287
|
+
});
|
|
288
|
+
handleViewableItemsUpdate();
|
|
289
|
+
}, 200);
|
|
290
|
+
}
|
|
291
|
+
scrollMaintainingRef.current = false;
|
|
292
|
+
}}
|
|
293
|
+
onMomentumScrollEnd={() => {
|
|
294
|
+
if (scrollMaintainingRef.current) {
|
|
295
|
+
scrollMaintainingRef.current = false;
|
|
296
|
+
setTimeout(() => {
|
|
297
|
+
observableChildRefs.current.forEach((child) => {
|
|
298
|
+
child.observe(getNonTriggeredViewableItems());
|
|
299
|
+
});
|
|
300
|
+
handleViewableItemsUpdate();
|
|
301
|
+
}, 200);
|
|
302
|
+
}
|
|
303
|
+
}}
|
|
304
|
+
bounces={false}
|
|
305
|
+
scrollEventThrottle={1}
|
|
306
|
+
/>
|
|
307
|
+
</ScrollContextProvider>
|
|
308
|
+
);
|
|
309
|
+
},
|
|
310
|
+
),
|
|
311
|
+
) as unknown as <T, U extends { data: T[] }>(
|
|
312
|
+
props: IVariableSizedListProps<T, U> & { ref?: React.Ref<ListRef> },
|
|
313
|
+
) => React.JSX.Element;
|
|
314
|
+
|
|
315
|
+
(List as unknown as { displayName: string }).displayName = 'List';
|
|
316
|
+
|
|
317
|
+
export default List;
|
package/src/List.tsx
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { CSSProperties, forwardRef, memo, useCallback, useRef } from 'react';
|
|
2
|
+
|
|
3
|
+
import { VariableSizeList as ReactWindowList, ListChildComponentProps, ListOnScrollProps } from 'react-window';
|
|
4
|
+
import InfiniteLoader from 'react-window-infinite-loader';
|
|
5
|
+
|
|
6
|
+
import { IVariableSizedListProps, ListRef } from './type';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Web `List` — thin wrapper around `react-window`'s `VariableSizeList`
|
|
10
|
+
* + `react-window-infinite-loader` for lazy loading.
|
|
11
|
+
*
|
|
12
|
+
* NOTE: animation hooks on the web side are intentionally not wired up yet;
|
|
13
|
+
* see the TODO in the original yagami implementation.
|
|
14
|
+
*/
|
|
15
|
+
const List = memo(
|
|
16
|
+
forwardRef<ListRef, IVariableSizedListProps<unknown, { data: unknown[] }>>(
|
|
17
|
+
(
|
|
18
|
+
{
|
|
19
|
+
loadMoreItems,
|
|
20
|
+
data,
|
|
21
|
+
minimumBatchSize,
|
|
22
|
+
threshold,
|
|
23
|
+
itemCount,
|
|
24
|
+
itemSize,
|
|
25
|
+
itemData,
|
|
26
|
+
RenderItem,
|
|
27
|
+
height,
|
|
28
|
+
width,
|
|
29
|
+
style,
|
|
30
|
+
outerElementType,
|
|
31
|
+
overScanCount,
|
|
32
|
+
onScroll,
|
|
33
|
+
},
|
|
34
|
+
// react-window's ref is a VariableSizeList instance; the public ListRef
|
|
35
|
+
// is only partially satisfied (scrollToEnd isn't exposed by react-window
|
|
36
|
+
// directly). Consumers that need it typically wrap and call scrollTo.
|
|
37
|
+
|
|
38
|
+
_forwardedRef,
|
|
39
|
+
) => {
|
|
40
|
+
const listRef = useRef<ReactWindowList<{ data: unknown[] }>>(null);
|
|
41
|
+
|
|
42
|
+
const isRowLoaded = (index: number) => {
|
|
43
|
+
return index < data.length;
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
// TODO: add web-based implementation for row enter / exit animations.
|
|
47
|
+
const RenderListItem = useCallback(({ data: listData, index }: ListChildComponentProps<{ data: unknown[] }>) => {
|
|
48
|
+
return <RenderItem item={listData.data[index]} index={index} itemData={itemData} isVisible={false} />;
|
|
49
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
50
|
+
}, []);
|
|
51
|
+
|
|
52
|
+
return (
|
|
53
|
+
// nicely with React 18's children-as-function pattern here.
|
|
54
|
+
<InfiniteLoader
|
|
55
|
+
isItemLoaded={isRowLoaded}
|
|
56
|
+
itemCount={itemCount}
|
|
57
|
+
loadMoreItems={loadMoreItems}
|
|
58
|
+
minimumBatchSize={minimumBatchSize}
|
|
59
|
+
threshold={threshold}
|
|
60
|
+
>
|
|
61
|
+
{({ onItemsRendered }) => {
|
|
62
|
+
return (
|
|
63
|
+
// data generic which we relax here for wrapper ergonomics.
|
|
64
|
+
<ReactWindowList
|
|
65
|
+
height={height}
|
|
66
|
+
width={width}
|
|
67
|
+
itemCount={itemCount}
|
|
68
|
+
itemSize={itemSize}
|
|
69
|
+
itemData={itemData}
|
|
70
|
+
ref={listRef}
|
|
71
|
+
style={style as CSSProperties}
|
|
72
|
+
// outerElementType at runtime.
|
|
73
|
+
outerElementType={outerElementType}
|
|
74
|
+
overscanCount={overScanCount}
|
|
75
|
+
useIsScrolling
|
|
76
|
+
onItemsRendered={(params) => {
|
|
77
|
+
onItemsRendered(params);
|
|
78
|
+
}}
|
|
79
|
+
onScroll={(e: ListOnScrollProps) => {
|
|
80
|
+
onScroll?.({
|
|
81
|
+
currentTarget: {
|
|
82
|
+
scrollTop: e.scrollOffset,
|
|
83
|
+
scrollLeft: 0,
|
|
84
|
+
scrollHeight: 0,
|
|
85
|
+
scrollWidth: 0,
|
|
86
|
+
clientHeight: 0,
|
|
87
|
+
clientWidth: 0,
|
|
88
|
+
offsetLeft: 0,
|
|
89
|
+
offsetTop: 0,
|
|
90
|
+
horizontalScrollVelocity: 0,
|
|
91
|
+
},
|
|
92
|
+
});
|
|
93
|
+
}}
|
|
94
|
+
>
|
|
95
|
+
{RenderListItem}
|
|
96
|
+
</ReactWindowList>
|
|
97
|
+
);
|
|
98
|
+
}}
|
|
99
|
+
</InfiniteLoader>
|
|
100
|
+
);
|
|
101
|
+
},
|
|
102
|
+
),
|
|
103
|
+
) as unknown as <T, U extends { data: T[] }>(
|
|
104
|
+
props: IVariableSizedListProps<T, U> & { ref?: React.Ref<ListRef> },
|
|
105
|
+
) => React.JSX.Element;
|
|
106
|
+
|
|
107
|
+
(List as unknown as { displayName: string }).displayName = 'List';
|
|
108
|
+
|
|
109
|
+
export default List;
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { createContext, FC, ReactNode, useContext } from 'react';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Exposes the row index of the enclosing virtualised List item to descendants.
|
|
5
|
+
* Ported from yagami `@aldenui/components/Context/ListItemContext` so the List
|
|
6
|
+
* package stays self-contained.
|
|
7
|
+
*/
|
|
8
|
+
interface ListItemContextType {
|
|
9
|
+
listId: number;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
const ListItemContext = createContext<ListItemContextType | undefined>(undefined);
|
|
13
|
+
|
|
14
|
+
interface ListItemProviderProps {
|
|
15
|
+
children: ReactNode;
|
|
16
|
+
listId: number;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export const ListItemProvider: FC<ListItemProviderProps> = ({ children, listId }) => {
|
|
20
|
+
return <ListItemContext.Provider value={{ listId }}>{children}</ListItemContext.Provider>;
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Read the enclosing list row's id. Returns `{ listId: -1 }` if called
|
|
25
|
+
* outside a `ListItemProvider`.
|
|
26
|
+
*/
|
|
27
|
+
export const useListItem = () => {
|
|
28
|
+
const context = useContext(ListItemContext);
|
|
29
|
+
if (context === undefined) {
|
|
30
|
+
return { listId: -1 };
|
|
31
|
+
}
|
|
32
|
+
return context;
|
|
33
|
+
};
|
package/src/index.ts
ADDED
package/src/type.ts
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import type { FunctionComponent, Ref } from 'react';
|
|
2
|
+
|
|
3
|
+
import type { Styles } from '@cleartrip/ct-design-types';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Item renderer prop bag passed to the caller's `RenderItem` component.
|
|
7
|
+
*/
|
|
8
|
+
export interface IListItemRendererProps<T, U> {
|
|
9
|
+
item: T;
|
|
10
|
+
index: number;
|
|
11
|
+
itemData: U;
|
|
12
|
+
isVisible: boolean;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export interface IVariableSizedListProps<T, U extends { data: T[] }> {
|
|
16
|
+
data: T[];
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Callback to be invoked when more rows must be loaded.
|
|
20
|
+
* Should return a Promise that resolves once all data has finished loading.
|
|
21
|
+
*/
|
|
22
|
+
loadMoreItems: () => Promise<void> | void;
|
|
23
|
+
|
|
24
|
+
/** Key extractor used to uniquely identify a row. */
|
|
25
|
+
itemKey: (item: T, index: number) => string;
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Number of items (rows or columns) to render outside of the visible area.
|
|
29
|
+
* Defaults to one item. Overscanning too much can negatively impact performance.
|
|
30
|
+
*/
|
|
31
|
+
windowSize?: number;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Minimum number of rows to be loaded at a time; defaults to 10.
|
|
35
|
+
* Used to batch requests to reduce HTTP traffic.
|
|
36
|
+
*/
|
|
37
|
+
minimumBatchSize?: number | undefined;
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Threshold at which to pre-fetch data; defaults to 15. Data will start
|
|
41
|
+
* loading when the user scrolls within this many rows of the end.
|
|
42
|
+
*/
|
|
43
|
+
threshold?: number | undefined;
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Height of the list. For vertical lists this must be a number — it
|
|
47
|
+
* drives how many rows will be rendered at once. For horizontal lists
|
|
48
|
+
* this can be a number or a string (e.g. "50%").
|
|
49
|
+
*/
|
|
50
|
+
height: number | string;
|
|
51
|
+
|
|
52
|
+
/** Total count of items in the data source (including not-yet-loaded ones). */
|
|
53
|
+
itemCount: number;
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Width of the list. For horizontal lists this must be a number. For
|
|
57
|
+
* vertical lists it can be a number or string (e.g. "50%").
|
|
58
|
+
*/
|
|
59
|
+
width: number | string;
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Size of a single item in the windowed direction.
|
|
63
|
+
* For vertical lists this is the row height; for horizontal lists,
|
|
64
|
+
* the column width.
|
|
65
|
+
*/
|
|
66
|
+
itemSize: (index: number) => number;
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Contextual data passed to the row renderer via the `itemData` prop.
|
|
70
|
+
* Light-weight alternative to React's built-in context API; useful for
|
|
71
|
+
* class-component row renderers.
|
|
72
|
+
*/
|
|
73
|
+
itemData: U;
|
|
74
|
+
|
|
75
|
+
/** Inline style applied to the scroll container (web) / content container (native). */
|
|
76
|
+
style?: Styles;
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Number of items to render outside the visible area.
|
|
80
|
+
* Note: overscanning too much can negatively impact performance.
|
|
81
|
+
*/
|
|
82
|
+
overScanCount: number;
|
|
83
|
+
|
|
84
|
+
/** Forwarded ref for imperative handles (`scrollToEnd`, etc.). */
|
|
85
|
+
ref?: Ref<ListRef>;
|
|
86
|
+
|
|
87
|
+
/** Row component rendered per data item. */
|
|
88
|
+
RenderItem: FunctionComponent<IListItemRendererProps<T, U>>;
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Tag name passed to `document.createElement` to create the outer container
|
|
92
|
+
* element (web only; in most cases the default "div" should be used).
|
|
93
|
+
* On native, this is used as the `ListFooterComponent`.
|
|
94
|
+
*/
|
|
95
|
+
outerElementType?: FunctionComponent<unknown>;
|
|
96
|
+
|
|
97
|
+
/** Whether the list is virtualised. Reserved for future non-virtualised use. */
|
|
98
|
+
isVirtualized?: boolean;
|
|
99
|
+
|
|
100
|
+
/** Whether the list row is being recycled. */
|
|
101
|
+
isRecycled?: boolean;
|
|
102
|
+
|
|
103
|
+
onScroll?: (props: ListScrollEvent) => void;
|
|
104
|
+
setCardHeight?: (index: number, size: number) => void;
|
|
105
|
+
handleItemsRendered?: (props: unknown) => void;
|
|
106
|
+
onItemsRendered?: (props: unknown) => void;
|
|
107
|
+
}
|
|
108
|
+
export type ListScrollEvent = {
|
|
109
|
+
currentTarget: {
|
|
110
|
+
scrollTop?: number;
|
|
111
|
+
scrollLeft?: number;
|
|
112
|
+
scrollHeight?: number;
|
|
113
|
+
scrollWidth?: number;
|
|
114
|
+
clientHeight?: number;
|
|
115
|
+
clientWidth?: number;
|
|
116
|
+
offsetHeight?: number;
|
|
117
|
+
offsetWidth?: number;
|
|
118
|
+
offsetLeft?: number;
|
|
119
|
+
offsetTop?: number;
|
|
120
|
+
horizontalScrollVelocity?: number;
|
|
121
|
+
verticalScrollVelocity?: number;
|
|
122
|
+
topTargetContentOffset?: number;
|
|
123
|
+
leftTargetContentOffset?: number;
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
export type ListRef = {
|
|
128
|
+
scrollToEnd: () => void;
|
|
129
|
+
};
|
package/src/utils.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shallow equality check for two sets of numbers.
|
|
3
|
+
* Ported from yagami `hotels-pwa/src/utils/utility.ts` so the List package
|
|
4
|
+
* stays self-contained.
|
|
5
|
+
*/
|
|
6
|
+
export const areSetsEqual = (a: Set<number>, b: Set<number>) => {
|
|
7
|
+
if (a.size !== b.size) return false;
|
|
8
|
+
for (const item of Array.from(a)) {
|
|
9
|
+
if (!b.has(item)) return false;
|
|
10
|
+
}
|
|
11
|
+
return true;
|
|
12
|
+
};
|