file-tree

Type Aliases

FileTree

type FileTree = ReturnType<typeof FileTree>;

Defined in: packages/ui/build/file-tree/file-tree.svelte.d.ts:3

---

FileTreeEntry

type FileTreeEntry = object;

Defined in: packages/ui/build/file-tree/file-tree.types.d.ts:1

Properties

Property	Type	Defined in
name	string	packages/ui/build/file-tree/file-tree.types.d.ts:2
path	string	packages/ui/build/file-tree/file-tree.types.d.ts:5
sizeBytes	number	packages/ui/build/file-tree/file-tree.types.d.ts:4
type	"directory" | "file"	packages/ui/build/file-tree/file-tree.types.d.ts:3
writable?	boolean	packages/ui/build/file-tree/file-tree.types.d.ts:6

---

FileTreeEntryBadge

type FileTreeEntryBadge = object;

Defined in: packages/ui/build/file-tree/file-tree.types.d.ts:15

Properties

Property	Type	Defined in
class?	string	packages/ui/build/file-tree/file-tree.types.d.ts:17
label	string	packages/ui/build/file-tree/file-tree.types.d.ts:16

---

FileTreePresencePeer

type FileTreePresencePeer = object;

Defined in: packages/ui/build/file-tree/file-tree.types.d.ts:11

Properties

Property	Type	Defined in
color	string	packages/ui/build/file-tree/file-tree.types.d.ts:12
label	string	packages/ui/build/file-tree/file-tree.types.d.ts:13

---

FileTreeProps

type FileTreeProps = object;

Defined in: packages/ui/build/file-tree/file-tree.types.d.ts:19

Properties

Property	Type	Description	Defined in
canDelete?	(path, entry) => boolean	-	packages/ui/build/file-tree/file-tree.types.d.ts:23
class?	string	-	packages/ui/build/file-tree/file-tree.types.d.ts:33
deleteDisabled?	boolean	-	packages/ui/build/file-tree/file-tree.types.d.ts:25
entries	FileTreeEntry[]	-	packages/ui/build/file-tree/file-tree.types.d.ts:20
getEntryBadge?	(entry) => | FileTreeEntryBadge | null	Optional trailing status badge (e.g. U/M/D). Also tints the filename when class is set.	packages/ui/build/file-tree/file-tree.types.d.ts:30
getEntryIcon?	(entry, context) => string	-	packages/ui/build/file-tree/file-tree.types.d.ts:28
isMutedEntry?	(entry) => boolean	-	packages/ui/build/file-tree/file-tree.types.d.ts:31
onDelete?	(path, entry) => void	-	packages/ui/build/file-tree/file-tree.types.d.ts:24
onSelect?	(path, entry) => void	-	packages/ui/build/file-tree/file-tree.types.d.ts:22
onToggle?	(path) => Promise<FileTreeEntry[]>	-	packages/ui/build/file-tree/file-tree.types.d.ts:21
presenceByPath?	Record<string, readonly FileTreePresencePeer[]>	-	packages/ui/build/file-tree/file-tree.types.d.ts:27
selectedPath?	string | null	-	packages/ui/build/file-tree/file-tree.types.d.ts:26
variant?	"default" | "dark"	-	packages/ui/build/file-tree/file-tree.types.d.ts:32

Variables

FileTree

const FileTree: Component;

Defined in: packages/ui/build/file-tree/file-tree.svelte.d.ts:3

Functions

getDefaultFileTreeEntryIcon()

function getDefaultFileTreeEntryIcon(entry, context): string;

Defined in: packages/ui/build/file-tree/file-tree-icons.d.ts:3

Cursor / VS Code–style Iconify ids for workspace file tree rows.

Parameters

Parameter	Type
entry	FileTreeEntry
context	{ open: boolean; }
context.open	boolean

Returns

string

---

getFileIconForPath()

function getFileIconForPath(relativePath): string;

Defined in: packages/ui/build/file-tree/file-tree-icons.d.ts:6

Parameters

Parameter	Type
relativePath	string

Returns

string