Upload folder using huggingface_hub

6.4.1/file/Example.svelte

@@ -0,0 +1,36 @@
+<script lang="ts">
+	import type { FileData } from "@gradio/client";
+
+	let {
+		value,
+		type,
+		selected = false
+	}: {
+		value: FileData | null;
+		type: "gallery" | "table";
+		selected: boolean;
+	} = $props();
+</script>
+
+<div
+	class:table={type === "table"}
+	class:gallery={type === "gallery"}
+	class:selected
+>
+	{value ? (Array.isArray(value) ? value.join(", ") : value) : ""}
+</div>
+
+<style>
+	div {
+		overflow: hidden;
+		text-overflow: ellipsis;
+		white-space: nowrap;
+	}
+	.gallery {
+		display: flex;
+		align-items: center;
+		cursor: pointer;
+		padding: var(--size-1) var(--size-2);
+		text-align: left;
+	}
+</style>

6.4.1/file/Index.svelte

@@ -0,0 +1,126 @@
+<svelte:options accessors={true} />
+
+<script context="module" lang="ts">
+	export { default as FilePreview } from "./shared/FilePreview.svelte";
+	export { default as BaseFileUpload } from "./shared/FileUpload.svelte";
+	export { default as BaseFile } from "./shared/File.svelte";
+	export { default as BaseExample } from "./Example.svelte";
+</script>
+
+<script lang="ts">
+	import { Gradio } from "@gradio/utils";
+	import File from "./shared/File.svelte";
+	import FileUpload from "./shared/FileUpload.svelte";
+	import { Block, UploadText } from "@gradio/atoms";
+	import type { FileEvents, FileProps } from "./types";
+	import type { SelectData } from "@gradio/utils";
+	import { StatusTracker } from "@gradio/statustracker";
+	import { tick } from "svelte";
+
+	const props = $props();
+	let upload_promise = $state<Promise<any> | null>(null);
+
+	let dragging = $state(false);
+	let pending_upload = $state(false);
+
+	class FileGradio extends Gradio<FileEvents, FileProps> {
+		async get_data() {
+			if (upload_promise) {
+				await upload_promise;
+				await tick();
+			}
+			const data = await super.get_data();
+
+			return data;
+		}
+	}
+
+	const gradio = new FileGradio(props);
+
+	let old_value = $state(gradio.props.value);
+
+	$effect(() => {
+		if (old_value !== gradio.props.value) {
+			old_value = gradio.props.value;
+			gradio.dispatch("change", $state.snapshot(gradio.props.value));
+		}
+	});
+</script>
+
+<Block
+	visible={gradio.shared.visible}
+	variant={gradio.props.value ? "solid" : "dashed"}
+	border_mode={dragging ? "focus" : "base"}
+	padding={false}
+	elem_id={gradio.shared.elem_id}
+	elem_classes={gradio.shared.elem_classes}
+	container={gradio.shared.container}
+	scale={gradio.shared.scale}
+	min_width={gradio.shared.min_width}
+	allow_overflow={false}
+>
+	<StatusTracker
+		autoscroll={gradio.shared.autoscroll}
+		i18n={gradio.i18n}
+		{...gradio.shared.loading_status}
+		status={pending_upload
+			? "generating"
+			: gradio.shared.loading_status?.status || "complete"}
+		on_clear_status={() =>
+			gradio.dispatch("clear_status", gradio.shared.loading_status)}
+	/>
+	{#if !gradio.shared.interactive}
+		<File
+			on_select={({ detail }) => gradio.dispatch("select", detail)}
+			on_download={({ detail }) => gradio.dispatch("download", detail)}
+			selectable={gradio.props._selectable}
+			value={gradio.props.value}
+			label={gradio.shared.label}
+			show_label={gradio.shared.show_label}
+			height={gradio.props.height}
+			i18n={gradio.i18n}
+			buttons={gradio.props.buttons}
+			on_custom_button_click={(id) => {
+				gradio.dispatch("custom_button_click", { id });
+			}}
+		/>
+	{:else}
+		<FileUpload
+			bind:upload_promise
+			upload={(...args) => gradio.shared.client.upload(...args)}
+			stream_handler={(...args) => gradio.shared.client.stream(...args)}
+			label={gradio.shared.label}
+			show_label={gradio.shared.show_label}
+			value={gradio.props.value}
+			file_count={gradio.props.file_count}
+			file_types={gradio.props.file_types}
+			selectable={gradio.props._selectable}
+			height={gradio.props.height ?? undefined}
+			root={gradio.shared.root}
+			allow_reordering={gradio.props.allow_reordering}
+			max_file_size={gradio.shared.max_file_size}
+			buttons={gradio.props.buttons}
+			on_custom_button_click={(id) => {
+				gradio.dispatch("custom_button_click", { id });
+			}}
+			onchange={(detail) => {
+				gradio.props.value = detail;
+			}}
+			ondrag={(detail) => (dragging = detail)}
+			onclear={() => gradio.dispatch("clear")}
+			onselect={(detail: SelectData) => gradio.dispatch("select", detail)}
+			onupload={() => gradio.dispatch("upload")}
+			onerror={(error) => {
+				gradio.shared.loading_status = gradio.shared.loading_status || {};
+				gradio.shared.loading_status.status = "error";
+				gradio.dispatch("error", error);
+			}}
+			ondelete={(detail) => {
+				gradio.dispatch("delete", detail);
+			}}
+			i18n={gradio.i18n}
+		>
+			<UploadText i18n={gradio.i18n} type="file" />
+		</FileUpload>
+	{/if}
+</Block>

6.4.1/file/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@gradio/file",
+	"version": "0.14.1",
+	"description": "Gradio UI packages",
+	"type": "module",
+	"author": "",
+	"license": "ISC",
+	"private": false,
+	"dependencies": {
+		"@gradio/atoms": "workspace:^",
+		"@gradio/client": "workspace:^",
+		"@gradio/icons": "workspace:^",
+		"@gradio/statustracker": "workspace:^",
+		"@gradio/upload": "workspace:^",
+		"@gradio/utils": "workspace:^"
+	},
+	"devDependencies": {
+		"@gradio/preview": "workspace:^"
+	},
+	"main": "./Index.svelte",
+	"main_changeset": true,
+	"exports": {
+		".": {
+			"gradio": "./Index.svelte",
+			"svelte": "./dist/Index.svelte",
+			"types": "./dist/Index.svelte.d.ts"
+		},
+		"./example": {
+			"gradio": "./Example.svelte",
+			"svelte": "./dist/Example.svelte",
+			"types": "./dist/Example.svelte.d.ts"
+		},
+		"./package.json": "./package.json"
+	},
+	"peerDependencies": {
+		"svelte": "^5.48.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/gradio-app/gradio.git",
+		"directory": "js/file"
+	}
+}

6.4.1/file/shared/File.svelte

@@ -0,0 +1,42 @@
+<script lang="ts">
+	import { BlockLabel, Empty, IconButtonWrapper } from "@gradio/atoms";
+	import { File } from "@gradio/icons";
+	import FilePreview from "./FilePreview.svelte";
+	import type { CustomButton as CustomButtonType } from "@gradio/utils";
+
+	let {
+		value,
+		label,
+		show_label,
+		selectable,
+		i18n,
+		height,
+		buttons = null,
+		on_custom_button_click = null,
+		on_select,
+		on_download
+	} = $props();
+</script>
+
+{#if show_label && buttons && buttons.length > 0}
+	<IconButtonWrapper {buttons} {on_custom_button_click} />
+{/if}
+<BlockLabel
+	{show_label}
+	float={value === null}
+	Icon={File}
+	label={label || "File"}
+/>
+
+{#if value && (Array.isArray(value) ? value.length > 0 : true)}
+	<FilePreview
+		{i18n}
+		{selectable}
+		on:select={on_select}
+		on:download={on_download}
+		{value}
+		{height}
+	/>
+{:else}
+	<Empty unpadded_box={true} size="large"><File /></Empty>
+{/if}

6.4.1/file/shared/FilePreview.svelte

@@ -0,0 +1,328 @@
+<script lang="ts">
+	import type { FileData } from "@gradio/client";
+	import { prettyBytes } from "./utils";
+	import type { I18nFormatter, SelectData } from "@gradio/utils";
+	import { DownloadLink } from "@gradio/atoms";
+
+	let {
+		value,
+		selectable = false,
+		height = undefined,
+		i18n,
+		allow_reordering = false,
+		onselect,
+		onchange,
+		ondelete,
+		ondownload
+	}: {
+		value: FileData | FileData[];
+		selectable?: boolean;
+		height?: number | string | undefined;
+		i18n: I18nFormatter;
+		allow_reordering?: boolean;
+		onselect?: (event_data: SelectData) => void;
+		onchange?: (event_data: FileData[] | FileData) => void;
+		ondelete?: (event_data: FileData) => void;
+		ondownload?: (event_data: FileData) => void;
+	} = $props();
+
+	let dragging_index: number | null = $state(null);
+	let drop_target_index: number | null = $state(null);
+
+	function handle_drag_start(event: DragEvent, index: number): void {
+		dragging_index = index;
+		if (event.dataTransfer) {
+			event.dataTransfer.effectAllowed = "move";
+			event.dataTransfer.setData("text/plain", index.toString());
+		}
+	}
+
+	function handle_drag_over(event: DragEvent, index: number): void {
+		event.preventDefault();
+		if (index === normalized_files.length - 1) {
+			const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
+			const midY = rect.top + rect.height / 2;
+			drop_target_index =
+				event.clientY > midY ? normalized_files.length : index;
+		} else {
+			drop_target_index = index;
+		}
+		if (event.dataTransfer) {
+			event.dataTransfer.dropEffect = "move";
+		}
+	}
+
+	function handle_drag_end(event: DragEvent): void {
+		if (
+			!event.dataTransfer?.dropEffect ||
+			event.dataTransfer.dropEffect === "none"
+		) {
+			dragging_index = null;
+			drop_target_index = null;
+		}
+	}
+
+	function handle_drop(event: DragEvent, index: number): void {
+		event.preventDefault();
+		if (dragging_index === null || dragging_index === index) return;
+
+		const files = Array.isArray(value) ? [...value] : [value];
+		const [removed] = files.splice(dragging_index, 1);
+		files.splice(
+			drop_target_index === normalized_files.length
+				? normalized_files.length
+				: index,
+			0,
+			removed
+		);
+
+		const new_value = Array.isArray(value) ? files : files[0];
+		onchange?.(new_value);
+
+		dragging_index = null;
+		drop_target_index = null;
+	}
+
+	function split_filename(filename: string): [string, string] {
+		const last_dot = filename.lastIndexOf(".");
+		if (last_dot === -1) {
+			return [filename, ""];
+		}
+		return [filename.slice(0, last_dot), filename.slice(last_dot)];
+	}
+
+	let normalized_files = $derived(
+		(Array.isArray(value) ? value : [value]).map((file) => {
+			const [filename_stem, filename_ext] = split_filename(
+				file.orig_name ?? ""
+			);
+			return {
+				...file,
+				filename_stem,
+				filename_ext
+			};
+		})
+	);
+
+	function handle_row_click(
+		event: MouseEvent & { currentTarget: HTMLTableRowElement },
+		index: number
+	): void {
+		const tr = event.currentTarget;
+		const should_select =
+			event.target === tr || // Only select if the click is on the row itself
+			(tr &&
+				tr.firstElementChild &&
+				event.composedPath().includes(tr.firstElementChild)); // Or if the click is on the name column
+
+		if (should_select) {
+			onselect?.({ value: normalized_files[index].orig_name, index });
+		}
+	}
+
+	function remove_file(index: number): void {
+		const files = Array.isArray(value) ? [...value] : [value];
+		const removed = files.splice(index, 1);
+		const new_value = Array.isArray(value) ? files : files[0];
+		value = new_value;
+		ondelete?.(removed[0]);
+		onchange?.(new_value);
+	}
+
+	function handle_download(file: FileData): void {
+		ondownload?.(file);
+	}
+
+	const is_browser = typeof window !== "undefined";
+</script>
+
+<div
+	class="file-preview-holder"
+	style:max-height={height
+		? typeof height === "number"
+			? height + "px"
+			: height
+		: "auto"}
+>
+	<table class="file-preview">
+		<tbody>
+			{#each normalized_files as file, i (file.url)}
+				<tr
+					class="file"
+					class:selectable
+					class:dragging={dragging_index === i}
+					class:drop-target={drop_target_index === i ||
+						(i === normalized_files.length - 1 &&
+							drop_target_index === normalized_files.length)}
+					data-drop-target={drop_target_index === normalized_files.length &&
+					i === normalized_files.length - 1
+						? "after"
+						: drop_target_index === i + 1
+							? "after"
+							: "before"}
+					draggable={allow_reordering && normalized_files.length > 1}
+					onclick={(event) => {
+						handle_row_click(event, i);
+					}}
+					ondragstart={(event) => handle_drag_start(event, i)}
+					ondragenter={(event) => event.preventDefault()}
+					ondragover={(event) => handle_drag_over(event, i)}
+					ondrop={(event) => handle_drop(event, i)}
+					ondragend={handle_drag_end}
+				>
+					<td class="filename" aria-label={file.orig_name}>
+						{#if allow_reordering && normalized_files.length > 1}
+							<span class="drag-handle">⋮⋮</span>
+						{/if}
+						<span class="stem">{file.filename_stem}</span>
+						<span class="ext">{file.filename_ext}</span>
+					</td>
+
+					<td class="download">
+						{#if file.url}
+							<DownloadLink
+								href={file.url}
+								on:click={() => handle_download(file)}
+								download={is_browser && window.__is_colab__
+									? null
+									: file.orig_name}
+							>
+								{@html file.size != null
+									? prettyBytes(file.size)
+									: "(size unknown)"}&nbsp;&#8675;
+							</DownloadLink>
+						{:else}
+							{i18n("file.uploading")}
+						{/if}
+					</td>
+
+					{#if normalized_files.length > 1}
+						<td>
+							<button
+								class="label-clear-button"
+								aria-label="Remove this file"
+								onclick={() => {
+									remove_file(i);
+								}}
+								onkeydown={(event) => {
+									if (event.key === "Enter") {
+										remove_file(i);
+									}
+								}}
+								>×
+							</button>
+						</td>
+					{/if}
+				</tr>
+			{/each}
+		</tbody>
+	</table>
+</div>
+
+<style>
+	.label-clear-button {
+		color: var(--body-text-color-subdued);
+		position: relative;
+		left: -3px;
+	}
+
+	.label-clear-button:hover {
+		color: var(--body-text-color);
+	}
+
+	.file-preview {
+		table-layout: fixed;
+		width: var(--size-full);
+		max-height: var(--size-60);
+		overflow-y: auto;
+		margin-top: var(--size-1);
+		color: var(--body-text-color);
+	}
+
+	.file-preview-holder {
+		overflow: auto;
+	}
+
+	.file {
+		display: flex;
+		width: var(--size-full);
+	}
+
+	.file > * {
+		padding: var(--size-1) var(--size-2-5);
+	}
+
+	.filename {
+		flex-grow: 1;
+		display: flex;
+		overflow: hidden;
+	}
+	.filename .stem {
+		overflow: hidden;
+		text-overflow: ellipsis;
+		white-space: nowrap;
+	}
+	.filename .ext {
+		white-space: nowrap;
+	}
+
+	.download {
+		min-width: 8rem;
+		width: 10%;
+		white-space: nowrap;
+		text-align: right;
+	}
+	.download:hover {
+		text-decoration: underline;
+	}
+	.download > :global(a) {
+		color: var(--link-text-color);
+	}
+
+	.download > :global(a:hover) {
+		color: var(--link-text-color-hover);
+	}
+	.download > :global(a:visited) {
+		color: var(--link-text-color-visited);
+	}
+	.download > :global(a:active) {
+		color: var(--link-text-color-active);
+	}
+	.selectable {
+		cursor: pointer;
+	}
+
+	tbody > tr:nth-child(even) {
+		background: var(--block-background-fill);
+	}
+
+	tbody > tr:nth-child(odd) {
+		background: var(--table-odd-background-fill);
+	}
+
+	.drag-handle {
+		cursor: grab;
+		color: var(--body-text-color-subdued);
+		padding-right: var(--size-2);
+		user-select: none;
+	}
+
+	.dragging {
+		opacity: 0.5;
+		cursor: grabbing;
+	}
+
+	.drop-target {
+		border-top: 2px solid var(--color-accent);
+	}
+
+	tr:last-child.drop-target[data-drop-target="before"] {
+		border-top: 2px solid var(--color-accent);
+		border-bottom: none;
+	}
+
+	tr:last-child.drop-target[data-drop-target="after"] {
+		border-top: none;
+		border-bottom: 2px solid var(--color-accent);
+	}
+</style>

6.4.1/file/shared/FileUpload.svelte

@@ -0,0 +1,148 @@
+<script lang="ts">
+	import { tick } from "svelte";
+	import { Upload, ModifyUpload } from "@gradio/upload";
+	import type { FileData, Client } from "@gradio/client";
+	import { BlockLabel, IconButtonWrapper, IconButton } from "@gradio/atoms";
+	import { File, Clear, Upload as UploadIcon } from "@gradio/icons";
+
+	import FilePreview from "./FilePreview.svelte";
+	import type { I18nFormatter, SelectData } from "@gradio/utils";
+	import type { CustomButton as CustomButtonType } from "@gradio/utils";
+
+	let {
+		value = $bindable<null | FileData | FileData[]>(),
+		label,
+		show_label = true,
+		file_count = "single",
+		file_types = null,
+		selectable = false,
+		root,
+		height = undefined,
+		i18n,
+		max_file_size = null,
+		upload,
+		stream_handler,
+		uploading = $bindable(false),
+		allow_reordering = false,
+		upload_promise = $bindable<Promise<(FileData | null)[]> | null>(),
+		buttons = null,
+		on_custom_button_click = null,
+		onchange,
+		onclear,
+		ondrag,
+		onupload,
+		onerror,
+		ondelete,
+		onselect
+	}: {
+		value: null | FileData | FileData[];
+		label: string;
+		show_label?: boolean;
+		file_count: "single" | "multiple" | "directory";
+		file_types: string[] | null;
+		selectable?: boolean;
+		root: string;
+		height?: number | undefined;
+		i18n: I18nFormatter;
+		max_file_size: number | null;
+		upload: Client["upload"];
+		stream_handler: Client["stream"];
+		uploading?: boolean;
+		allow_reordering?: boolean;
+		upload_promise?: Promise<(FileData | null)[]> | null;
+		buttons?: (string | CustomButtonType)[] | null;
+		on_custom_button_click?: ((id: number) => void) | null;
+		onchange?: (event_data: FileData[] | FileData | null) => void;
+		onclear?: () => void;
+		ondrag?: (dragging: boolean) => void;
+		onupload?: (event_data: FileData[] | FileData) => void;
+		onerror?: (error: string) => void;
+		ondelete?: (event_data: FileData) => void;
+		onselect?: (event_data: SelectData) => void;
+	} = $props();
+
+	async function handle_upload(detail: FileData | FileData[]): Promise<void> {
+		if (Array.isArray(value)) {
+			value = [...value, ...(Array.isArray(detail) ? detail : [detail])];
+		} else if (value) {
+			value = [value, ...(Array.isArray(detail) ? detail : [detail])];
+		} else {
+			value = detail;
+		}
+		await tick();
+		onchange?.(value);
+		onupload?.(value);
+	}
+
+	function handle_clear(): void {
+		value = null;
+		onchange?.(null);
+		onclear?.();
+	}
+
+	let dragging = $state(false);
+</script>
+
+{#if show_label && buttons && buttons.length > 0}
+	<IconButtonWrapper {buttons} {on_custom_button_click} />
+{/if}
+<BlockLabel {show_label} Icon={File} float={!value} label={label || "File"} />
+
+{#if value && (Array.isArray(value) ? value.length > 0 : true)}
+	<IconButtonWrapper buttons={buttons || []} {on_custom_button_click}>
+		{#if !(file_count === "single" && (Array.isArray(value) ? value.length > 0 : value !== null))}
+			<IconButton Icon={UploadIcon} label={i18n("common.upload")}>
+				<Upload
+					bind:upload_promise
+					icon_upload={true}
+					onload={handle_upload}
+					filetype={file_types}
+					{file_count}
+					{max_file_size}
+					{root}
+					bind:dragging
+					bind:uploading
+					{onerror}
+					{stream_handler}
+					{upload}
+				/>
+			</IconButton>
+		{/if}
+		<IconButton
+			Icon={Clear}
+			label={i18n("common.clear")}
+			onclick={(event) => {
+				event.stopPropagation();
+				handle_clear();
+			}}
+		/>
+	</IconButtonWrapper>
+
+	<FilePreview
+		{i18n}
+		{onselect}
+		{selectable}
+		{value}
+		{height}
+		{onchange}
+		{ondelete}
+		{allow_reordering}
+	/>
+{:else}
+	<Upload
+		bind:upload_promise
+		onload={handle_upload}
+		filetype={file_types}
+		{file_count}
+		{max_file_size}
+		{root}
+		bind:dragging
+		bind:uploading
+		{onerror}
+		{stream_handler}
+		{upload}
+		{height}
+	>
+		<slot />
+	</Upload>
+{/if}

6.4.1/file/shared/utils.ts

@@ -0,0 +1,12 @@
+import type { FileData } from "@gradio/client";
+
+export const prettyBytes = (bytes: number): string => {
+	let units = ["B", "KB", "MB", "GB", "PB"];
+	let i = 0;
+	while (bytes > 1024) {
+		bytes /= 1024;
+		i++;
+	}
+	let unit = units[i];
+	return bytes.toFixed(1) + " " + unit;
+};

6.4.1/file/types.ts

@@ -0,0 +1,26 @@
+import type { FileData } from "@gradio/client";
+import type { LoadingStatus } from "js/statustracker";
+import type { SelectData, CustomButton } from "@gradio/utils";
+
+export interface FileProps {
+	value: FileData | FileData[] | null;
+	file_types: string[];
+	file_count: "single" | "multiple" | "directory";
+	allow_reordering: boolean;
+	type: "filepath" | "binary";
+	_selectable: boolean;
+	height: number | null;
+	buttons: (string | CustomButton)[] | null;
+}
+
+export interface FileEvents {
+	upload: FileData | FileData[];
+	download: void;
+	error: string;
+	clear_status: LoadingStatus;
+	clear: void;
+	select: SelectData | null;
+	change: FileData | FileData[] | null;
+	delete: FileData;
+	custom_button_click: { id: number };
+}