@k8ordo/ui

TableOfContents

ページの目次です。今読んでいる見出しを示します。

インポート

ts
import { TableOfContents } from '@k8ordo/ui';

使い方

見出しは{ id, label, children? }の木で渡します。下の目次はこのページ自身の見出しを指しているので、スクロールすると現在の見出しが動きます。

tsx
<TableOfContents
  items={[
    { id: 'import', label: 'Import' },
    {
      id: 'usage',
      label: 'Usage',
      children: [{ id: 'active', label: 'How the current heading is chosen' }],
    },
    { id: 'props', label: 'Props' },
  ]}
/>

現在の見出しの決め方

見出しのscroll-margin-block-startの位置を基準に、そこを最後に越えた見出しを現在の見出しとします。固定ヘッダーの高さを見出しのscroll-marginに指定しておけば、目次から飛んだ見出しがそのまま選ばれます。文書の終わりまで来たときは、最後の節が短くても最後の見出しを選びます。縦書きの文書では読む向きで決めます。vertical-rlなら右から左、vertical-lrなら左から右です。

Props

items
Type: readonly TableOfContentsItem[]
Default: -
label?
Type: string
Default: -
PropTypeDefault
itemsreadonly TableOfContentsItem[]-
label?string-

継承する属性(内部で固定するものを除く): HTMLAttributes<HTMLElement>

ラベルやプレースホルダーなど、このコンポーネントが描く文言は、propsで指定しないと文言辞書から読まれます。差し替え方は次を見てください: コンポーネントの文言

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。