---
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`
<a href="https://pypi.org/project/megickfilebrowse/" target="_blank"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/megickfilebrowse"></a> <a href="https://github.com/Mejikan/megickfilebrowse/issues" target="_blank"><img alt="Static Badge" src="https://img.shields.io/badge/Issues-white?logo=github&logoColor=black"></a>
An extension of Gradio's FileExplorer, with more customization.
## Installation
```bash
pip install megickfilebrowse
```
## Usage
```python
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
<table>
<thead>
<tr>
<th align="left">name</th>
<th align="left" style="width: 25%;">type</th>
<th align="left">default</th>
<th align="left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>value</code></td>
<td align="left" style="width: 25%;">
```python
list[list[str]] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>file_count</code></td>
<td align="left" style="width: 25%;">
```python
"single" | "multiple"
```
</td>
<td align="left"><code>"multiple"</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>label</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>every</code></td>
<td align="left" style="width: 25%;">
```python
float | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>show_label</code></td>
<td align="left" style="width: 25%;">
```python
bool | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">if True, will display label.</td>
</tr>
<tr>
<td align="left"><code>container</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If True, will place the component in a container - providing some extra padding around the border.</td>
</tr>
<tr>
<td align="left"><code>scale</code></td>
<td align="left" style="width: 25%;">
```python
int | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>min_width</code></td>
<td align="left" style="width: 25%;">
```python
int
```
</td>
<td align="left"><code>160</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>height</code></td>
<td align="left" style="width: 25%;">
```python
int | float | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>interactive</code></td>
<td align="left" style="width: 25%;">
```python
bool | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>visible</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, component will be hidden.</td>
</tr>
<tr>
<td align="left"><code>elem_id</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>elem_classes</code></td>
<td align="left" style="width: 25%;">
```python
list[str] | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>render</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>key</code></td>
<td align="left" style="width: 25%;">
```python
int | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>root</code></td>
<td align="left" style="width: 25%;">
```python
None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">None</td>
</tr>
</tbody></table>
### 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.
```python
def predict(
value: tuple[list[str], list[str]]
) -> list[list[str]] | None:
return value
```
Raw data
{
"_id": null,
"home_page": null,
"name": "megickfilebrowse",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "file, gradio-custom-component, gradio-template-FileExplorer",
"author": null,
"author_email": "Mejikan <mejikan@example.com>",
"download_url": "https://files.pythonhosted.org/packages/80/b8/c72bf58f53067948d4e744464e75119525cf59764b214c52ede6d4e7f69c/megickfilebrowse-0.0.4.tar.gz",
"platform": null,
"description": "---\ntags: [gradio-custom-component, FileExplorer, file]\ntitle: gradio_megickfilebrowse\nshort_description: An extension of Gradio's FileExplorer, with more customization.\ncolorFrom: blue\ncolorTo: yellow\nsdk: gradio\npinned: false\napp_file: space.py\n---\n\n# `megickfilebrowse`\n<a href=\"https://pypi.org/project/megickfilebrowse/\" target=\"_blank\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/megickfilebrowse\"></a> <a href=\"https://github.com/Mejikan/megickfilebrowse/issues\" target=\"_blank\"><img alt=\"Static Badge\" src=\"https://img.shields.io/badge/Issues-white?logo=github&logoColor=black\"></a> \n\nAn extension of Gradio's FileExplorer, with more customization.\n\n## Installation\n\n```bash\npip install megickfilebrowse\n```\n\n## Usage\n\n```python\nimport gradio as gr\nfrom megickfilebrowse import FileBrowser\n\nwith gr.Blocks() as demo:\n files = [\n \"foo/bar/foo.txt\",\n \"foo/bar/foo2.txt\",\n \"foo/bar/\",\n \"foo/fuzz/hello.py\",\n \"foo/fuzz/\",\n \"foo/\",\n ]\n selected_files = [\"foo/bar/foo.txt\"]\n b = FileBrowser(\n value=[files, selected_files], interactive=True, file_count=\"single\"\n )\n\n b.change(lambda x: print(\"change\", x), inputs=[b])\n\n\nif __name__ == \"__main__\":\n demo.launch()\n\n```\n\n## `FileBrowser`\n\n### Initialization\n\n<table>\n<thead>\n<tr>\n<th align=\"left\">name</th>\n<th align=\"left\" style=\"width: 25%;\">type</th>\n<th align=\"left\">default</th>\n<th align=\"left\">description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"left\"><code>value</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nlist[list[str]] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>file_count</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\n\"single\" | \"multiple\"\n```\n\n</td>\n<td align=\"left\"><code>\"multiple\"</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>label</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>every</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nfloat | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>show_label</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">if True, will display label.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>container</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If True, will place the component in a container - providing some extra padding around the border.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>scale</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>min_width</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint\n```\n\n</td>\n<td align=\"left\"><code>160</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>height</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | float | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>interactive</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>visible</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If False, component will be hidden.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_id</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_classes</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nlist[str] | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>render</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>key</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>root</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nNone\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">None</td>\n</tr>\n</tbody></table>\n\n\n### Events\n\n| name | description |\n|:-----|:------------|\n| `change` | |\n\n\n\n### User function\n\nThe impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).\n\n- When used as an Input, the component only impacts the input signature of the user function.\n- When used as an output, the component only impacts the return signature of the user function.\n\nThe code snippet below is accurate in cases where the component is used as both an input and an output.\n\n- **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.\n- **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.\n\n ```python\n def predict(\n value: tuple[list[str], list[str]]\n ) -> list[list[str]] | None:\n return value\n ```\n \n",
"bugtrack_url": null,
"license": null,
"summary": "An extension of Gradio's FileExplorer, with more customization.",
"version": "0.0.4",
"project_urls": {
"repository": "https://github.com/Mejikan/megickfilebrowse"
},
"split_keywords": [
"file",
" gradio-custom-component",
" gradio-template-fileexplorer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e446a62deb1560898a4028a6e0d943f53901ed853c0074ac21216031f81219a5",
"md5": "b1af0f80639c4f82c8453919f99a236d",
"sha256": "aad28c4898ee95a8fab5adeb87ddf84a4fa7be9f7f2b0e5f8cd9000a0839010b"
},
"downloads": -1,
"filename": "megickfilebrowse-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1af0f80639c4f82c8453919f99a236d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 42320,
"upload_time": "2024-05-28T07:25:51",
"upload_time_iso_8601": "2024-05-28T07:25:51.167930Z",
"url": "https://files.pythonhosted.org/packages/e4/46/a62deb1560898a4028a6e0d943f53901ed853c0074ac21216031f81219a5/megickfilebrowse-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "80b8c72bf58f53067948d4e744464e75119525cf59764b214c52ede6d4e7f69c",
"md5": "ed812979cc001a5dcd6fabef97adda2b",
"sha256": "b9b837ed71394a1bd5b27bdb12d78a947de44fb90550fa3d7a8e96aea342016d"
},
"downloads": -1,
"filename": "megickfilebrowse-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "ed812979cc001a5dcd6fabef97adda2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 91434,
"upload_time": "2024-05-28T07:25:52",
"upload_time_iso_8601": "2024-05-28T07:25:52.829795Z",
"url": "https://files.pythonhosted.org/packages/80/b8/c72bf58f53067948d4e744464e75119525cf59764b214c52ede6d4e7f69c/megickfilebrowse-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 07:25:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mejikan",
"github_project": "megickfilebrowse",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "megickfilebrowse"
}
JSON
