Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ updates:
time: '21:00'
timezone: Asia/Shanghai
open-pull-requests-limit: 10
groups:
npm-dependencies:
patterns:
- '*'

- package-ecosystem: github-actions
directory: '/'
Expand All @@ -17,3 +21,7 @@ updates:
time: '21:00'
timezone: Asia/Shanghai
open-pull-requests-limit: 10
groups:
github-actions:
patterns:
- '*'
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<h1>@rc-component/virtual-list</h1>
<p><sub><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /> Part of the Ant Design ecosystem.</sub></p>
<p><sub><a href="https://ant.design"><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /></a> Part of the Ant Design ecosystem.</sub></p>
<p>📜 Virtual scrolling list component for React.</p>

<p>
Expand Down
2 changes: 1 addition & 1 deletion README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<h1>@rc-component/virtual-list</h1>
<p><sub><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /> Ant Design 生态的一部分。</sub></p>
<p><sub><a href="https://ant.design"><img alt="Ant Design" height="14" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" style="vertical-align: -0.125em;" /></a> Ant Design 生态的一部分。</sub></p>
<p>📜 React 虚拟列表组件,用于高性能渲染长列表。</p>

<p>
Expand Down
88 changes: 88 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import { FlatCompat } from '@eslint/eslintrc';
import js from '@eslint/js';
import tsEslintPlugin from '@typescript-eslint/eslint-plugin';
import { createRequire } from 'node:module';
import path from 'node:path';
import { fileURLToPath } from 'node:url';

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const require = createRequire(import.meta.url);

const compat = new FlatCompat({
baseDirectory: __dirname,
recommendedConfig: js.configs.recommended,
allConfig: js.configs.all,
});

const recommendedTsRulesConfig = tsEslintPlugin.configs.recommended;
const recommendedTsRulesObject = Array.isArray(recommendedTsRulesConfig)
? recommendedTsRulesConfig.reduce(
(rules, config) => ({ ...rules, ...(config.rules || {}) }),
{},
)
: recommendedTsRulesConfig?.rules || {};
const recommendedTsRules = new Set(Object.keys(recommendedTsRulesObject));
const noopRule = {
meta: { type: 'problem', docs: {}, schema: [] },
create: () => ({}),
};

function normalizeConfig(config) {
const next = { ...config };

if (next.plugins?.['@typescript-eslint']) {
next.plugins = { ...next.plugins };
delete next.plugins['@typescript-eslint'];
}

if (next.rules) {
next.rules = Object.fromEntries(
Object.entries(next.rules).filter(([ruleName]) => {
if (!ruleName.startsWith('@typescript-eslint/')) {
return true;
}
return recommendedTsRules.has(ruleName);
}),
);
}

return next;
}

export default [
{
ignores: [
'node_modules/',
'coverage/',
'es/',
'lib/',
'dist/',
'docs-dist/',
'.dumi/',
'.doc/',
'.vercel/',
'.eslintrc.js',
'src/index.d.ts',
],
},
{
plugins: {
'@typescript-eslint': {
...tsEslintPlugin,
rules: {
...tsEslintPlugin.rules,
'consistent-type-exports': noopRule,
},
},
},
},
...compat.config(require('./.eslintrc.js')).map(normalizeConfig),
{
rules: {
'@typescript-eslint/no-empty-object-type': 'off',
'@typescript-eslint/no-unsafe-function-type': 'off',
'@typescript-eslint/no-unused-vars': 'off',

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Disabling @typescript-eslint/no-unused-vars globally is not recommended as it can lead to dead code and undetected bugs. Consider setting it to 'warn' or configuring it to ignore variables prefixed with an underscore.

Suggested change
'@typescript-eslint/no-unused-vars': 'off',
'@typescript-eslint/no-unused-vars': 'warn',

},
},
];
4 changes: 2 additions & 2 deletions examples/no-virtual.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ interface Item {
height: number;
}

const MyItem: React.FC<Item> = ({ id, height }, ref) => {
const MyItem = React.forwardRef<HTMLSpanElement, Item>(({ id, height }, ref) => {
return (
<span
ref={ref}
Expand All @@ -23,7 +23,7 @@ const MyItem: React.FC<Item> = ({ id, height }, ref) => {
{id}
</span>
);
};
});

const ForwardMyItem = React.forwardRef(MyItem as any);

Expand Down
4 changes: 2 additions & 2 deletions examples/switch.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ interface Item {
id: number;
}

const MyItem: React.FC<Item> = ({ id }, ref) => (
const MyItem = React.forwardRef<HTMLSpanElement, Item>(({ id }, ref) => (
<span
ref={ref}
style={{
Expand All @@ -21,7 +21,7 @@ const MyItem: React.FC<Item> = ({ id }, ref) => (
>
{id}
</span>
);
));

const ForwardMyItem = React.forwardRef(MyItem as any);

Expand Down
48 changes: 48 additions & 0 deletions global.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/// <reference types="jest" />
/// <reference types="node" />
/// <reference types="react" />
/// <reference types="react-dom" />
/// <reference types="@testing-library/jest-dom" />

declare module '*.css';
declare module '*.less';
declare module 'jsonp';

declare namespace JSX {
type Element = React.JSX.Element;
interface ElementClass extends React.JSX.ElementClass {}
interface ElementAttributesProperty extends React.JSX.ElementAttributesProperty {}
interface ElementChildrenAttribute extends React.JSX.ElementChildrenAttribute {}
type LibraryManagedAttributes<C, P> = React.JSX.LibraryManagedAttributes<C, P>;
interface IntrinsicAttributes extends React.JSX.IntrinsicAttributes {}
interface IntrinsicClassAttributes<T> extends React.JSX.IntrinsicClassAttributes<T> {}
interface IntrinsicElements extends React.JSX.IntrinsicElements {}
}

declare namespace jest {
interface Matchers<R> {
lastCalledWith(...expected: unknown[]): R;
nthCalledWith(nthCall: number, ...expected: unknown[]): R;
toBeCalled(): R;
toBeCalledTimes(expected: number): R;
toBeCalledWith(...expected: unknown[]): R;
}
}

declare const vi: {
fn: <T extends (...args: any[]) => any = (...args: any[]) => any>(implementation?: T) => jest.MockedFunction<T>;
mock: (moduleName: string, factory?: (importOriginal: <T>() => Promise<T>) => unknown) => void;
spyOn: typeof jest.spyOn;
useFakeTimers: () => void;
useRealTimers: () => void;
advanceTimersByTime: (msToRun: number) => void;
clearAllTimers: () => void;
runAllTimers: () => void;
importActual: <T>(moduleName: string) => Promise<T>;
clearAllMocks: () => void;
resetAllMocks: () => void;
restoreAllMocks: () => void;
};


declare module 'moment/locale/zh-cn';
39 changes: 25 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,30 +48,41 @@
"react-dom": ">=18.0.0"
},
"devDependencies": {
"@babel/eslint-parser": "^7.29.7",
"@babel/eslint-plugin": "^7.29.7",
"@eslint/eslintrc": "^3.3.5",
"@eslint/js": "^9.39.4",
"@rc-component/father-plugin": "^2.2.0",
"@rc-component/np": "^1.0.4",
"@testing-library/dom": "^10.4.1",
"@testing-library/jest-dom": "^6.9.1",
"@testing-library/react": "^15.0.7",
"@types/jest": "^29.5.14",
"@testing-library/react": "^16.3.2",
"@types/jest": "^30.0.0",
"@types/node": "^26.0.1",
"@types/react": "^18.3.31",
"@types/react-dom": "^18.3.7",
"@types/react": "^19.2.17",
"@types/react-dom": "^19.2.3",
"@types/warning": "^3.0.4",
"@typescript-eslint/eslint-plugin": "^8.62.0",
"@typescript-eslint/parser": "^8.62.0",
"cross-env": "^10.1.0",
"dumi": "^2.4.35",
"eslint": "^8.57.1",
"eslint-plugin-unicorn": "^56.0.1",
"eslint": "^9.39.4",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-jest": "^29.15.3",
"eslint-plugin-react": "^7.37.5",
"eslint-plugin-react-hooks": "^7.1.1",
"eslint-plugin-unicorn": "^65.0.1",
"father": "^4.6.23",
"gh-pages": "^6.3.0",
"glob": "^13.0.6",
"husky": "^9.1.7",
"lint-staged": "^17.0.8",
"prettier": "^3.9.0",
"rc-animate": "^2.9.1",
"rc-test": "^7.1.3",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"typescript": "^5.9.3",
"cross-env": "^10.1.0",
"gh-pages": "^6.3.0",
"prettier": "^3.9.0",
"husky": "^9.1.7",
"lint-staged": "^16.4.0"
"react": "^19.2.7",
"react-dom": "^19.2.7",
"typescript": "^6.0.3"
},
"dependencies": {
"@babel/runtime": "^7.20.0",
Expand Down
12 changes: 12 additions & 0 deletions react-compat.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import * as React from 'react';

declare module 'react' {
type ReactText = string | number;
function useRef<T = undefined>(): React.MutableRefObject<T | undefined>;
function isValidElement<P = any>(object: {} | null | undefined): object is React.ReactElement<P>;
function cloneElement<P = any>(
element: React.ReactElement<P>,
props?: (Partial<P> & React.Attributes) | null,
...children: React.ReactNode[]
): React.ReactElement<P>;
}
11 changes: 7 additions & 4 deletions src/Item.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ export interface ItemProps {
}

export function Item({ children, setRef }: ItemProps) {
const refFunc = React.useCallback(node => {
setRef(node);
}, []);
const refFunc = React.useCallback(
node => {
setRef(node);
},
[setRef],
);

return React.cloneElement(children, {
return React.cloneElement(children as React.ReactElement<any>, {
ref: refFunc,
});
}
24 changes: 16 additions & 8 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,32 +1,40 @@
{
"compilerOptions": {
"target": "esnext",
"moduleResolution": "node",
"baseUrl": "./",
"moduleResolution": "bundler",
"jsx": "react",
"declaration": true,
"skipLibCheck": true,
"esModuleInterop": true,
"paths": {
"@/*": [
"src/*"
"./src/*"
],
"@@/*": [
".dumi/tmp/*"
"./.dumi/tmp/*"
],
"@rc-component/virtual-list": [
"src/index.ts"
"./src/index.ts"
],
"@rc-component/virtual-list/es": [
"src"
"./src"
],
"@rc-component/virtual-list/es/*": [
"src/*"
"./src/*"
]
},
"ignoreDeprecations": "5.0"
"noImplicitAny": false,
"strictNullChecks": false,
"strictPropertyInitialization": false,
"strictFunctionTypes": false,
"strict": false,
"noImplicitThis": false,
"strictBindCallApply": false,
"module": "ESNext"
},
"include": [
"react-compat.d.ts",
"global.d.ts",
".dumirc.ts",
".fatherrc.ts",
"src",
Expand Down
Loading