CLIがコンポーネントのソースと内部の依存ファイルをプロジェクトにコピーし、必要なnpmパッケージをインストールします。
npx boardui@latest add tree-view共有UIパッケージや独自のインポートエイリアスを使う場合は、 インストールパスの設定 をCLIの実行前に設定してください。コピー&ペーストの例は、標準のインポートを使います。
状態管理とデータ駆動
展開と選択を独自の状態で管理するには expandedKeys そして、 selectedKeys. 使用 TreeViewCollection で入れ子のデータを再帰的に描画します。各項目には一意で安定した id.
枝は高さ、フェード、ぼかしの滑らかなアニメーションで開閉します。消える行はキーボード操作の対象からすぐに外れ、動きを減らす設定ではアニメーションを無効にします。
import { useState } from "react";import type { Key, Selection } from "react-aria-components";import { TreeView, TreeViewCollection, TreeViewItem } from "@/components/base/tree-view/tree-view";
interface FileNode { id: string; name: string; children?: FileNode[];}
const files: FileNode[] = [ { id: "design", name: "Design", children: [ { id: "logo", name: "Logo.svg" }, { id: "colors", name: "Colors.fig" }, ] }, { id: "notes", name: "Project notes.md" },];
function renderFile(item: FileNode) { return ( <TreeViewItem id={item.id} label={item.name}> <TreeViewCollection items={item.children ?? []}>{renderFile}</TreeViewCollection> </TreeViewItem> );}
export function Example() { const [expandedKeys, setExpandedKeys] = useState<Set<Key>>(new Set(["design"])); const [selectedKeys, setSelectedKeys] = useState<Selection>(new Set(["logo"]));
return ( <TreeView aria-label="Workspace files" items={files} expandedKeys={expandedKeys} onExpandedChange={setExpandedKeys} selectedKeys={selectedKeys} onSelectionChange={setSelectedKeys} > {renderFile} </TreeView> );}複数選択
セットセット selectionMode="multiple" で項目を個別に切り替えます。Shift を押しながらキーボードで範囲を選択できます。既定は単一選択で、使用する設定は selectionMode="none" と、 onAction でアクション専用のツリーにします。
<TreeView aria-label="Documents to share" selectionMode="multiple" defaultExpandedKeys={["documents"]} defaultSelectedKeys={["overview", "guidelines"]}> <TreeViewItem id="documents" label="Documents" trailingContent="3 files"> <TreeViewItem id="overview" label="Overview.md" /> <TreeViewItem id="guidelines" label="Guidelines.md" /> <TreeViewItem id="changelog" label="Changelog.md" /> </TreeViewItem></TreeView>サイズ、アイコン、状態
利用条件 size="sm" でコンパクトな行にし、 showGuides={false} でガイド線を隠せます。枝にはフォルダーアイコンが自動で付きます。Remix Icon コンポーネントを渡す先は アイコン または expandedIcon でカスタマイズできます。無効な項目は操作できず、 renderEmptyState で空の状態のメッセージを指定できます。
import { RiFolder3Line } from "@remixicon/react";
<TreeView aria-label="Repository files" size="sm" showGuides={false}> <TreeViewItem id="index" label="index.tsx" /> <TreeViewItem id="private" label="Private files" isDisabled trailingContent="Restricted" /> <TreeViewItem id="archive" label="Archive" icon={RiFolder3Line} trailingContent="Empty" /></TreeView>
<TreeView aria-label="Search results" renderEmptyState={() => "No matching files."}> {[]}</TreeView>右から左
ロケールを設定するには DirectionProvider。インデント、ガイド線、開閉アイコン、左右のキーボード操作は読む方向に従います。
import { DirectionProvider } from "@/components/foundations/direction/direction";import { TreeView, TreeViewItem } from "@/components/base/tree-view/tree-view";
<DirectionProvider locale="ar"> <TreeView aria-label="ملفات المشروع" defaultExpandedKeys={["project"]}> <TreeViewItem id="project" label="المشروع"> <TreeViewItem id="design" label="التصميم"> <TreeViewItem id="logo" label="الشعار.svg" /> </TreeViewItem> <TreeViewItem id="notes" label="الملاحظات.md" /> </TreeViewItem> </TreeView></DirectionProvider>キーボードナビゲーション
Tab でツリーに入り、上下キーで表示中の項目を移動します。右キーは枝を展開するか最初の子に移動し、左キーは枝を折りたたむか親に戻ります。Home と End は最初と最後の表示項目に移動します。ラベルを入力して検索し、Space で選択します。
各ツリーに指定するものは aria-label または aria-labelledby。RTL 領域を囲むには BoardUI の DirectionProvider と適切なロケールを使います。開閉アイコン、インデント、左右のキーは自動で方向に従います。