当末尾滚入可视区时加载更多项目
没有滚动监听器的横向无限滚动:菜单已经知道哪些项目可见,因此“用户到了末尾”只是一个问题——最后一个项目在屏上吗?
onUpdate 在每次滚动后提出这个问题,答案为是时就追加下一批。滚到右端——一张加载卡片出现,下一批随后到达。演示在 30 个项目处停止。
工作原理
onUpdate 在项目可见性变化时触发。处理器读取 api.items.last()?.visible——库按 itemId 追踪每一个项目,并为每个项目维护一个可见性标志,因此检测末尾只花一次查找,无需自己的 IntersectionObserver,也无需滚动位置计算。pushNewItems 随即模拟一次请求:一秒超时、再加五个项目,完成。
保护请求
可见性更新是成批到达的,因此处理器必须能被反复调用而不出错。一个 loading 标志让它幂等:onUpdate 与 pushNewItems 都检查它,只有第一次触发会开启请求。同一个标志把 Loader 组件渲染成一个真正的菜单项目(带自己的 itemId),它在挂载时调用 scrollIntoView(),在批次加载期间把这一行的末尾保持在可视区里。
注意
- 右箭头是作为元素传入的,
RightArrow={<RightArrow disabled={...} />}——组件形式与元素形式都能用,而元素形式让父组件可以传入诸如项目上限之类的属性。 - 那个箭头只在达到上限且最后一个项目可见时才禁用——在上限之前,到达末尾意味着还有更多项目要来。
newItemsLimit让这个演示停在 24 个项目;在实际代码中,等价的信号是你的 API 已经用完页数。
完整源码
完整且可直接复制粘贴——这正是背后这份文件的 可在 Storybook 中实时编辑的版本.
import 'react-horizontal-scrolling-menu/dist/styles.css';
import styled from '@emotion/styled';
import React from 'react';
import {
type publicApiType,
ScrollMenu,
VisibilityContext,
} from 'react-horizontal-scrolling-menu';
export function AddItemsExample() {
const [items, setItems] = React.useState(() => getItems());
const [selected, setSelected] = React.useState<string[]>([]);
const isItemSelected = (id: string): boolean =>
!!selected.find((el) => el === id);
const handleItemClick = (itemId: string) => {
const itemSelected = isItemSelected(itemId);
setSelected((currentSelected: string[]) =>
itemSelected
? currentSelected.filter((el) => el !== itemId)
: currentSelected.concat(itemId),
);
};
const newItemsLimit = 24;
const [loading, setLoading] = React.useState(false);
const pushNewItems = () => {
if (loading || items.length > newItemsLimit) {
return false;
}
setLoading(true);
const newItems = items.concat(
Array(5)
.fill(0)
.map((_, ind) => ({ id: getId(items.length + ind) })),
);
new Promise((res) => {
setTimeout(() => res(setItems(newItems)), 1000);
}).finally(() => setLoading(false));
};
return (
<div>
<div>
<NoScrollbar>
<ScrollMenu
LeftArrow={LeftArrow}
RightArrow={<RightArrow disabled={items.length >= newItemsLimit} />}
onWheel={onWheel}
onUpdate={(api) => {
const lastVisible = api?.items?.last?.()?.visible;
if (lastVisible && !loading) {
pushNewItems();
}
}}
>
{items.map(({ id }) => (
<Card
title={id}
itemId={id} // NOTE: itemId is required for track items
key={id}
onClick={() => handleItemClick(id)}
selected={isItemSelected(id)}
/>
))}
{loading && <Loader itemId="loader" key="loader" />}
</ScrollMenu>
</NoScrollbar>
</div>
</div>
);
}
function Loader({ itemId }: { itemId: string }) {
const ref = React.useRef<HTMLDivElement>(null);
React.useEffect(() => {
ref.current?.scrollIntoView();
}, [ref]);
return <div ref={ref}>Loading...</div>;
}
export default AddItemsExample;
const NoScrollbar = styled('div')({
'& .react-horizontal-scrolling-menu--scroll-container::-webkit-scrollbar': {
display: 'none',
},
'& .react-horizontal-scrolling-menu--scroll-container': {
scrollbarWidth: 'none',
'-ms-overflow-style': 'none',
},
});
function LeftArrow() {
const visibility = React.useContext<publicApiType>(VisibilityContext);
const disabled = visibility.useLeftArrowVisible();
return (
<Arrow
disabled={disabled}
onClick={() => visibility.scrollPrev()}
testId="left-arrow"
>
Left
</Arrow>
);
}
function RightArrow({ disabled }: { disabled: boolean }) {
const visibility = React.useContext<publicApiType>(VisibilityContext);
const isLastItemVisible = visibility.useIsVisible('last', false);
return (
<Arrow
disabled={disabled && isLastItemVisible}
onClick={() => visibility.scrollNext()}
testId="right-arrow"
>
Right
</Arrow>
);
}
function Arrow({
children,
disabled,
onClick,
className,
testId,
}: {
children: React.ReactNode;
disabled: boolean;
onClick: VoidFunction;
className?: string;
testId: string;
}) {
return (
<ArrowButton
disabled={disabled}
onClick={onClick}
className={'arrow' + `-${className}`}
data-testid={testId}
>
{children}
</ArrowButton>
);
}
const ArrowButton = styled('button')((props) => ({
cursor: 'pointer',
display: 'flex',
flexDirection: 'column',
justifyContent: 'center',
marginBottom: '2px',
opacity: props.disabled ? '0' : '1',
userSelect: 'none',
borderRadius: '6px',
borderWidth: '1px',
}));
function Card({
onClick,
selected,
title,
itemId,
}: {
onClick: (context: publicApiType) => void;
selected: boolean;
title: string;
itemId: string;
}) {
const visibility = React.useContext<publicApiType>(VisibilityContext);
const isVisible = visibility.useIsVisible(itemId, true);
return (
<CardBody
data-cy={itemId}
onClick={() => onClick(visibility)}
onKeyDown={(ev: React.KeyboardEvent) => {
ev.code === 'Enter' && onClick(visibility);
}}
data-testid="card"
role="button"
tabIndex={0}
className="card"
visible={isVisible}
selected={selected}
>
<div className="header">
<div>{title}</div>
<div className="visible">visible: {JSON.stringify(isVisible)}</div>
<div className="selected">selected: {JSON.stringify(!!selected)}</div>
</div>
<div className="background" />
</CardBody>
);
}
const CardBody = styled('div')<{ selected?: boolean; visible?: boolean }>(
(props) => ({
border: '1px solid',
display: 'inline-block',
margin: '0 10px',
width: '160px',
userSelect: 'none',
borderRadius: '8px',
overflow: 'hidden',
'& .header': {
backgroundColor: 'white',
},
'& .visible': {
backgroundColor: props.visible ? 'transparent' : 'gray',
},
'& .background': {
backgroundColor: props.selected ? 'green' : 'bisque',
height: '200px',
},
}),
);
const getId = (index: number) => `${'test'}${index}`;
const getItems = () =>
Array(10)
.fill(0)
.map((_, ind) => ({ id: getId(ind) }));
const onWheel = (apiObj: publicApiType, ev: React.WheelEvent) => {
// NOTE: no good standart way to distinguish touchpad scrolling gestures
// but can assume that gesture will affect X axis, mouse scroll only Y axis
// of if deltaY too small probably is it touchpad
const isThouchpad = Math.abs(ev.deltaX) !== 0 || Math.abs(ev.deltaY) < 15;
if (isThouchpad) {
ev.stopPropagation();
return;
}
if (ev.deltaY < 0) {
apiObj.scrollNext();
} else {
apiObj.scrollPrev();
}
};