Skip to content

Directory tree

DirectoryTree

Bases: Tree[DirEntry]

A Tree widget that presents files and directories.

Parameters:

Name Type Description Default
path str

Path to directory.

required
name str | None

The name of the widget, or None for no name. Defaults to None.

None
id str | None

The ID of the widget in the DOM, or None for no ID. Defaults to None.

None
classes str | None

A space-separated list of classes, or None for no classes. Defaults to None.

None

process_label(label)

Process a str or Text into a label. Maybe overridden in a subclass to modify how labels are rendered.

Parameters:

Name Type Description Default
label TextType

Label.

required

Returns:

Type Description

A Rich Text object.