megickfilebrowse 0.0.4

An extension of Gradio's FileExplorer, with more customization.

---

tags: [gradio-custom-component, FileExplorer, file] title: gradio_megickfilebrowse short_description: An extension of Gradio's FileExplorer, with more customization. colorFrom: blue colorTo: yellow sdk: gradio pinned: false app_file: space.py

megickfilebrowse

An extension of Gradio's FileExplorer, with more customization.

Installation

pip install megickfilebrowse

Usage

import gradio as gr
from megickfilebrowse import FileBrowser

with gr.Blocks() as demo:
    files = [
        "foo/bar/foo.txt",
        "foo/bar/foo2.txt",
        "foo/bar/",
        "foo/fuzz/hello.py",
        "foo/fuzz/",
        "foo/",
    ]
    selected_files = ["foo/bar/foo.txt"]
    b = FileBrowser(
        value=[files, selected_files], interactive=True, file_count="single"
    )

    b.change(lambda x: print("change", x), inputs=[b])


if __name__ == "__main__":
    demo.launch()

FileBrowser

Initialization

name	type	default	description
value	list[list[str]] | None	None	A list of files and selected files as a `list[list[str]]`, the first list is a list of files and the second list is a list of selected files.
file_count	"single" | "multiple"	"multiple"	Whether to allow single or multiple files to be selected. If "single", the component will return a single absolute file path as a string. If "multiple", the component will return a list of absolute file paths as a list of strings.
label	str | 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	float | None	None	If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise.sed (e.g. to cancel it) via this component's .load_event attribute.
show_label	bool | None	None	if True, will display 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. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.
min_width	int	160	minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.
height	int | float | None	None	The maximum height of the file component, specified in pixels if a number is passed, or in CSS units if a string is passed. If more files are uploaded than can fit in the height, a scrollbar will appear.
interactive	bool | None	None	if True, will allow users to select file(s); if False, will only display files. If not provided, this is inferred based on whether the component is used as an input or output.
visible	bool	True	If False, component will be hidden.
elem_id	str | None	None	An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
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. Can be used for targeting CSS styles.
render	bool	True	If False, component will not render 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 | None	None	if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.
root	None	None	None

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, full list of files and selected files as list[list[str]], the first list is a list of files and the second list is a list of selected files.
• As input: Should return, expects function to return a list[list[str]], the first list is a list of files and the second list is a list of selected files.

def predict(
    value: tuple[list[str], list[str]]
) -> list[list[str]] | None:
    return value