---
tags: [gradio-custom-component, UploadButton]
title: gradio_customuploadbutton
short_description: support Distributed upload
colorFrom: blue
colorTo: yellow
sdk: gradio
pinned: false
app_file: space.py
---
# `gradio_customuploadbutton`
<img alt="Static Badge" src="https://img.shields.io/badge/version%20-%200.0.3%20-%20orange">
support Distributed upload
## Installation
```bash
pip install gradio_customuploadbutton
```
## Usage
```python
import gradio as gr
from gradio_customuploadbutton import CustomUploadButton
example = CustomUploadButton().example_value()
with gr.Blocks() as demo:
with gr.Row():
CustomUploadButton(label="Blank"), # blank component
CustomUploadButton(value=example, label="Populated"), # populated component
if __name__ == "__main__":
demo.launch()
```
## `CustomUploadButton`
### 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>label</code></td>
<td align="left" style="width: 25%;">
```python
str
```
</td>
<td align="left"><code>"Upload a File"</code></td>
<td align="left">Text to display on the button. Defaults to "Upload a File".</td>
</tr>
<tr>
<td align="left"><code>value</code></td>
<td align="left" style="width: 25%;">
```python
str | I18nData | list[str] | Callable | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">File or list of files to upload by default.</td>
</tr>
<tr>
<td align="left"><code>every</code></td>
<td align="left" style="width: 25%;">
```python
Timer | float | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>inputs</code></td>
<td align="left" style="width: 25%;">
```python
Component | Sequence[Component] | set[Component] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">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.</td>
</tr>
<tr>
<td align="left"><code>variant</code></td>
<td align="left" style="width: 25%;">
```python
Literal["primary", "secondary", "stop"]
```
</td>
<td align="left"><code>"secondary"</code></td>
<td align="left">'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button.</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>size</code></td>
<td align="left" style="width: 25%;">
```python
Literal["sm", "md", "lg"]
```
</td>
<td align="left"><code>"lg"</code></td>
<td align="left">size of the button. Can be "sm", "md", or "lg".</td>
</tr>
<tr>
<td align="left"><code>icon</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">URL or path to the icon file to display within the button. If None, no icon will be displayed.</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 | None
```
</td>
<td align="left"><code>None</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>interactive</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, the CustomUploadButton will be in a disabled state.</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 | tuple[int | str, ...] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render.</td>
</tr>
<tr>
<td align="left"><code>preserved_by_key</code></td>
<td align="left" style="width: 25%;">
```python
list[str] | str | None
```
</td>
<td align="left"><code>"value"</code></td>
<td align="left">A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor.</td>
</tr>
<tr>
<td align="left"><code>type</code></td>
<td align="left" style="width: 25%;">
```python
Literal["filepath", "binary"]
```
</td>
<td align="left"><code>"filepath"</code></td>
<td align="left">Type of value to be returned by component. "file" returns a temporary file object with the same base name as the uploaded file, whose full path can be retrieved by file_obj.name, "binary" returns an bytes object.</td>
</tr>
<tr>
<td align="left"><code>file_count</code></td>
<td align="left" style="width: 25%;">
```python
Literal["single", "multiple", "directory"]
```
</td>
<td align="left"><code>"single"</code></td>
<td align="left">if single, allows user to upload one file. If "multiple", user uploads multiple files. If "directory", user uploads all files in selected directory. Return type will be list for each file in case of "multiple" or "directory".</td>
</tr>
<tr>
<td align="left"><code>file_types</code></td>
<td align="left" style="width: 25%;">
```python
list[str] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">List of type of files to be uploaded. "file" allows any file to be uploaded, "image" allows only image files to be uploaded, "audio" allows only audio files to be uploaded, "video" allows only video files to be uploaded, "text" allows only text files to be uploaded.</td>
</tr>
</tbody></table>
### Events
| name | description |
|:-----|:------------|
| `click` | Triggered when the CustomUploadButton is clicked. |
| `upload` | This listener is triggered when the user uploads a file into the CustomUploadButton. |
### 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, passes the file as a `str` or `bytes` object, or a list of `str` or list of `bytes` objects, depending on `type` and `file_count`.
- **As input:** Should return, expects a `str` filepath or URL, or a `list[str]` of filepaths/URLs.
```python
def predict(
value: bytes | str | list[bytes] | list[str] | None
) -> str | list[str] | None:
return value
```
Raw data
{
"_id": null,
"home_page": null,
"name": "gradio-customuploadbutton",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "gradio-custom-component, gradio-template-UploadButton",
"author": null,
"author_email": "YOUR NAME <YOUREMAIL@domain.com>",
"download_url": "https://files.pythonhosted.org/packages/07/7b/064af3c990adbba3c5e0160de7518718eebf71d181547779180c00a59eae/gradio_customuploadbutton-0.0.3.tar.gz",
"platform": null,
"description": "---\ntags: [gradio-custom-component, UploadButton]\ntitle: gradio_customuploadbutton\nshort_description: support Distributed upload\ncolorFrom: blue\ncolorTo: yellow\nsdk: gradio\npinned: false\napp_file: space.py\n---\n\n# `gradio_customuploadbutton`\n<img alt=\"Static Badge\" src=\"https://img.shields.io/badge/version%20-%200.0.3%20-%20orange\"> \n\nsupport Distributed upload\n\n## Installation\n\n```bash\npip install gradio_customuploadbutton\n```\n\n## Usage\n\n```python\n\nimport gradio as gr\nfrom gradio_customuploadbutton import CustomUploadButton\n\n\nexample = CustomUploadButton().example_value()\n\nwith gr.Blocks() as demo:\n with gr.Row():\n CustomUploadButton(label=\"Blank\"), # blank component\n CustomUploadButton(value=example, label=\"Populated\"), # populated component\n\n\nif __name__ == \"__main__\":\n demo.launch()\n\n```\n\n## `CustomUploadButton`\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>label</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr\n```\n\n</td>\n<td align=\"left\"><code>\"Upload a File\"</code></td>\n<td align=\"left\">Text to display on the button. Defaults to \"Upload a File\".</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>value</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | I18nData | list[str] | Callable | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">File or list of files to upload by default.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>every</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nTimer | float | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>inputs</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nComponent | Sequence[Component] | set[Component] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">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.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>variant</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nLiteral[\"primary\", \"secondary\", \"stop\"]\n```\n\n</td>\n<td align=\"left\"><code>\"secondary\"</code></td>\n<td align=\"left\">'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button.</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>size</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nLiteral[\"sm\", \"md\", \"lg\"]\n```\n\n</td>\n<td align=\"left\"><code>\"lg\"</code></td>\n<td align=\"left\">size of the button. Can be \"sm\", \"md\", or \"lg\".</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>icon</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\">URL or path to the icon file to display within the button. If None, no icon will be displayed.</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 | None\n```\n\n</td>\n<td align=\"left\"><code>None</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>interactive</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, the CustomUploadButton will be in a disabled state.</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 | tuple[int | str, ...] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>preserved_by_key</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>\"value\"</code></td>\n<td align=\"left\">A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>type</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nLiteral[\"filepath\", \"binary\"]\n```\n\n</td>\n<td align=\"left\"><code>\"filepath\"</code></td>\n<td align=\"left\">Type of value to be returned by component. \"file\" returns a temporary file object with the same base name as the uploaded file, whose full path can be retrieved by file_obj.name, \"binary\" returns an bytes object.</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\nLiteral[\"single\", \"multiple\", \"directory\"]\n```\n\n</td>\n<td align=\"left\"><code>\"single\"</code></td>\n<td align=\"left\">if single, allows user to upload one file. If \"multiple\", user uploads multiple files. If \"directory\", user uploads all files in selected directory. Return type will be list for each file in case of \"multiple\" or \"directory\".</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>file_types</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nlist[str] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">List of type of files to be uploaded. \"file\" allows any file to be uploaded, \"image\" allows only image files to be uploaded, \"audio\" allows only audio files to be uploaded, \"video\" allows only video files to be uploaded, \"text\" allows only text files to be uploaded.</td>\n</tr>\n</tbody></table>\n\n\n### Events\n\n| name | description |\n|:-----|:------------|\n| `click` | Triggered when the CustomUploadButton is clicked. |\n| `upload` | This listener is triggered when the user uploads a file into the CustomUploadButton. |\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, passes the file as a `str` or `bytes` object, or a list of `str` or list of `bytes` objects, depending on `type` and `file_count`.\n- **As input:** Should return, expects a `str` filepath or URL, or a `list[str]` of filepaths/URLs.\n\n ```python\n def predict(\n value: bytes | str | list[bytes] | list[str] | None\n ) -> str | list[str] | None:\n return value\n ```\n \n",
"bugtrack_url": null,
"license": null,
"summary": "support Distributed upload",
"version": "0.0.3",
"project_urls": null,
"split_keywords": [
"gradio-custom-component",
" gradio-template-uploadbutton"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2b308d7303618631f36783f91c51b0042660425935e14a0f61555e1c0615303e",
"md5": "6c229d4d6ba76b52980ca3c9dca47a20",
"sha256": "0a3788137f70806ae2e9e7f850a13a552ab83a593e06ac3ff85428673303364e"
},
"downloads": -1,
"filename": "gradio_customuploadbutton-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6c229d4d6ba76b52980ca3c9dca47a20",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 69545,
"upload_time": "2025-08-19T07:45:39",
"upload_time_iso_8601": "2025-08-19T07:45:39.645326Z",
"url": "https://files.pythonhosted.org/packages/2b/30/8d7303618631f36783f91c51b0042660425935e14a0f61555e1c0615303e/gradio_customuploadbutton-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "077b064af3c990adbba3c5e0160de7518718eebf71d181547779180c00a59eae",
"md5": "d2bdeb457d93a7fb93230e11b7ef2b8b",
"sha256": "a748bac835a77118b4d57ea17698894cf6b9a0c29ffae1a6e69e115f81bd4a07"
},
"downloads": -1,
"filename": "gradio_customuploadbutton-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d2bdeb457d93a7fb93230e11b7ef2b8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 137374,
"upload_time": "2025-08-19T07:45:41",
"upload_time_iso_8601": "2025-08-19T07:45:41.188007Z",
"url": "https://files.pythonhosted.org/packages/07/7b/064af3c990adbba3c5e0160de7518718eebf71d181547779180c00a59eae/gradio_customuploadbutton-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-19 07:45:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gradio-customuploadbutton"
}
JSON