Skip to content

ui/build/file-tree/file-tree.types

ui/build/file-tree/file-tree.types

Type Aliases

FileTreeEntry

type FileTreeEntry = object;

Defined in: apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:2

Properties

Property Type Defined in
name string apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:3
path string apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:6
sizeBytes number apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:5
type "directory" | "file" apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:4
writable? boolean apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:7

FileTreeEntryBadge

type FileTreeEntryBadge = object;

Defined in: apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:16

Properties

Property Type Defined in
class? string apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:18
label string apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:17

FileTreePresencePeer

type FileTreePresencePeer = object;

Defined in: apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:12

Properties

Property Type Defined in
color string apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:13
label string apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:14

FileTreeProps

type FileTreeProps<E> = object;

Defined in: apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:25

E defaults to Error, not never: a Svelte component cannot infer a type parameter from its props, so the default is the only value this ever takes — and file-tree-node handles a load failure (error instanceof Error). With never that handler was unreachable by its own types.

Type Parameters

Type Parameter Default type
E Error

Properties

Property Type Description Defined in
canDelete? (path, entry) => boolean - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:29
class? string - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:41
defaultExpandedPaths? readonly string[] Directory paths expanded when their nodes first mount. apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:39
deleteDisabled? boolean - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:31
entries FileTreeEntry[] - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:26
getEntryBadge? (entry) => | FileTreeEntryBadge | null Optional trailing status badge (e.g. U/M/D). Also tints the filename when class is set. apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:36
getEntryIcon? (entry, context) => string - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:34
isMutedEntry? (entry) => boolean - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:37
onDelete? (path, entry) => void - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:30
onSelect? (path, entry) => void - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:28
onToggle? (path) => Effect.Effect<FileTreeEntry[], E> - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:27
presenceByPath? Record<string, readonly FileTreePresencePeer[]> - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:33
selectedPath? string | null - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:32
variant? "default" | "dark" - apps/website/.api-docs-entry/ui/build/file-tree/file-tree.types.d.ts:40