Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: virtual list #546

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+156 −110
Open

feat: virtual list #546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@
"classnames": "^2.3.1",
"rc-select": "~14.16.2",
"rc-tree": "~5.10.1",
"rc-util": "^5.43.0"
"rc-util": "^5.43.0",
"rc-virtual-list": "^3.14.8"
},
"devDependencies": {
"@rc-component/father-plugin": "^1.0.0",
Expand Down
13 changes: 13 additions & 0 deletions src/Cascader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@ interface BaseCascaderProps<
// Icon
expandIcon?: React.ReactNode;
loadingIcon?: React.ReactNode;

virtual?: boolean;
listHeight?: number;
listItemHeight?: number;
}

export interface FieldNames<
Expand Down Expand Up @@ -232,6 +236,9 @@ const Cascader = React.forwardRef<CascaderRef, InternalCascaderProps>((props, re
dropdownMatchSelectWidth = false,
showCheckedStrategy = SHOW_PARENT,
optionRender,
virtual = true,
listHeight = 170,
listItemHeight = 28,
...restProps
} = props;

Expand Down Expand Up @@ -407,6 +414,9 @@ const Cascader = React.forwardRef<CascaderRef, InternalCascaderProps>((props, re
loadingIcon,
dropdownMenuColumnStyle,
optionRender,
virtual,
listHeight,
listItemHeight,
}),
[
mergedOptions,
Expand All @@ -424,6 +434,9 @@ const Cascader = React.forwardRef<CascaderRef, InternalCascaderProps>((props, re
loadingIcon,
dropdownMenuColumnStyle,
optionRender,
virtual,
listHeight,
listItemHeight,
],
);

Expand Down
247 changes: 138 additions & 109 deletions src/OptionList/Column.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
import { SEARCH_MARK } from '../hooks/useSearchOptions';
import { isLeaf, toPathKey } from '../utils/commonUtil';
import Checkbox from './Checkbox';
import List from 'rc-virtual-list';
import type { ListRef } from 'rc-virtual-list';

export const FIX_LABEL = '__cascader_fix_label__';

Expand Down Expand Up @@ -41,6 +43,7 @@
isSelectable,
disabled: propsDisabled,
}: ColumnProps<OptionType>) {
const ref = React.useRef<ListRef>(null);
const menuPrefixCls = `${prefixCls}-menu`;
const menuItemPrefixCls = `${prefixCls}-menu-item`;

Expand All @@ -52,6 +55,9 @@
loadingIcon,
dropdownMenuColumnStyle,
optionRender,
virtual,
listItemHeight,
listHeight,
Comment on lines +58 to +60
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

建议为虚拟列表配置提供默认值

为了确保组件在未提供这些配置时也能正常工作，建议：

  1. 为 virtual 提供默认值 false
  2. 为 listHeight 和 listItemHeight 提供合理的默认值

} = React.useContext(CascaderContext);

const hoverOpen = expandTrigger === 'hover';
Expand Down Expand Up @@ -101,117 +107,140 @@
);

// ============================ Render ============================
return (
<ul className={menuPrefixCls} role="menu">
{optionInfoList.map(
({
disabled,
label,
value,
isLeaf: isMergedLeaf,
isLoading,
checked,
halfChecked,
option,
fullPath,
fullPathKey,
disableCheckbox,
}) => {
// >>>>> Open
const triggerOpenPath = () => {
if (isOptionDisabled(disabled)) {
return;
}
const nextValueCells = [...fullPath];
if (hoverOpen && isMergedLeaf) {
nextValueCells.pop();
}
onActive(nextValueCells);
};

// >>>>> Selection
const triggerSelect = () => {
if (isSelectable(option) && !isOptionDisabled(disabled)) {
onSelect(fullPath, isMergedLeaf);
}
};

// >>>>> Title
let title: string | undefined;
if (typeof option.title === 'string') {
title = option.title;
} else if (typeof label === 'string') {
title = label;

// scrollIntoView effect in virtual list
React.useEffect(() => {
if (virtual && ref.current && activeValue) {
const startIndex = optionInfoList.findIndex(({ value }) => value === activeValue);
ref.current.scrollTo({ index: startIndex, align: 'auto' });
}
}, [optionInfoList, virtual, activeValue])
Comment on lines +112 to +117
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

检查 activeValue 不存在时的处理

在 useEffect 中，当 activeValue 不存在于 optionInfoList 时，findIndex 将返回 -1，调用 scrollTo({ index: -1 }) 可能导致异常行为。建议在调用 scrollTo 前，增加对 startIndex 是否大于等于 0 的判断。

建议修改如下：

React.useEffect(() => {
  if (virtual && ref.current && activeValue) {
    const startIndex = optionInfoList.findIndex(({ value }) => value === activeValue);
+   if (startIndex >= 0) {
      ref.current.scrollTo({ index: startIndex, align: 'auto' });
+   }
  }
}, [optionInfoList, virtual, activeValue]);
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
React.useEffect(() => {
if (virtual && ref.current && activeValue) {
const startIndex = optionInfoList.findIndex(({ value }) => value === activeValue);
ref.current.scrollTo({ index: startIndex, align: 'auto' });
}
}, [optionInfoList, virtual, activeValue])
React.useEffect(() => {
if (virtual && ref.current && activeValue) {
const startIndex = optionInfoList.findIndex(({ value }) => value === activeValue);
if (startIndex >= 0) {
ref.current.scrollTo({ index: startIndex, align: 'auto' });
}
}
}, [optionInfoList, virtual, activeValue])

Fixed Show fixed Hide fixed

Check notice

Code scanning / CodeQL

Semicolon insertion Note

Avoid automated semicolon insertion (90% of all statements in
the enclosing function
Loading
have an explicit semicolon).

const renderLi = (item: typeof optionInfoList[0]) => {
const {
disabled,
label,
value,
isLeaf: isMergedLeaf,
isLoading,
checked,
halfChecked,
option,
fullPath,
fullPathKey,
disableCheckbox
} = item;

const triggerOpenPath = () => {
if (isOptionDisabled(disabled)) {
return;
}
const nextValueCells = [...fullPath];
if (hoverOpen && isMergedLeaf) {
nextValueCells.pop();
}
onActive(nextValueCells);
};

// >>>>> Selection
const triggerSelect = () => {
if (isSelectable(option) && !isOptionDisabled(disabled)) {
onSelect(fullPath, isMergedLeaf);
}
};

// >>>>> Title
let title: string | undefined;
if (typeof option.title === 'string') {
title = option.title;
} else if (typeof label === 'string') {
title = label;
}

// >>>>> Render
return (
<li
key={fullPathKey}
className={classNames(menuItemPrefixCls, {
[`${menuItemPrefixCls}-expand`]: !isMergedLeaf,
[`${menuItemPrefixCls}-active`]:
activeValue === value || activeValue === fullPathKey,
[`${menuItemPrefixCls}-disabled`]: isOptionDisabled(disabled),
[`${menuItemPrefixCls}-loading`]: isLoading,
})}
style={dropdownMenuColumnStyle}
role="menuitemcheckbox"
title={title}
aria-checked={checked}
data-path-key={fullPathKey}
onClick={() => {
triggerOpenPath();
if (disableCheckbox) {
return;
}
if (!multiple || isMergedLeaf) {
triggerSelect();
}
}}
onDoubleClick={() => {
if (changeOnSelect) {
onToggleOpen(false);
}
}}
onMouseEnter={() => {
if (hoverOpen) {
triggerOpenPath();
}
}}
onMouseDown={e => {
// Prevent selector from blurring
e.preventDefault();
}}
>
{multiple && (
<Checkbox
prefixCls={`${prefixCls}-checkbox`}
checked={checked}
halfChecked={halfChecked}
disabled={isOptionDisabled(disabled) || disableCheckbox}
disableCheckbox={disableCheckbox}
onClick={(e: React.MouseEvent<HTMLSpanElement>) => {
if (disableCheckbox) {
return;
}
e.stopPropagation();
triggerSelect();
}}
/>
)}
<div className={`${menuItemPrefixCls}-content`}>
{optionRender ? optionRender(option) : label}
</div>
{!isLoading && expandIcon && !isMergedLeaf && (
<div className={`${menuItemPrefixCls}-expand-icon`}>{expandIcon}</div>
)}
{isLoading && loadingIcon && (
<div className={`${menuItemPrefixCls}-loading-icon`}>{loadingIcon}</div>
)}
</li>
);
};

// >>>>> Render
return (
<li
key={fullPathKey}
className={classNames(menuItemPrefixCls, {
[`${menuItemPrefixCls}-expand`]: !isMergedLeaf,
[`${menuItemPrefixCls}-active`]:
activeValue === value || activeValue === fullPathKey,
[`${menuItemPrefixCls}-disabled`]: isOptionDisabled(disabled),
[`${menuItemPrefixCls}-loading`]: isLoading,
})}
style={dropdownMenuColumnStyle}
role="menuitemcheckbox"
title={title}
aria-checked={checked}
data-path-key={fullPathKey}
onClick={() => {
triggerOpenPath();
if (disableCheckbox) {
return;
}
if (!multiple || isMergedLeaf) {
triggerSelect();
}
}}
onDoubleClick={() => {
if (changeOnSelect) {
onToggleOpen(false);
}
}}
onMouseEnter={() => {
if (hoverOpen) {
triggerOpenPath();
}
}}
onMouseDown={e => {
// Prevent selector from blurring
e.preventDefault();
}}
>
{multiple && (
<Checkbox
prefixCls={`${prefixCls}-checkbox`}
checked={checked}
halfChecked={halfChecked}
disabled={isOptionDisabled(disabled) || disableCheckbox}
disableCheckbox={disableCheckbox}
onClick={(e: React.MouseEvent<HTMLSpanElement>) => {
if (disableCheckbox) {
return;
}
e.stopPropagation();
triggerSelect();
}}
/>
)}
<div className={`${menuItemPrefixCls}-content`}>
{optionRender ? optionRender(option) : label}
</div>
{!isLoading && expandIcon && !isMergedLeaf && (
<div className={`${menuItemPrefixCls}-expand-icon`}>{expandIcon}</div>
)}
{isLoading && loadingIcon && (
<div className={`${menuItemPrefixCls}-loading-icon`}>{loadingIcon}</div>
)}
</li>
);
},
return (
<ul className={menuPrefixCls} role="menu">
{virtual ? (
<List
ref={ref}
itemKey="fullPathKey"
height={listHeight}
itemHeight={listItemHeight}
virtual={virtual}
data={optionInfoList}
>
{renderLi}
</List>
) : (
optionInfoList.map(renderLi)
)}
</ul>
);
Expand Down
3 changes: 3 additions & 0 deletions src/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ export interface CascaderContextProps {
loadingIcon?: React.ReactNode;
dropdownMenuColumnStyle?: React.CSSProperties;
optionRender?: CascaderProps['optionRender'];
virtual?: boolean;
listHeight?: number;
listItemHeight?: number;
}

const CascaderContext = React.createContext<CascaderContextProps>({} as CascaderContextProps);
Expand Down
Loading