给横向菜单添加滚动进度指示器
隐藏了滚动条的轮播仍然欠用户一个“还剩多少?”的答案。菜单其实已经知道:它追踪每个项目的可见性,因此位置只是一个计数问题。该 story 用这些数据渲染编号的页码按钮以及左右剩余项目数;这个演示则把同样的数学浓缩成一条进度条。
滚动、拖拽这一行或用箭头——进度条一页页地填满,计数器显示你的位置。
工作原理
指示器作为 Footer 属性传入,因此 ScrollMenu 把它渲染在菜单内部、VisibilityContext 可用之处。它从 context 取出 items——可见性追踪背后的映射——并用 items.subscribe(’onUpdate’, cb) 订阅。该事件在每次 IntersectionObserver 回调时触发,所以 story 在读取 items.getVisible() 之前先对它做防抖(一个 timeout 加 requestAnimationFrame)。
从可见项目到页码
可见项目的数量就是页大小。总页数是 Math.ceil(items.size / visibleItemsLen);当前页来自最后一个可见条目的 index。story 把它们变成可点击的页码按钮——每个都调用 scrollToItem(getItemByIndex(itemInd)),只按位置寻址项目而不必知道它的 id——并从同样的数字推导出左侧与右侧的项目数。演示中的进度条只是把 currentPage / totalPages 作为宽度百分比。
注意
- 没有任何东西用像素测量——数学完全基于可见性数据运行,因此即便项目宽度不同也能正常工作。
- 调整视口大小,页大小会随之变化:能容纳更多项目,
getVisible()返回更多条目,页数在下一次更新时重新计算。 - 该副作用返回一个清理函数,调用
items.unsubscribe并清掉待处理的定时器——跳过它,一个已卸载的 footer 会一直被调用。 - 在第一次观察报告之前
getVisible()是空的;story 在此之前返回null,演示则画出一条空轨道。
完整源码
完整且可直接复制粘贴——这正是背后这份文件的 可在 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 Progress() {
const [items] = React.useState(() => getItems(30));
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),
);
};
return (
<div>
<NoScrollbar>
<ScrollMenu
LeftArrow={LeftArrow}
RightArrow={RightArrow}
onWheel={onWheel}
Footer={Footer}
>
{items.map(({ id }) => (
<Card
title={id}
itemId={id} // NOTE: itemId is required for track items
key={id}
onClick={() => handleItemClick(id)}
selected={isItemSelected(id)}
/>
))}
</ScrollMenu>
</NoScrollbar>
</div>
);
}
const Footer = () => {
const visibility = React.useContext<publicApiType>(VisibilityContext);
const { items } = visibility;
const [visible, setVisible] = React.useState<[string, { index: string }][]>(
[],
);
// Need to update this component
// listening to 'onUpdate' event with some debounce.
// 'onInit' covers the very first classification (it fires instead of
// 'onUpdate' there), and the immediate call picks the state up when the
// first batch landed before this effect ran — otherwise the footer would
// wait for the next scroll to appear.
React.useEffect(() => {
if (items) {
let timer: ReturnType<typeof setTimeout>;
const cb = () => {
clearTimeout(timer);
timer = setTimeout(
() => requestAnimationFrame(() => setVisible(items.getVisible())),
200,
);
};
items.subscribe('onInit', cb);
items.subscribe('onUpdate', cb);
cb();
return () => {
clearTimeout(timer);
items.unsubscribe('onInit', cb);
items.unsubscribe('onUpdate', cb);
};
}
}, [items]);
if (!visible.length) {
return null;
}
const total = items?.size;
const visibleItemsLen = visible.length;
const totalPages = Math.ceil(total / visibleItemsLen);
const lastVisibleInd = +visible.slice(-1)[0][1].index;
const currentPage = Math.ceil(lastVisibleInd / visibleItemsLen);
const pages = Array(totalPages)
.fill(1)
.map((_, ind) => ind + 1);
const itemsLeft = (currentPage - 1) * visibleItemsLen;
const itemsRight = total - visibleItemsLen * currentPage;
const scrollToPage = (page: number) => {
const itemInd = page * visibleItemsLen - 1;
visibility.scrollToItem(visibility.getItemByIndex(itemInd));
};
return (
<>
<FooterContainer>
{pages.map((page) => (
<button
key={page}
data-testid={`page-${page}`}
onClick={() => scrollToPage(page)}
onKeyDown={(ev) => {
if (ev.code === 'Space') {
scrollToPage(page);
}
}}
className={`page-btn ${page === currentPage ? 'active' : ''}`}
>
{page}
</button>
))}
</FooterContainer>
<FooterContainer>
<div>
<div>
Items on the left: <span data-testid="items-left">{itemsLeft}</span>
</div>
<div>
Items on the right:{' '}
<span data-testid="items-right">{itemsRight}</span>
</div>
</div>
</FooterContainer>
</>
);
};
const FooterContainer = styled('div')({
'&': {
display: 'flex',
justifyContent: 'center',
gap: '5px',
margin: '10px',
},
'& button.active': {
color: 'red',
},
});
export default Progress;
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() {
const visibility = React.useContext<publicApiType>(VisibilityContext);
const disabled = visibility.useRightArrowVisible();
return (
<Arrow
disabled={disabled}
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 = (count: number = 10) =>
Array(count)
.fill(0)
.map((_, ind) => ({ id: getId(ind) }));
function onWheel(apiObj: publicApiType, ev: React.WheelEvent): void {
// 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();
}
}