@k8ordo/ui

Tree

枝を開閉できる階層の一覧です。ファイルツリーやアウトラインに使い、キーボード操作はWAI-ARIAのtreeに従います。

インポート

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

使い方

項目は{ id, label, icon?, children? }の木で渡します。上下の矢印で、見えている項目を移動します。右の矢印は閉じた枝を開き、開いた枝では最初の子へ移ります。左の矢印は開いた枝を閉じ、それ以外では親へ戻ります。HomeとEndで先頭と末尾へ移り、EnterかSpaceで選びます。文字を入力すると、その文字で始まる項目へ移ります。

  • src
  • index.ts
  • package.json
  • README.md
tsx
<Tree
  defaultExpandedIds={['src']}
  items={[
    {
      id: 'src',
      label: 'src',
      children: [
        {
          id: 'components',
          label: 'components',
          children: [{ id: 'button', label: 'button.tsx' }],
        },
        { id: 'index', label: 'index.ts' },
      ],
    },
    { id: 'readme', label: 'README.md' },
  ]}
  label="Files"
/>

開閉と選択の制御

開いている枝(expandedIds)と選択(selectedId)は、外から渡せます。onChangeは選んだ項目のidを受け取ります。

  • src
  • components
  • button.tsx
  • card.tsx
  • index.ts
  • package.json
  • README.md

Selected: card

tsx
const [expandedIds, setExpandedIds] = useState<readonly string[]>(['src']);
const [selectedId, setSelectedId] = useState<string | null>(null);

<Tree
  expandedIds={expandedIds}
  items={files}
  label="Files"
  onChange={setSelectedId}
  onExpandedChange={setExpandedIds}
  selectedId={selectedId}
/>

Props

items
Type: readonly TreeItem[]
Default: -
label
Type: string
Default: -
defaultExpandedIds?
Type: readonly string[]
Default: -
defaultSelectedId?
Type: string|null
Default: null
expandedIds?
Type: readonly string[]
Default: -
onChange?
Type: (id: string) => void
Default: -
onExpandedChange?
Type: (ids: readonly string[]) => void
Default: -
selectedId?
Type: string|null
Default: -
PropTypeDefault
itemsreadonly TreeItem[]-
labelstring-
defaultExpandedIds?readonly string[]-
defaultSelectedId?string|nullnull
expandedIds?readonly string[]-
onChange?(id: string) => void-
onExpandedChange?(ids: readonly string[]) => void-
selectedId?string|null-

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

k8ordo

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