beamtea_filepicker (beamtea v0.1.0)

View Source

A bubble: a filesystem picker, mirroring the filepicker package in charmbracelet/bubbles.

Browse directories with the arrows, descend with Enter/→, ascend with ←/Backspace. Selecting a file records it; read it back with did_select_file/1.

Summary

Types

model/0

Functions

did_select_file(_)

The path of a file the user selected, or none.

highlighted(_)

The {Name, IsDir} currently under the cursor, or none.

new()

Equivalent to new(#{}).

new(Opts)

Options: path (starting directory, default cwd), height (visible rows, default 12), colours.

path(_)
update(Msg, M)

Navigate in response to a key.

view(_)

Render the current path and the visible window of entries.

Types

model/0

-opaque model()

Functions

did_select_file(_)

-spec did_select_file(model()) -> none | file:filename().

The path of a file the user selected, or none.

highlighted(_)

-spec highlighted(model()) -> {binary(), boolean()} | none.

The {Name, IsDir} currently under the cursor, or none.

new()

-spec new() -> model().

Equivalent to new(#{}).

new(Opts)

-spec new(map()) -> model().

Options: path (starting directory, default cwd), height (visible rows, default 12), colours.

path(_)

-spec path(model()) -> file:filename().

update(Msg, M)

-spec update(term(), model()) -> {model(), beamtea:cmd()}.

Navigate in response to a key.

view(_)

-spec view(model()) -> iodata().

Render the current path and the visible window of entries.