@gradio/imageeditor 0.19.0 → 0.20.1

package/dist/shared/ImageEditor.svelte

@@ -6,7 +6,7 @@
 </script>
 
 <script lang="ts">
-	import { onMount, createEventDispatcher, tick } from "svelte";
+	import { onMount, tick, type Snippet } from "svelte";
 	import { get } from "svelte/store";
 	import Toolbar, { type Tool as ToolbarTool } from "./Toolbar.svelte";
 	import { CropTool } from "./crop/crop";
@@ -30,49 +30,92 @@
 	import IconButton from "./IconButton.svelte";
 
 	const { drag, open_file_upload } = create_drag();
-	const dispatch = createEventDispatcher<{
-		clear?: never;
-		save: void;
-		change: void;
-		upload: void;
-		input: void;
-		download_error: string;
-	}>();
 
 	export const antialias = true;
 
-	export let changeable = false;
-	export let sources: Source[] = ["upload", "webcam", "clipboard"];
-	export let transforms: Transform[] = ["crop", "resize"];
-	export let canvas_size: [number, number];
-	export let is_dragging = false;
-	export let background_image = false;
-	export let brush_options: Brush | false;
-	export let eraser_options: Eraser | false;
-	export let fixed_canvas = false;
-	export let root: string;
-	export let i18n: I18nFormatter;
-	export let upload: Client["upload"];
-	export let composite: FileData | null;
-	export let layers: FileData[];
-	export let background: FileData | null;
-	export let border_region = 0;
-	export let layer_options: LayerOptions;
-	export let current_tool: ToolbarTool;
-	export let webcam_options: WebcamOptions;
-	export let show_download_button = false;
-	export let theme_mode: "dark" | "light";
-	export let full_history: CommandNode | null = null;
+	let {
+		changeable = false,
+		sources = ["upload", "webcam", "clipboard"],
+		transforms = ["crop", "resize"],
+		canvas_size,
+		is_dragging = $bindable(false),
+		background_image = $bindable(false),
+		brush_options,
+		eraser_options,
+		fixed_canvas = false,
+		root,
+		i18n,
+		upload,
+		composite,
+		layers,
+		background,
+		border_region = 0,
+		layer_options,
+		current_tool = $bindable(),
+		webcam_options,
+		show_download_button = false,
+		theme_mode,
+		full_history = $bindable(null),
+		has_drawn = $bindable(false),
+		can_undo = $bindable(false),
+		onclear,
+		onsave,
+		onchange,
+		onupload,
+		oninput,
+		ondownload_error,
+		children
+	}: {
+		changeable?: boolean;
+		sources?: Source[];
+		transforms?: Transform[];
+		canvas_size: [number, number];
+		is_dragging?: boolean;
+		background_image?: boolean;
+		brush_options: Brush | false;
+		eraser_options: Eraser | false;
+		fixed_canvas?: boolean;
+		root: string;
+		i18n: I18nFormatter;
+		upload: Client["upload"];
+		composite: FileData | null;
+		layers: FileData[];
+		background: FileData | null;
+		border_region?: number;
+		layer_options: LayerOptions;
+		current_tool: ToolbarTool;
+		webcam_options: WebcamOptions;
+		show_download_button?: boolean;
+		theme_mode: "dark" | "light";
+		full_history?: CommandNode | null;
+		has_drawn?: boolean;
+		can_undo?: boolean;
+		onclear?: () => void;
+		onsave?: () => void;
+		onchange?: () => void;
+		onupload?: () => void;
+		oninput?: () => void;
+		ondownload_error?: (error: string) => void;
+		children?: Snippet;
+	} = $props();
 
 	let pixi_target: HTMLDivElement;
 	let pixi_target_crop: HTMLDivElement;
 
-	$: if (layer_options) {
-		if (check_if_should_init()) {
-			editor.set_layer_options(layer_options);
-			refresh_tools();
-		}
-	}
+	let layer_options_key: string | undefined | null = null;
+	$effect(() => {
+		if (!check_if_should_init()) return;
+
+		const next_layer_options_key = JSON.stringify(layer_options);
+		if (next_layer_options_key === layer_options_key) return;
+
+		layer_options_key = next_layer_options_key;
+		editor.set_layer_options(layer_options);
+	});
+
+	$effect(() => {
+		refresh_tools();
+	});
 
 	function refresh_tools(): void {
 		if (!editor || !ready) return;
@@ -80,13 +123,14 @@
 		editor.set_subtool(current_subtool);
 	}
 
-	$: if (editor && ready && editor.layers) {
+	$effect(() => {
+		if (!(editor && ready && editor.layers)) return;
 		const current_layers = get(editor.layers);
 
 		if (current_layers.layers.length > 0 && !current_layers.active_layer) {
 			refresh_tools_for_layer_changes(current_layers);
 		}
-	}
+	});
 
 	/**
 	 * Refreshes tools when layer state changes
@@ -115,8 +159,6 @@
 		return layer_options && editor && ready;
 	}
 
-	export let has_drawn = false;
-
 	/**
 	 * Gets the image blobs from the editor
 	 * @returns {Promise<ImageBlobs>} Object containing background, layers, and composite image blobs
@@ -176,8 +218,8 @@
 			crop.set_subtool("crop");
 			background_image = true;
 			zoom.set_zoom("fit");
-			dispatch("upload");
-			dispatch("input");
+			onupload?.();
+			oninput?.();
 		} catch (error) {
 			console.error("Error adding image from URL:", error);
 		}
@@ -200,8 +242,8 @@
 			try {
 				await pending_bg;
 				await editor.add_layers_from_url(source.map((item) => item.url));
-				dispatch("change");
-				dispatch("input");
+				onchange?.();
+				oninput?.();
 			} catch (error) {
 				console.error("Error adding layer from URL:", error);
 			}
@@ -210,10 +252,10 @@
 
 	let brush: BrushTool;
 	let zoom: ZoomTool;
-	let zoom_level = 1;
-	let ready = false;
-	let mounted = false;
-	let min_zoom = true;
+	let zoom_level = $state(1);
+	let ready = $state(false);
+	let mounted = $state(false);
+	let min_zoom = $state(true);
 
 	let last_dimensions = { width: 0, height: 0 };
 
@@ -221,9 +263,11 @@
 	 * Handles visibility changes and resets zoom if dimensions have changed
 	 */
 	async function handle_visibility_change(): Promise<void> {
-		if (!editor || !ready || !zoom) return;
+		if (!editor || !ready || !zoom || !pixi_target) return;
 		await tick();
 
+		if (!pixi_target) return;
+
 		const is_visible = pixi_target.offsetParent !== null;
 
 		if (is_visible) {
@@ -316,8 +360,7 @@
 
 	let crop: ImageEditor;
 	let crop_zoom: ZoomTool;
-	export let can_undo = false;
-	let can_redo = false;
+	let can_redo = $state(false);
 	async function init_image_editor(): Promise<void> {
 		brush = new BrushTool();
 		zoom = new ZoomTool();
@@ -382,8 +425,8 @@
 		});
 
 		editor.on("change", () => {
-			dispatch("change");
-			dispatch("input");
+			onchange?.();
+			oninput?.();
 			full_history = editor.command_manager.history;
 		});
 
@@ -403,23 +446,27 @@
 		refresh_tools();
 	}
 
-	$: if (
-		background == null &&
-		layers.length == 0 &&
-		composite == null &&
-		editor &&
-		ready
-	) {
-		editor.reset_canvas();
-		zoom.set_zoom("fit");
-		handle_tool_change({ tool: "image" });
-		background_image = false;
-		has_drawn = false;
-	}
+	$effect(() => {
+		if (
+			background == null &&
+			layers.length == 0 &&
+			composite == null &&
+			editor &&
+			ready
+		) {
+			editor.reset_canvas();
+			zoom.set_zoom("fit");
+			handle_tool_change({ tool: "image" });
+			background_image = false;
+			has_drawn = false;
+		}
+	});
 
-	$: current_tool === "image" &&
-		current_subtool === "crop" &&
-		crop_zoom.set_zoom("fit");
+	$effect(() => {
+		if (current_tool === "image" && current_subtool === "crop") {
+			crop_zoom.set_zoom("fit");
+		}
+	});
 
 	/**
 	 * Handles file uploads
@@ -439,10 +486,15 @@
 		background_image = true;
 		zoom.set_zoom("fit");
 		handle_tool_change({ tool: "draw" });
-		dispatch("upload");
+		onupload?.();
 	}
 
-	$: background_image = can_undo && editor.command_manager.contains("AddImage");
+	$effect(() => {
+		if (editor) {
+			background_image =
+				can_undo && editor.command_manager.contains("AddImage");
+		}
+	});
 
 	/**
 	 * Handles tool change events
@@ -500,13 +552,13 @@
 		}
 	}
 
-	let eraser_size_visible = false;
-	let selected_color: ColorInput | string;
-	let selected_size: number;
-	let selected_opacity = 1;
-	let selected_eraser_size: number;
+	let eraser_size_visible = $state(false);
+	let selected_color = $state<ColorInput | string>();
+	let selected_size = $state<number>();
+	let selected_opacity = $state(1);
+	let selected_eraser_size = $state<number>();
 
-	$: {
+	$effect(() => {
 		if (brush_options) {
 			update_brush_options();
 		}
@@ -514,7 +566,7 @@
 		if (eraser_options) {
 			update_eraser_options();
 		}
-	}
+	});
 
 	function update_brush_options(): void {
 		if (!brush_options) return;
@@ -551,51 +603,76 @@
 			options.default_size === "auto" ? 25 : options.default_size;
 	}
 
-	let brush_size_visible = false;
-
-	let brush_color_visible = false;
+	let brush_size_visible = $state(false);
+
+	let brush_color_visible = $state(false);
+
+	$effect(() => {
+		if (!brush) return;
+		brush.set_brush_color(
+			(() => {
+				let color_value: ColorInput = "black";
+				if (selected_color === "auto") {
+					if (!brush_options) return "black";
+					const default_color =
+						brush_options.colors.find((color) =>
+							Array.isArray(color)
+								? color[0] === brush_options.default_color
+								: color === brush_options.default_color
+						) || brush_options.colors[0];
+
+					color_value = Array.isArray(default_color)
+						? default_color[0]
+						: default_color;
+				} else {
+					color_value = selected_color ?? "black";
+				}
+				return color_value;
+			})()
+		);
+	});
 
-	$: brush?.set_brush_color(
-		(() => {
-			let color_value;
-			if (selected_color === "auto") {
-				if (!brush_options) return "black";
-				const options = brush_options;
-				const default_color =
-					options.colors.find((color) =>
-						Array.isArray(color)
-							? color[0] === options.default_color
-							: color === options.default_color
-					) || options.colors[0];
+	$effect(() => {
+		brush?.set_brush_size(
+			typeof selected_size === "number" ? selected_size : 25
+		);
+	});
 
-				color_value = Array.isArray(default_color)
-					? default_color[0]
-					: default_color;
-			} else {
-				color_value = selected_color;
-			}
-			return color_value;
-		})()
-	);
+	$effect(() => {
+		brush?.set_eraser_size(
+			typeof selected_eraser_size === "number" ? selected_eraser_size : 25
+		);
+	});
 
-	$: brush?.set_brush_size(
-		typeof selected_size === "number" ? selected_size : 25
-	);
+	let disable_click = $state(true);
+	$effect(() => {
+		disable_click =
+			current_tool !== "image" ||
+			(current_tool === "image" && background_image) ||
+			(current_tool === "image" && current_subtool === "webcam") ||
+			!sources.includes("upload");
+	});
 
-	$: brush?.set_eraser_size(
-		typeof selected_eraser_size === "number" ? selected_eraser_size : 25
-	);
+	let current_subtool = $state<Subtool | null>(null);
+	let preview = $state(false);
+	$effect(() => {
+		brush?.preview_brush(preview);
+	});
+	$effect(() => {
+		brush?.set_brush_opacity(selected_opacity);
+	});
 
-	$: disable_click =
-		current_tool !== "image" ||
-		(current_tool === "image" && background_image) ||
-		(current_tool === "image" && current_subtool === "webcam") ||
-		!sources.includes("upload");
+	function remove_image(): void {
+		onclear?.();
+		editor.reset_canvas();
+		handle_tool_change({ tool: "image" });
+		background_image = false;
+		has_drawn = false;
+	}
 
-	let current_subtool: Subtool | null = null;
-	let preview = false;
-	$: brush?.preview_brush(preview);
-	$: brush?.set_brush_opacity(selected_opacity);
+	export function handle_remove(): void {
+		remove_image();
+	}
 
 	function handle_zoom_change(zoom_level: number | "fit"): void {
 		zoom.set_zoom(zoom_level);
@@ -622,19 +699,23 @@
 		}
 	}
 
-	function handle_capture(e: CustomEvent): void {
-		if (e.detail !== null) {
-			handle_files(e.detail as Blob);
+	function handle_capture(value: FileData | Blob | null): void {
+		if (value !== null) {
+			handle_files(value as Blob);
 		}
 		handle_subtool_change({ tool: current_tool, subtool: null });
 	}
 
 	function handle_save(): void {
-		dispatch("save");
+		onsave?.();
 	}
 
-	$: add_image_from_url(composite || background);
-	$: add_layers_from_url(layers);
+	$effect(() => {
+		add_image_from_url(composite || background);
+	});
+	$effect(() => {
+		add_layers_from_url(layers);
+	});
 
 	async function handle_crop_confirm(): Promise<void> {
 		const { image } = await crop.get_crop_bounds();
@@ -645,8 +726,8 @@
 			resize: false
 		});
 		handle_subtool_change({ tool: "image", subtool: null });
-		dispatch("change");
-		dispatch("input");
+		onchange?.();
+		oninput?.();
 	}
 
 	async function handle_download(): Promise<void> {
@@ -654,7 +735,7 @@
 
 		const blob = blobs.composite;
 		if (!blob) {
-			dispatch("download_error", "Unable to generate image to download.");
+			ondownload_error?.("Unable to generate image to download.");
 			return;
 		}
 		const url = URL.createObjectURL(blob);
@@ -675,12 +756,13 @@
 
 	let old_background = background;
 
-	$: if (old_background !== background) {
+	$effect(() => {
+		if (old_background === background) return;
 		handle_tool_change({ tool: "draw" });
 		handle_subtool_change({ tool: "draw", subtool: null });
 		current_tool = "draw";
 		old_background = background;
-	}
+	});
 </script>
 
 <div
@@ -691,7 +773,8 @@
 		on_drag_change: (dragging) => (is_dragging = dragging),
 		on_files: handle_files,
 		accepted_types: "image/*",
-		disable_click: disable_click
+		disable_click: disable_click,
+		ignore_click_selector: ".toolbar-wrap"
 	}}
 	aria-label={"Click to upload or drop files"}
 	aria-dropeffect="copy"
@@ -700,30 +783,24 @@
 		{#if current_subtool !== "crop"}
 			<Controls
 				{changeable}
-				on:set_zoom={(e) => handle_zoom_change(e.detail)}
-				on:zoom_in={() => zoom_in_out("in")}
-				on:zoom_out={() => zoom_in_out("out")}
+				onset_zoom={(zoom) => handle_zoom_change(zoom)}
+				onzoom_in={() => zoom_in_out("in")}
+				onzoom_out={() => zoom_in_out("out")}
 				{min_zoom}
 				current_zoom={zoom_level}
-				on:remove_image={() => {
-					dispatch("clear");
-					editor.reset_canvas();
-					handle_tool_change({ tool: "image" });
-					background_image = false;
-					has_drawn = false;
-				}}
+				onremove_image={remove_image}
 				tool={current_tool}
 				can_save={true}
-				on:save={handle_save}
-				on:pan={(e) => {
+				onsave={handle_save}
+				onpan={() => {
 					handle_tool_change({ tool: "pan" });
 				}}
 				enable_download={show_download_button}
-				on:download={() => handle_download()}
+				ondownload={() => handle_download()}
 				{can_undo}
 				{can_redo}
-				on:undo={handle_undo}
-				on:redo={handle_redo}
+				onundo={handle_undo}
+				onredo={handle_redo}
 			/>
 		{/if}
 
@@ -732,8 +809,8 @@
 				{sources}
 				{transforms}
 				background={background_image}
-				on:tool_change={(e) => handle_tool_change(e.detail)}
-				on:subtool_change={(e) => handle_subtool_change(e.detail)}
+				ontool_change={(detail) => handle_tool_change(detail)}
+				onsubtool_change={(detail) => handle_subtool_change(detail)}
 				show_brush_size={brush_size_visible}
 				show_brush_color={brush_color_visible}
 				show_eraser_size={eraser_size_visible}
@@ -755,9 +832,7 @@
 					<Webcam
 						{upload}
 						{root}
-						on:capture={handle_capture}
-						on:error
-						on:drag
+						oncapture={handle_capture}
 						streaming={false}
 						mode="image"
 						include_audio={false}
@@ -773,23 +848,23 @@
 			<SecondaryToolbar
 				enable_additional_layers={layer_options.allow_additional_layers}
 				layers={editor.layers}
-				on:new_layer={() => {
+				onnew_layer={() => {
 					editor.add_layer();
 				}}
-				on:change_layer={(e) => {
-					editor.set_layer(e.detail);
+				onchange_layer={(id) => {
+					editor.set_layer(id);
 					if (current_tool === "draw") {
 						handle_tool_change({ tool: "draw" });
 					}
 				}}
-				on:move_layer={(e) => {
-					editor.move_layer(e.detail.id, e.detail.direction);
+				onmove_layer={({ id, direction }) => {
+					editor.move_layer(id, direction);
 				}}
-				on:delete_layer={(e) => {
-					editor.delete_layer(e.detail);
+				ondelete_layer={(id) => {
+					editor.delete_layer(id);
 				}}
-				on:toggle_layer_visibility={(e) => {
-					editor.toggle_layer_visibility(e.detail);
+				ontoggle_layer_visibility={(id) => {
+					editor.toggle_layer_visibility(id);
 				}}
 			/>
 		{/if}
@@ -820,7 +895,7 @@
 			/>
 		</div>
 	{/if}
-	<slot></slot>
+	{#if children}{@render children()}{/if}
 </div>
 
 <style>

package/dist/shared/ImageEditor.svelte.d.ts

@@ -1,6 +1,59 @@
 export declare const EDITOR_KEY: unique symbol;
 export type context_type = "bg" | "layers" | "crop" | "draw" | "erase";
+import { type Snippet } from "svelte";
+import { type Tool as ToolbarTool } from "./Toolbar.svelte";
+import type { I18nFormatter } from "@gradio/utils";
+import type { Client, FileData } from "@gradio/client";
+import { type CommandNode } from "./core/commands";
 import { ImageEditor } from "./core/editor";
-declare const ImageEditor: any;
-type ImageEditor = InstanceType<typeof ImageEditor>;
+import { type Brush, type Eraser } from "./brush/types";
+import type { LayerOptions, Source, Transform, WebcamOptions } from "./types";
+import { type ImageBlobs } from "./types";
+type $$ComponentProps = {
+    changeable?: boolean;
+    sources?: Source[];
+    transforms?: Transform[];
+    canvas_size: [number, number];
+    is_dragging?: boolean;
+    background_image?: boolean;
+    brush_options: Brush | false;
+    eraser_options: Eraser | false;
+    fixed_canvas?: boolean;
+    root: string;
+    i18n: I18nFormatter;
+    upload: Client["upload"];
+    composite: FileData | null;
+    layers: FileData[];
+    background: FileData | null;
+    border_region?: number;
+    layer_options: LayerOptions;
+    current_tool: ToolbarTool;
+    webcam_options: WebcamOptions;
+    show_download_button?: boolean;
+    theme_mode: "dark" | "light";
+    full_history?: CommandNode | null;
+    has_drawn?: boolean;
+    can_undo?: boolean;
+    onclear?: () => void;
+    onsave?: () => void;
+    onchange?: () => void;
+    onupload?: () => void;
+    oninput?: () => void;
+    ondownload_error?: (error: string) => void;
+    children?: Snippet;
+};
+declare const ImageEditor: import("svelte").Component<$$ComponentProps, {
+    antialias: true;
+    get_blobs: () => Promise<ImageBlobs>;
+    add_image: (image: Blob | File) => void;
+    add_image_from_url: (source: string | {
+        url: string;
+        meta: {
+            _type: string;
+        };
+    } | any) => Promise<void>;
+    add_layers_from_url: (source: FileData[] | any) => Promise<void>;
+    handle_remove: () => void;
+}, "current_tool" | "can_undo" | "is_dragging" | "background_image" | "full_history" | "has_drawn">;
+type ImageEditor = ReturnType<typeof ImageEditor>;
 export default ImageEditor;