Adicionar um item e rolar até ele — o padrão de chips de filtro
Clique em Adicionar filtro — o chip aparece no fim e a linha rola para revelá-lo. O x remove um chip.
Edite este exemplo ao vivo no Storybook
Como funciona
O menu recebe um apiRef, que expõe a API completa fora da árvore de componentes. addItem faz duas coisas: guarda o novo id em uma ref lastAdded e então acrescenta o item ao estado. Ele de propósito não rola — nesse momento o chip é apenas estado, não DOM.
Por que a rolagem vive em um efeito
getItemElementById procura o item no DOM, então a rolagem só pode acontecer depois que o React confirmou o novo item. Um useEffect dependente de items roda exatamente nesse ponto: lê lastAdded, o limpa e chama apiRef.current.scrollToItem(el, ’smooth’, ’end’). Limpar a ref importa — re-renderizações por qualquer outro motivo (seleção, setas) também atingem o efeito e não devem rolar de novo.
Notas
lastAddedé uma ref, não estado: escrevê-la não deve por si só causar render, e seu valor só interessa à próxima execução do efeito.’end’alinha o novo chip com a borda direita da linha;’center’funciona igual se você quiser no meio.- As setas aqui usam os hooks
useLeftArrowVisible()euseRightArrowVisible()— uma forma mais curta do paruseIsVisible(’first’/’last’). - A barra de rolagem é ocultada com CSS simples sobre a classe
scroll-containerda biblioteca; a rolagem em si continua nativa.
Fonte completa
Completa e pronta para copiar e colar — este é o arquivo exato por trás da versão do Storybook editável ao vivo.
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 AddItemAndScrollToItExample() {
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 apiRef = React.useRef<publicApiType>(null);
// The id of the item added by the last click; empty on mount and after the
// scroll fires, so re-renders for other reasons don't scroll again.
const lastAdded = React.useRef<string | null>(null);
const addItem = () => {
const newId = getId(items.length);
lastAdded.current = newId;
setItems((currentItems) => currentItems.concat({ id: newId }));
};
// `getItemElementById` looks the item up in the DOM, so the scroll can only
// happen after React has rendered the new item — an effect keyed on `items`
// rather than a call inside the click handler.
React.useEffect(() => {
const newId = lastAdded.current;
if (!newId) {
return;
}
lastAdded.current = null;
const el = apiRef.current?.getItemElementById(newId);
if (el) {
apiRef.current?.scrollToItem(el, 'smooth', 'end');
}
}, [items]);
return (
<div>
<div>
<button onClick={addItem} data-testid="add-item">
Add item
</button>
</div>
<NoScrollbar>
<ScrollMenu
LeftArrow={LeftArrow}
RightArrow={RightArrow}
onWheel={onWheel}
apiRef={apiRef}
>
{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>
);
}
export default AddItemAndScrollToItExample;
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 = () =>
Array(10)
.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();
}
}