File Tree

An interactive file tree component with expandable folders, selectable files, and smooth animations.

motion-sv

Installation

pnpm dlx shadcn-svelte@latest add https://sv-animations.vercel.app/r/file-tree.json

Usage

<script lang="ts">	import { File, Folder, Tree, type TreeViewElement } from "#lib/components/magic/file-tree/index.js";
	const elements: TreeViewElement[] = [		{			id: "src",			name: "src",			children: [{ id: "page", name: "+page.svelte" }],		},	];</script>
<Tree {elements} initialExpandedItems={["src"]}>	<Folder value="src" element="src">		<File value="page">+page.svelte</File>	</Folder></Tree>

Props

Tree

The root tree container component.

NameTypeDefaultDescription
initialSelectedIdstringundefinedInitial selected item ID
initialExpandedItemsstring[][]Initial expanded items
elementsTreeViewElement[]undefinedTree elements data
indicatorbooleantrueShow indicator line
dir'rtl' | 'ltr''ltr'Text direction
classClassValue""Additional CSS classes

Folder

A folder component that can contain files and other folders.

NameTypeDefaultDescription
elementstringrequiredFolder name/label
valuestringrequiredUnique value for this folder
isSelectablebooleantrueWhether the folder is selectable
classClassValue""Additional CSS classes

File

A file component that can be selected.

NameTypeDefaultDescription
valuestringrequiredUnique value for this file
isSelectablebooleantrueWhether the file is selectable
classClassValue""Additional CSS classes

Collapse Button

A button to expand or collapse all folders.

NameTypeDefaultDescription
elementsTreeViewElement[]requiredTree elements to expand/collapse
expandAllbooleanfalseWhether to expand all on mount
classClassValue""Additional CSS classes