textual-filedrop 0.2.3

FileDrop widget for Textual, easily drag and drop files into your terminal apps.

textual-filedrop

Add filedrop support to your Textual apps, easily drag and drop files into your terminal apps.

Tested on Windows and macOS.

Nerd Font is required to display file icons.

Install

pip install textual-filedrop

or

git clone https://github.com/agmmnn/textual-filedrop.git
cd textual-filedrop
poetry install

Usage

You can find more examples here.

from textual_filedrop import FileDrop

# add FileDrop widget to your app
yield FileDrop(id="filedrop")

# focus the widget
self.query_one("#filedrop").focus()

# when the files are dropped
def on_file_drop_dropped(self, message: FileDrop.Dropped) -> None:
    path = message.path
    filepaths = message.filepaths
    filenames = message.filenames
    filesobj = message.filesobj
    print(path, filepaths, filenames, filesobj)


# output: path, [filepaths], [filenames], [filesobj]

Examples

subdomain_lister

Drag and drop the subdomain list files and see the results as a tree list.

fullscreen

Fullscreen example, will show the results in the textual console.

hidden

As long as focus is on, the FileDrop widget will be active even if it is not visible on the screen.

Dev

poetry install

textual console
poetry run textual run --dev examples/subdomain_lister.py