Skip to content

@jsvision/files / FileListOptions

Interface: FileListOptions

Defined in: files/src/list/file-list.ts:17

Construction options for FileList.

Properties

bar?

optional bar?: ScrollBar

Defined in: files/src/list/file-list.ts:33

A scroll bar to drive; when omitted the list owns its own vertical bar.


command?

optional command?: string

Defined in: files/src/list/file-list.ts:37

A command name emitted on activation, handled elsewhere (like Button).


directory

directory: Signal<string>

Defined in: files/src/list/file-list.ts:21

The current directory; the list re-scans whenever it changes.


filter?

optional filter?: (entry) => boolean

Defined in: files/src/list/file-list.ts:27

An extra predicate AND-ed with the wildcard; off by default.

Parameters

entry

DirEntry

Returns

boolean


focused?

optional focused?: Signal<number>

Defined in: files/src/list/file-list.ts:29

The focused display index (default an internal signal at 0).


fs

fs: FileSystem

Defined in: files/src/list/file-list.ts:19

The filesystem to read through.


onOpenEntry?

optional onOpenEntry?: (entry) => void

Defined in: files/src/list/file-list.ts:35

Fired on Enter/double-click with the activated entry (enter a directory / resolve a file).

Parameters

entry

DirEntry

Returns

void


selected?

optional selected?: Signal<number>

Defined in: files/src/list/file-list.ts:31

The selected display index (default an internal signal at -1).


showHidden?

optional showHidden?: Signal<boolean>

Defined in: files/src/list/file-list.ts:25

Whether hidden (dot) files are shown (default an internal false signal).


wildcard?

optional wildcard?: Signal<string>

Defined in: files/src/list/file-list.ts:23

The file wildcard (default an internal '*' signal). Applies to files only.