縦スクロールメニュー——同じコンポーネントを CSS で回す

vertical プロパティはありませんし、必要もありません。メニューはネイティブスクロールコンテナ内の flex 行なので、下向きにするのは数個の CSS オーバーライドです。可視性追跡、矢印フック、scrollPrev/scrollNext はすべて新しい軸で機能し続けます。
Tokyo
Oslo
Lima
Cairo
Sydney
Quito
Seoul
Porto
Denver
Hanoi

列の上でホイールを回すか矢印を使う——Up と Down は ScrollMenu の Header と Footer です。行はビューを離れると薄暗くなります。

2 つのオーバーライドと 1 つの高さの境界

ストーリーはライブラリの 2 つのクラス名を再スタイルします。スクロールコンテナはデフォルトの max-content の代わりに flex-direction: columnoverflow-y: autoheight: initial を得て、ラッパーは height: 100% を得るので、親の固定高さがそのままスクロール境界になります。それが縦モードのすべてです。ストーリーは emotion でオーバーライドを適用し、このページのデモは代わりに wrapperClassNamescrollContainerClassName プロパティで Tailwind ユーティリティを渡します——どのスタイル経路でも機能し、クラス名は安定しています。

矢印が Header と Footer になる

LeftArrow/RightArrow スロットはレールの横に描画されます——列には不向きな位置です。ScrollMenu は上下に描画される HeaderFooter コンポーネントも受け取り、ストーリーはそこに Up と Down ボタンをマウントします。それらは普通の VisibilityContext 消費者です。useIsVisible('first', true) が最上部で Up を無効にし、useIsVisible('last', false) が最下部で Down を無効にします。クリックは第 3 引数を渡します——scrollPrev(undefined, undefined, 'end')scrollNext(undefined, undefined, 'start')——scrollIntoViewblock 位置です。'end' は前の項目を下端に置き(丸々 1 ページ上へ)、'start' は次の項目を最上部に置きます(丸々 1 ページ下へ)。デフォルトの 'nearest' では、各クリックは次の行をかろうじてビューへ押し込むだけです。

スクロールを列の内側に保つ

scrollIntoView は対象のスクロール可能な祖先をすべて動かし、ページもその 1 つです——したがって列内での block 整列ジャンプはドキュメント全体を巻き込みます。その連鎖を止めるのが boundary で、第 4 引数で渡します:scrollNext(undefined, undefined, 'start', { boundary }) にメニュー自身の scrollContainer.current を渡すと、行だけをスクロールし他は動かしません。boundary を理解するのはポリフィルだけなので、ScrollMenu には noPolyfill={false} が必要です——上のデモは両方を渡しています。横メニューがこれに出くわすことは稀です。デフォルトの block: 'nearest' はそもそもページに縦移動を求めないからです。

可視性に軸はない

useIsVisible は IntersectionObserver が支えており、交差は両次元で測られます——行は上下端を横切るとき、横項目が両側で行うのとまったく同じように状態を報告します。デモはビューの外の行を薄暗くしてそれを見せ、フックの defaultValue 引数で最初の 4 行をサーバーペイント済みの可視にしています。

注意点

完全なソース

完全でコピー&ペースト可能——これは、まさにそのファイルです。出所は、この ライブ編集可能な Storybook 版.

Vertical.source.tsx
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';

const NoScrollbar = styled('div')({
  '& .react-horizontal-scrolling-menu--scroll-container::-webkit-scrollbar': {
    display: 'none',
  },
  // NOTE: also need to set on parent:
  // display: 'flex' and position: 'relative'
  '& .react-horizontal-scrolling-menu--wrapper': {
    height: '100%',
  },

  '& .react-horizontal-scrolling-menu--scroll-container': {
    height: 'initial',
    scrollbarWidth: 'none',
    '-ms-overflow-style': 'none',
    overflowY: 'auto',
    flexDirection: 'column',
  },
});

export function VerticalExample() {
  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),
    );
  };

  return (
    <NoScrollbar>
      <ScrollMenu Header={UpArrow} Footer={DownArrow}>
        {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 VerticalExample;

function UpArrow() {
  const visibility = React.useContext<publicApiType>(VisibilityContext);
  const isFirstItemVisible = visibility.useIsVisible('first', true);

  return (
    <Arrow
      disabled={isFirstItemVisible}
      onClick={() => visibility.scrollPrev(undefined, undefined, 'end')}
      testId="up-arrow"
    >
      Up
    </Arrow>
  );
}

function DownArrow() {
  const visibility = React.useContext<publicApiType>(VisibilityContext);
  const isLastItemVisible = visibility.useIsVisible('last', false);

  return (
    <Arrow
      disabled={isLastItemVisible}
      onClick={() => visibility.scrollNext(undefined, undefined, 'start')}
      testId="down-arrow"
    >
      Down
    </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: '125px',
    },
  }),
);

const getId = (index: number) => `${'test'}${index}`;

const getItems = () =>
  Array(10)
    .fill(0)
    .map((_, ind) => ({ id: getId(ind) }));

関連する例

すべての例(21 件)