README.md

metadata

tags:
  - gradio-custom-component
  - FileExplorer
title: gradio_folderexplorer
short_description: A FolderExplorer for Gradio UI
colorFrom: blue
colorTo: yellow
sdk: gradio
pinned: false
app_file: space.py

gradio_folderexplorer

💻 Component GitHub Code

A FolderExplorer for Gradio UI

Installation

pip install gradio_folderexplorer

Usage

import gradio as gr
from gradio_folderexplorer import FolderExplorer
from gradio_folderexplorer.helpers import load_media_from_folder
from PIL import Image
import os

# --- Configuration Constants ---

# Define the root directory for the FolderExplorer to start in.
# All browsable folders will be relative to this path.
ROOT_DIR_PATH = "./examples"

# --- UI Layout and Logic ---

# Create the user interface using Gradio Blocks.
with gr.Blocks(theme=gr.themes.Ocean()) as demo:
    # A single row is used to create a side-by-side layout.
    gr.Markdown("# FolderExplorer Component Demo")
    with gr.Row(equal_height=True):
        # The first column contains the custom folder explorer component.
        with gr.Column(scale=1, min_width=300):
            folder_explorer = FolderExplorer(
                label="Select a Folder",
                root_dir=ROOT_DIR_PATH,
                # Set the initial selected value to the root directory itself.
                # This is used by the demo.load() event.
                value=ROOT_DIR_PATH
            )
        
        # The second column contains the gallery to display the media.
        with gr.Column(scale=3):
            gallery = gr.Gallery(
                label="Selected Images",
                columns=6,
                height="auto",
            )

    # --- Event Handling ---

    # 1. Event for user interaction:
    # When the user selects a new folder in the FolderExplorer, the .change() event
    # is triggered. The `load_media_from_folder` helper is called with the new
    # folder path, and its output populates the gallery.
    folder_explorer.change(
        fn=load_media_from_folder,
        inputs=folder_explorer,
        outputs=gallery
    )
    
    # 2. Event for initial page load:
    # This event runs once when the app starts. It takes the initial `value` of the
    # folder_explorer ('ROOT_DIR_PATH'), passes it to the helper function,
    # and populates the gallery with the media from the root directory.
    demo.load(
        fn=load_media_from_folder,
        inputs=folder_explorer,
        outputs=gallery
    )

# --- Application Launch ---
if __name__ == "__main__":
    demo.launch()

FolderExplorer

Initialization

name	type	default	description
value	str | Path | Callable | None	None	The directory path to show as "selected" when the component is first loaded. If a callable is provided, it will be called when the app loads to set the initial value.
root_dir	str | Path	"."	Path to the root directory from which to browse folders. If not provided, defaults to the current working directory. Raises ValueError if the directory does not exist or is not a directory.
label	str | I18nData | None	None	The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
every	Timer | float | None	None	Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.
inputs	Component | Sequence[Component] | set[Component] | None	None	Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.
show_label	bool | None	None	If True, will display the label.
container	bool	True	If True, will place the component in a container, providing some extra padding around the border.
scale	int | None	None	Relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer.
min_width	int	160	Minimum pixel width, will wrap if not sufficient screen space to satisfy this value.
height	int | str | None	None	The height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed.
max_height	int | str | None	500	The maximum height of the component.
min_height	int | str | None	None	The minimum height of the component.
interactive	bool | None	None	If True, will allow users to select a folder; if False, will only display the folder structure.
visible	bool | Literal["hidden"]	True	If False, component will be hidden. If "hidden", component will be visually hidden but still exist in the DOM.
elem_id	str | None	None	An optional string that is assigned as the id of this component in the HTML DOM.
elem_classes	list[str] | str | None	None	An optional list of strings that are assigned as the classes of this component in the HTML DOM.
render	bool	True	If False, component will not be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
key	int | str | tuple[int | str, ...] | None	None	In a gr.render, Components with the same key across re-renders are treated as the same component.
preserved_by_key	list[str] | str | None	"value"	A list of parameters from this component's constructor. If a component is re-rendered with the same key, these parameters will be preserved in the UI.

Events

name	description
change

User function

The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).

• When used as an Input, the component only impacts the input signature of the user function.
• When used as an output, the component only impacts the return signature of the user function.

The code snippet below is accurate in cases where the component is used as both an input and an output.

• As output: Is passed, the absolute path of the selected folder as a str. Returns the root directory if no folder is selected.
• As input: Should return, expects a str or Path object representing the directory to be selected in the UI.

def predict(
    value: str | None
) -> str | pathlib.Path | None:
    return value