gradio-neouploadbutton 0.0.10

A custom upload button for Gradio that allows users to upload with a loading message

---

tags: [gradio-custom-component, UploadButton] title: gradio_neouploadbutton short_description: A gradio custom component colorFrom: blue colorTo: yellow sdk: gradio pinned: false app_file: space.py

gradio_neouploadbutton

A custom upload button for Gradio that allows users to upload with a loading message

Installation

pip install gradio_neouploadbutton

Usage

import gradio as gr
from gradio_neouploadbutton import NeoUploadButton

example = NeoUploadButton().example_value()

with gr.Blocks() as demo:
    button = NeoUploadButton(
        value=example, label="Load a file", loading_message="... Loading ..."
    )  # populated component
    button2 = NeoUploadButton(label="Charger un fichier", loading_message="... Chargement ...")  # empty component

    file = gr.File()  # output component
    button.upload(fn=lambda x: x, inputs=button, outputs=file)
    button2.upload(fn=lambda x: x, inputs=button2, outputs=file)


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

NeoUploadButton

Initialization

name	type	default	description
label	str	"Upload a File"	Text to display on the button. Defaults to "Upload a File".
value	str | list[str] | Callable | None	None	File or list of files to upload by default.
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.
variant	Literal["primary", "secondary", "stop"]	"secondary"	'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button.
visible	bool	True	If False, component will be hidden.
size	Literal["sm", "lg"] | None	None	Size of the button. Can be "sm" or "lg".
icon	str | None	None	URL or path to the icon file to display within the button. If None, no icon will be displayed.
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 | None	None	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.
interactive	bool	True	If False, the NeoUploadButton will be in a disabled state.
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.
type	Literal["filepath", "bytes"]	"filepath"	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.
file_count	Literal["single", "multiple", "directory"]	"single"	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".
file_types	list[str] | None	None	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.
loading_message	str | None	None	the custom message displayed while loading. If None, no message will be displayed.

Events

name	description
click	Triggered when the NeoUploadButton is clicked.
upload	This listener is triggered when the user uploads a file into the NeoUploadButton.

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.

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