Skip to content

@jsvision/files / ChDirDialogOptions

Interface: ChDirDialogOptions

Defined in: files/src/dialog/chdir-dialog.ts:56

Construction options for ChDirDialog.

Properties

directory?

optional directory?: Signal<string>

Defined in: files/src/dialog/chdir-dialog.ts:60

The current directory (default the filesystem's cwd). Shared with the tree.


fs?

optional fs?: FileSystem

Defined in: files/src/dialog/chdir-dialog.ts:58

The filesystem to read through (default nodeFileSystem).


historyId?

optional historyId?: number

Defined in: files/src/dialog/chdir-dialog.ts:66

The id keying this dialog's recent-path history (default a chdir id distinct from the file dialog).


i18n?

optional i18n?: I18n

Defined in: files/src/dialog/chdir-dialog.ts:64

Translation service for package-owned labels; defaults to an isolated English service.


onResolve?

optional onResolve?: (path) => void

Defined in: files/src/dialog/chdir-dialog.ts:70

Called when the dialog resolves — with the chosen absolute directory, or null on cancel.

Parameters

path

string | null

Returns

void


showError?

optional showError?: (message) => void

Defined in: files/src/dialog/chdir-dialog.ts:68

Called to show an error (unreadable directory). Wire it to errorBox in an app.

Parameters

message

string

Returns

void


title?

optional title?: string

Defined in: files/src/dialog/chdir-dialog.ts:62

The dialog title (default 'Change Directory').