Свайп на десктопе: флик мышью, который листает меню
scrollNext или scrollPrev. Ряд вообще не следует за указателем; скольжение — это плавная программная прокрутка библиотеки, и именно она придаёт отпусканию ощущение инерции.Нажмите в любом месте ряда, сдвиньтесь влево или вправо хотя бы на 50px и отпустите — меню проскользит на страницу. Более короткие движения ничего не делают.
Редактировать этот пример вживую в Storybook
Как это работает
Хук useSwipe возвращает три каррированных пропа мыши, которые ожидает ScrollMenu, — каждый получает объект API и возвращает обычный обработчик события. onMouseDown закрепляет clientX указателя в ref, onMouseMove постоянно перезаписывает конечную координату, а onMouseUp сравнивает их: горизонтальная разница больше minSwipeDistance (50px) вызывает apiObj.scrollNext() при флике влево или apiObj.scrollPrev() при флике вправо.
Почему кликам не нужна особая обработка
В примере перетаскивания отпускание драга над карточкой кликнуло бы её, поэтому флаг dragging должен переживать жест на один кадр. Флик обходит всю проблему: ниже порога в 50px onMouseUp ничего не делает, так что клик — это просто клик, — а выше него указатель всё равно уже ушёл с карточки, на которой был нажат. Ни флагов, ни подавленных обработчиков.
Что история добавляет для касания и колеса
История также фиксирует нативный тач-панораминг: React 18+ регистрирует слушатели touchmove как пассивные, поэтому preventDefault работает только из непассивного слушателя. Эффект добирается до контейнера прокрутки через apiRef (ref.current.scrollContainer.current) и навешивает слушатель с { passive: false }. Его обработчик onWheel тоже листает меню, с эвристикой — ненулевой deltaX или малый deltaY считается тачпадом и оставляется в покое.
Примечания
- Координаты живут в ref, а не в состоянии — отслеживание
mousemoveв состоянии перерисовывало бы на каждом пикселе. - Демо заново закрепляет конечную координату на
mousedown, так что остаточная позиция от предыдущего жеста никогда не засчитается в новый свайп. - Настраивайте
minSwipeDistanceпо вкусу: ниже — резче, выше — терпимее к небрежным кликам. Сенсорный вариант рецепта использует 20px.
Полный исходник
Полный и готовый к копированию — это точный файл, стоящий за редактируемой вживую версией 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 SwipeDesktop() {
const [items] = 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 { onMouseDown, onMouseMove, onMouseUp } = useSwipe();
const ref = React.useRef<publicApiType>(null);
// React 18+ attaches touchmove listeners as passive, so preventDefault only
// works from a non-passive listener added manually to the scroll container.
React.useEffect(() => {
const onTouchMove = (ev: TouchEvent) => {
ev.preventDefault();
};
const node = ref.current?.scrollContainer.current;
node?.addEventListener('touchmove', onTouchMove, { passive: false });
return () => node?.removeEventListener('touchmove', onTouchMove);
}, [ref]);
return (
<NoScrollbar>
<ScrollMenu
LeftArrow={LeftArrow}
RightArrow={RightArrow}
onWheel={onWheel}
onMouseDown={onMouseDown}
onMouseMove={onMouseMove}
onMouseUp={onMouseUp}
apiRef={ref}
>
{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>
);
}
export default SwipeDesktop;
export const useSwipe = () => {
const pos = React.useRef({ start: { x: 0, y: 0 }, end: { x: 0, y: 0 } });
// the required distance between touchStart and touchEnd to be detected as a swipe
const minSwipeDistance = 50;
const onMouseDown = () => (ev: React.MouseEvent) => {
pos.current.start = { x: ev.clientX, y: ev.clientY };
};
const onMouseMove = () => (ev: React.MouseEvent) => {
pos.current.end = { x: ev.clientX, y: ev.clientY };
};
const onMouseUp = (apiObj: publicApiType) => () => {
// disable it for native touch screen devices
// if ('ontouchstart' in window) { return false }
const horDiff = pos.current.end.x - pos.current.start.x;
// const vertDiff = pos.current.end.y - pos.current.start.y;
const toLeft = horDiff < 0 && Math.abs(horDiff) > minSwipeDistance;
const toRight = horDiff > 0 && Math.abs(horDiff) > minSwipeDistance;
// for vertical menu
// const toTop = vertDiff < 0 && Math.abs(vertDiff) > minSwipeDistance;
// const toBottom = vertDiff > 0 && Math.abs(vertDiff) > minSwipeDistance;
if (toLeft) {
apiObj.scrollNext();
}
if (toRight) {
apiObj.scrollPrev();
}
};
return { onMouseDown, onMouseMove, onMouseUp };
};
const NoScrollbar = styled('div')({
'&': {
position: 'relative',
},
'& .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 = () =>
Array(20)
.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();
}
}