Skip to content

Commit

Permalink
Adds variant and interactive props to gr.UploadButton (#4436)
Browse files Browse the repository at this point in the history
* upload button

* fix index

* changelog

* formatting

* cleanup
  • Loading branch information
abidlabs authored Jun 6, 2023
1 parent e06317b commit 9c45ace
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## New Features:

No changes to highlight.
- The `gr.UploadButton` component now supports the `variant` and `interactive` parameters by [@abidlabs](https://github.com/abidlabs) in [PR 4436](https://github.com/gradio-app/gradio/pull/4436).

## Bug Fixes:

Expand Down
27 changes: 20 additions & 7 deletions gradio/components.py
Original file line number Diff line number Diff line change
Expand Up @@ -3337,7 +3337,7 @@ def __init__(
self,
value: str | Callable = "Run",
*,
variant: str = "secondary",
variant: Literal["primary", "secondary", "stop"] = "secondary",
visible: bool = True,
interactive: bool = True,
elem_id: str | None = None,
Expand Down Expand Up @@ -3378,7 +3378,7 @@ def get_config(self):
@staticmethod
def update(
value: str | Literal[_Keywords.NO_VALUE] | None = _Keywords.NO_VALUE,
variant: str | None = None,
variant: Literal["primary", "secondary", "stop"] | None = None,
visible: bool | None = None,
interactive: bool | None = None,
):
Expand All @@ -3394,7 +3394,7 @@ def style(
self,
*,
full_width: bool | None = None,
size: Literal["sm"] | Literal["lg"] | None = None,
size: Literal["sm", "lg"] | None = None,
**kwargs,
):
"""
Expand Down Expand Up @@ -3427,7 +3427,9 @@ def __init__(
label: str = "Upload a File",
value: str | list[str] | Callable | None = None,
*,
variant: Literal["primary", "secondary", "stop"] = "secondary",
visible: bool = True,
interactive: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
type: str = "file",
Expand All @@ -3437,12 +3439,14 @@ def __init__(
):
"""
Parameters:
value: Default text for the button to display.
label: Text to display on the button. Defaults to "Upload a File".
value: File or list of files to upload by default.
variant: 'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button.
type: 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: 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 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.
label: Text to display on the button. Defaults to "Upload a File".
visible: If False, component will be hidden.
interactive: If False, the UploadButton will be in a disabled state.
elem_id: 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: 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.
"""
Expand All @@ -3458,32 +3462,41 @@ def __init__(
)
self.file_types = file_types
self.label = label
self.variant = variant
IOComponent.__init__(
self,
label=label,
visible=visible,
elem_id=elem_id,
elem_classes=elem_classes,
value=value,
interactive=interactive,
**kwargs,
)

def get_config(self):
return {
"label": self.label,
"value": self.value,
"variant": self.variant,
"file_count": self.file_count,
"file_types": self.file_types,
"interactive": self.interactive,
**Component.get_config(self),
}

@staticmethod
def update(
value: str | Literal[_Keywords.NO_VALUE] | None = _Keywords.NO_VALUE,
value: str
| list[str]
| Literal[_Keywords.NO_VALUE]
| None = _Keywords.NO_VALUE,
variant: Literal["primary", "secondary", "stop"] | None = None,
interactive: bool | None = None,
visible: bool | None = None,
):
return {
"variant": variant,
"interactive": interactive,
"visible": visible,
"value": value,
Expand Down Expand Up @@ -3556,7 +3569,7 @@ def style(
self,
*,
full_width: bool | None = None,
size: Literal["sm"] | Literal["lg"] | None = None,
size: Literal["sm", "lg"] | None = None,
**kwargs,
):
"""
Expand Down
4 changes: 2 additions & 2 deletions gradio/queueing.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import time
from asyncio import TimeoutError as AsyncTimeOutError
from collections import deque
from typing import Any, Deque
from typing import Any

import fastapi
import httpx
Expand Down Expand Up @@ -46,7 +46,7 @@ def __init__(
max_size: int | None,
blocks_dependencies: list,
):
self.event_queue: Deque[Event] = deque()
self.event_queue: deque[Event] = deque()
self.events_pending_reconnection = []
self.stopped = False
self.max_thread_count = concurrency_count
Expand Down
4 changes: 4 additions & 0 deletions js/app/src/components/UploadButton/UploadButton.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
export let file_count: string;
export let file_types: Array<string> = ["file"];
export let root: string;
export let mode: "static" | "dynamic" = "dynamic";
export let variant: "primary" | "secondary" | "stop" = "secondary";
async function handle_upload({ detail }: CustomEvent<FileData>) {
value = detail;
Expand Down Expand Up @@ -59,6 +61,8 @@
{visible}
{file_count}
{file_types}
{mode}
{variant}
on:click
on:load={handle_upload}
>
Expand Down
2 changes: 1 addition & 1 deletion js/app/src/components/UploadButton/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export { default as Component } from "./UploadButton.svelte";
export const modes = ["static"];
export const modes = ["static", "dynamic"];
5 changes: 4 additions & 1 deletion js/upload-button/src/UploadButton.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
export let file_count: string;
export let file_types: Array<string> = ["file"];
export let include_file_metadata = true;
export let mode: "static" | "dynamic" = "dynamic";
export let variant: "primary" | "secondary" | "stop" = "secondary";
let hidden_upload: HTMLInputElement;
const dispatch = createEventDispatcher();
Expand Down Expand Up @@ -83,12 +85,13 @@

<Button
{size}
variant="secondary"
{variant}
{elem_id}
{elem_classes}
{visible}
on:click={openFileUpload}
{style}
disabled={mode === "static"}
>
<slot />
</Button>
Expand Down

0 comments on commit 9c45ace

Please sign in to comment.