@gradio/imageeditor 0.12.14 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/CHANGELOG.md +36 -0
  2. package/Example.svelte +1 -1
  3. package/IMAGE_EDITOR_OVERVIEW.md +224 -0
  4. package/ImageEditor.stories.svelte +13 -5
  5. package/Index.svelte +46 -45
  6. package/{shared/InteractiveImageEditor.svelte → InteractiveImageEditor.svelte} +65 -103
  7. package/README.md +2 -0
  8. package/dist/Example.svelte.d.ts +1 -1
  9. package/dist/Index.svelte +35 -33
  10. package/dist/Index.svelte.d.ts +25 -16
  11. package/dist/{shared/InteractiveImageEditor.svelte → InteractiveImageEditor.svelte} +54 -88
  12. package/dist/{shared/InteractiveImageEditor.svelte.d.ts → InteractiveImageEditor.svelte.d.ts} +17 -15
  13. package/dist/shared/Anchor.svelte +311 -0
  14. package/dist/shared/Anchor.svelte.d.ts +18 -0
  15. package/dist/shared/Controls.svelte +169 -18
  16. package/dist/shared/Controls.svelte.d.ts +9 -2
  17. package/dist/shared/{tools/IconButton.svelte → IconButton.svelte} +19 -3
  18. package/dist/shared/{tools/IconButton.svelte.d.ts → IconButton.svelte.d.ts} +4 -1
  19. package/dist/shared/ImageEditor.svelte +572 -289
  20. package/dist/shared/ImageEditor.svelte.d.ts +54 -56
  21. package/dist/shared/Layers.svelte +260 -0
  22. package/dist/shared/Layers.svelte.d.ts +37 -0
  23. package/dist/shared/Resize.svelte +218 -0
  24. package/dist/shared/Resize.svelte.d.ts +29 -0
  25. package/dist/shared/SecondaryToolbar.svelte +55 -0
  26. package/dist/shared/SecondaryToolbar.svelte.d.ts +37 -0
  27. package/dist/shared/Toolbar.svelte +337 -0
  28. package/dist/shared/Toolbar.svelte.d.ts +42 -0
  29. package/dist/shared/{tools → brush}/BrushOptions.svelte +68 -64
  30. package/dist/shared/{tools → brush}/BrushOptions.svelte.d.ts +9 -9
  31. package/dist/shared/{tools → brush}/BrushSize.svelte +2 -27
  32. package/dist/shared/{tools → brush}/ColorField.svelte +2 -1
  33. package/dist/shared/{tools → brush}/ColorField.svelte.d.ts +1 -0
  34. package/dist/shared/{tools → brush}/ColorPicker.svelte +81 -9
  35. package/dist/shared/{tools → brush}/ColorPicker.svelte.d.ts +1 -0
  36. package/dist/shared/{tools → brush}/ColorSwatch.svelte +78 -38
  37. package/dist/shared/{tools → brush}/ColorSwatch.svelte.d.ts +6 -2
  38. package/dist/shared/brush/brush-cursor.d.ts +101 -0
  39. package/dist/shared/brush/brush-cursor.js +327 -0
  40. package/dist/shared/brush/brush-textures.d.ts +65 -0
  41. package/dist/shared/brush/brush-textures.js +385 -0
  42. package/dist/shared/brush/brush-utils.d.ts +32 -0
  43. package/dist/shared/brush/brush-utils.js +59 -0
  44. package/dist/shared/brush/brush.d.ts +152 -0
  45. package/dist/shared/brush/brush.js +397 -0
  46. package/dist/shared/brush/types.d.ts +37 -0
  47. package/dist/shared/brush/types.js +1 -0
  48. package/dist/shared/core/editor.d.ts +261 -0
  49. package/dist/shared/core/editor.js +1264 -0
  50. package/dist/shared/crop/crop.d.ts +201 -0
  51. package/dist/shared/crop/crop.js +727 -0
  52. package/dist/shared/image/image.d.ts +89 -0
  53. package/dist/shared/image/image.js +183 -0
  54. package/dist/shared/resize/resize.d.ts +270 -0
  55. package/dist/shared/resize/resize.js +1413 -0
  56. package/dist/shared/types.d.ts +16 -0
  57. package/dist/shared/utils/pixi.d.ts +16 -57
  58. package/dist/shared/utils/pixi.js +15 -113
  59. package/dist/shared/zoom/zoom.d.ts +136 -0
  60. package/dist/shared/zoom/zoom.js +548 -0
  61. package/package.json +8 -7
  62. package/shared/Anchor.svelte +384 -0
  63. package/shared/Controls.svelte +178 -37
  64. package/shared/{tools/IconButton.svelte → IconButton.svelte} +21 -4
  65. package/shared/ImageEditor.svelte +712 -350
  66. package/shared/Layers.svelte +282 -0
  67. package/shared/Resize.svelte +239 -0
  68. package/shared/SecondaryToolbar.svelte +67 -0
  69. package/shared/Toolbar.svelte +386 -0
  70. package/shared/brush/BRUSH_TOOL.md +134 -0
  71. package/shared/brush/BrushOptions.svelte +200 -0
  72. package/shared/{tools → brush}/BrushSize.svelte +2 -30
  73. package/shared/{tools → brush}/ColorField.svelte +3 -1
  74. package/shared/{tools → brush}/ColorPicker.svelte +86 -9
  75. package/shared/{tools → brush}/ColorSwatch.svelte +95 -42
  76. package/shared/brush/brush-cursor.ts +408 -0
  77. package/shared/brush/brush-textures.ts +485 -0
  78. package/shared/brush/brush-utils.ts +76 -0
  79. package/shared/brush/brush.ts +510 -0
  80. package/shared/brush/types.ts +41 -0
  81. package/shared/core/EDITOR.md +182 -0
  82. package/shared/core/editor.ts +1788 -0
  83. package/shared/crop/CROP.md +139 -0
  84. package/shared/crop/crop.ts +1027 -0
  85. package/shared/image/IMAGE.md +135 -0
  86. package/shared/image/image.ts +298 -0
  87. package/shared/resize/resize.ts +1894 -0
  88. package/shared/types.ts +19 -0
  89. package/shared/utils/pixi.ts +19 -246
  90. package/shared/zoom/zoom.ts +729 -0
  91. package/dist/shared/layers/Layers.svelte +0 -231
  92. package/dist/shared/layers/Layers.svelte.d.ts +0 -18
  93. package/dist/shared/layers/utils.d.ts +0 -73
  94. package/dist/shared/layers/utils.js +0 -156
  95. package/dist/shared/tools/Brush.svelte +0 -215
  96. package/dist/shared/tools/Brush.svelte.d.ts +0 -29
  97. package/dist/shared/tools/Crop.svelte +0 -155
  98. package/dist/shared/tools/Crop.svelte.d.ts +0 -16
  99. package/dist/shared/tools/Cropper.svelte +0 -271
  100. package/dist/shared/tools/Cropper.svelte.d.ts +0 -41
  101. package/dist/shared/tools/Handle.svelte +0 -260
  102. package/dist/shared/tools/Handle.svelte.d.ts +0 -29
  103. package/dist/shared/tools/Sources.svelte +0 -257
  104. package/dist/shared/tools/Sources.svelte.d.ts +0 -34
  105. package/dist/shared/tools/Tools.svelte +0 -102
  106. package/dist/shared/tools/Tools.svelte.d.ts +0 -48
  107. package/dist/shared/tools/brush.d.ts +0 -62
  108. package/dist/shared/tools/brush.js +0 -133
  109. package/dist/shared/tools/crop.d.ts +0 -15
  110. package/dist/shared/tools/crop.js +0 -154
  111. package/dist/shared/tools/index.d.ts +0 -5
  112. package/dist/shared/tools/index.js +0 -5
  113. package/dist/shared/tools/sources.d.ts +0 -46
  114. package/dist/shared/tools/sources.js +0 -121
  115. package/dist/shared/tools/types.d.ts +0 -1
  116. package/shared/layers/Layers.svelte +0 -250
  117. package/shared/layers/utils.ts +0 -294
  118. package/shared/tools/Brush.svelte +0 -280
  119. package/shared/tools/BrushOptions.svelte +0 -180
  120. package/shared/tools/Crop.svelte +0 -189
  121. package/shared/tools/Cropper.svelte +0 -346
  122. package/shared/tools/Handle.svelte +0 -289
  123. package/shared/tools/Sources.svelte +0 -283
  124. package/shared/tools/Tools.svelte +0 -162
  125. package/shared/tools/brush.ts +0 -247
  126. package/shared/tools/crop.ts +0 -213
  127. package/shared/tools/index.ts +0 -5
  128. package/shared/tools/sources.ts +0 -195
  129. package/shared/tools/types.ts +0 -1
  130. /package/dist/shared/{tools → brush}/BrushSize.svelte.d.ts +0 -0
  131. /package/dist/shared/{tools/types.js → types.js} +0 -0
@@ -1,250 +0,0 @@
1
- <script lang="ts">
2
- import { getContext, onMount, tick } from "svelte";
3
-
4
- import { click_outside } from "../utils/events";
5
- import { layer_manager, type LayerScene } from "./utils";
6
- import { EDITOR_KEY, type EditorContext } from "../ImageEditor.svelte";
7
- import type { FileData } from "@gradio/client";
8
- import { Layers } from "@gradio/icons";
9
-
10
- let show_layers = false;
11
-
12
- export let layer_files: (FileData | null)[] | null = [];
13
- export let enable_layers = true;
14
-
15
- const {
16
- pixi,
17
- current_layer,
18
- dimensions,
19
- register_context,
20
- command_manager,
21
- current_history
22
- } = getContext<EditorContext>(EDITOR_KEY);
23
-
24
- const { can_undo } = command_manager;
25
-
26
- const LayerManager = layer_manager();
27
- const manager_current_layer = LayerManager.active_layer;
28
- const layers = LayerManager.layers;
29
-
30
- $: current_layer.set($manager_current_layer);
31
-
32
- register_context("layers", {
33
- init_fn: () => {
34
- new_layer();
35
- },
36
- reset_fn: () => {
37
- LayerManager.reset();
38
- }
39
- });
40
-
41
- async function validate_layers(): Promise<void> {
42
- let invalid = $layers.some(
43
- (layer) =>
44
- layer.composite.texture?.width != $dimensions[0] ||
45
- layer.composite.texture?.height != $dimensions[1]
46
- );
47
- if (invalid) {
48
- LayerManager.reset();
49
- if (!layer_files || layer_files.length == 0) new_layer();
50
- else render_layer_files(layer_files);
51
- }
52
- }
53
- $: $dimensions, validate_layers();
54
-
55
- async function new_layer(): Promise<void> {
56
- if (!$pixi) return;
57
-
58
- const new_layer = LayerManager.add_layer(
59
- $pixi.layer_container,
60
- $pixi.renderer,
61
- ...$dimensions
62
- );
63
-
64
- if ($can_undo || $layers.length > 0) {
65
- command_manager.execute(new_layer);
66
- } else {
67
- new_layer.execute();
68
- }
69
- }
70
-
71
- $: render_layer_files(layer_files);
72
-
73
- function is_not_null<T>(x: T | null): x is T {
74
- return x !== null;
75
- }
76
-
77
- async function render_layer_files(
78
- _layer_files: typeof layer_files
79
- ): Promise<void> {
80
- await tick();
81
- if (!_layer_files || _layer_files.length == 0) {
82
- LayerManager.reset();
83
- new_layer();
84
- return;
85
- }
86
- if (!$pixi) return;
87
-
88
- const fetch_promises = await Promise.all(
89
- _layer_files.map((f) => {
90
- if (!f || !f.url) return null;
91
-
92
- return fetch(f.url);
93
- })
94
- );
95
-
96
- const blobs = await Promise.all(
97
- fetch_promises.map((p) => {
98
- if (!p) return null;
99
- return p.blob();
100
- })
101
- );
102
-
103
- LayerManager.reset();
104
-
105
- for (const blob of blobs.filter(is_not_null)) {
106
- const new_layer = await LayerManager.add_layer_from_blob(
107
- $pixi.layer_container,
108
- $pixi.renderer,
109
- blob,
110
- $pixi.view
111
- );
112
-
113
- if ($can_undo && $layers.length === 0) {
114
- command_manager.execute(new_layer);
115
- } else {
116
- new_layer.execute();
117
- }
118
- }
119
- }
120
-
121
- onMount(async () => {
122
- await tick();
123
- if (!$pixi) return;
124
-
125
- $pixi = { ...$pixi!, get_layers: LayerManager.get_layers };
126
- });
127
- </script>
128
-
129
- {#if enable_layers}
130
- <div
131
- class="layer-wrap"
132
- class:closed={!show_layers}
133
- use:click_outside={() => (show_layers = false)}
134
- >
135
- <button
136
- aria-label="Show Layers"
137
- on:click={() => (show_layers = !show_layers)}
138
- ><span class="icon"><Layers /></span> Layer {$layers.findIndex(
139
- (l) => l === $current_layer
140
- ) + 1}
141
- </button>
142
- {#if show_layers}
143
- <ul>
144
- {#each $layers as layer, i (i)}
145
- <li>
146
- <button
147
- class:selected_layer={$current_layer === layer}
148
- aria-label={`layer-${i + 1}`}
149
- on:click={() =>
150
- ($current_layer = LayerManager.change_active_layer(i))}
151
- >Layer {i + 1}</button
152
- >
153
- </li>
154
- {/each}
155
- <li>
156
- <button aria-label="Add Layer" on:click={new_layer}> +</button>
157
- </li>
158
- </ul>
159
- {/if}
160
-
161
- <span class="sep"></span>
162
- </div>
163
- {/if}
164
-
165
- <style>
166
- .icon {
167
- width: 14px;
168
- margin-right: var(--spacing-md);
169
- color: var(--block-label-text-color);
170
- margin-right: var(--spacing-lg);
171
- margin-top: 1px;
172
- }
173
-
174
- .layer-wrap {
175
- position: relative;
176
- display: flex;
177
- justify-content: center;
178
- align-items: center;
179
- }
180
-
181
- .layer-wrap button {
182
- justify-content: flex-start;
183
- align-items: flex-start;
184
- width: 100%;
185
- border-bottom: 1px solid var(--block-border-color);
186
- display: flex;
187
- align-items: center;
188
- justify-content: center;
189
- font-size: var(--scale-000);
190
- line-height: var(--line-sm);
191
- padding-bottom: 1px;
192
- margin-left: var(--spacing-xl);
193
- padding: var(--spacing-sm) 0;
194
- }
195
-
196
- .layer-wrap li:last-child button {
197
- border-bottom: none;
198
- text-align: center;
199
- font-size: var(--scale-0);
200
- line-height: 1;
201
- font-weight: var(--weight-bold);
202
- padding: 5px 0 1px 0;
203
- }
204
-
205
- .closed > button {
206
- border-bottom: none;
207
- }
208
-
209
- .layer-wrap button:hover {
210
- background-color: none;
211
- }
212
-
213
- .layer-wrap button:hover .icon {
214
- color: var(--color-accent);
215
- }
216
-
217
- .selected_layer {
218
- background-color: var(--block-background-fill);
219
- color: var(--color-accent);
220
- font-weight: bold;
221
- }
222
-
223
- ul {
224
- position: absolute;
225
- bottom: 0;
226
- left: 0;
227
- background: var(--block-background-fill);
228
- width: calc(100% + 1px);
229
- list-style: none;
230
- z-index: var(--layer-top);
231
- border: 1px solid var(--block-border-color);
232
- padding: var(--spacing-sm) 0;
233
- text-wrap: none;
234
- transform: translate(-1px, 1px);
235
- border-radius: var(--radius-sm);
236
- border-bottom-right-radius: 0;
237
- }
238
-
239
- .layer-wrap ul > li > button {
240
- margin-left: 0;
241
- }
242
-
243
- .sep {
244
- height: 12px;
245
- background-color: var(--block-border-color);
246
- width: 1px;
247
- display: block;
248
- margin-left: var(--spacing-xl);
249
- }
250
- </style>
@@ -1,294 +0,0 @@
1
- import {
2
- Container,
3
- type IRenderer,
4
- type DisplayObject,
5
- RenderTexture,
6
- Texture,
7
- Sprite,
8
- Filter
9
- } from "pixi.js";
10
-
11
- import { type Command } from "../utils/commands";
12
- import { get, writable, type Writable } from "svelte/store";
13
-
14
- /**
15
- * GLSL Shader that takes two textures and erases the second texture from the first.
16
- */
17
- export const erase_shader = `
18
- precision highp float;
19
-
20
- uniform sampler2D uDrawingTexture;
21
- uniform sampler2D uEraserTexture;
22
-
23
- varying vec2 vTextureCoord;
24
-
25
- void main(void) {
26
- vec4 drawingColor = texture2D(uDrawingTexture,vTextureCoord);
27
- vec4 eraserColor = texture2D(uEraserTexture, vTextureCoord);
28
-
29
- // Use the alpha of the eraser to determine how much to "erase" from the drawing
30
- float alpha = 1.0 - eraserColor.a;
31
- gl_FragColor = vec4(drawingColor.rgb * alpha, drawingColor.a * alpha);
32
- }`;
33
-
34
- /**
35
- * Interface holding data for a layer
36
- */
37
- export interface LayerScene {
38
- /**
39
- * The texture used for tracking brush strokes.
40
- */
41
- draw_texture: RenderTexture;
42
- /**
43
- * The texture used for tracking eraser strokes.
44
- */
45
- erase_texture: RenderTexture;
46
- /**
47
- * The sprite used for displaying the composite of the draw and erase textures.
48
- */
49
- composite: Sprite;
50
- /**
51
- * The filter used for combining the draw and erase textures into a composite texture.
52
- */
53
- filter?: Filter;
54
- }
55
-
56
- /**
57
- * Interface for managing layers.
58
- */
59
- interface LayerManager {
60
- /**
61
- * Adds a layer to the container.
62
- * @param layer The container to add the layer to.
63
- * @param renderer The renderer to use for the layer.
64
- * @param width the width of the layer
65
- * @param height the height of the layer
66
- */
67
- add_layer(
68
- container: Container,
69
- renderer: IRenderer,
70
- width: number,
71
- height: number,
72
- sprite?: Sprite
73
- ): Command;
74
- /**
75
- * Swaps the layer with the layer above or below it.
76
- * @param layer The index layer to swap.
77
- * @param direction The direction to swap the layer.
78
- */
79
- swap_layers(layer: number, direction: "up" | "down"): LayerScene;
80
- /**
81
- * Changes the active layer.
82
- * @param layer The index of the layer to make active.
83
- */
84
- change_active_layer(layer: number): LayerScene;
85
- /**
86
- * Resizes the layers.
87
- * @param width The new width of the layers.
88
- * @param height The new height of the layers.
89
- */
90
- reset(): void;
91
- /**
92
- * Gets the layers.
93
- * @returns The layers.
94
- */
95
- get_layers(): LayerScene[];
96
- layers: Writable<LayerScene[]>;
97
- active_layer: Writable<LayerScene | null>;
98
-
99
- add_layer_from_blob(
100
- container: Container,
101
- renderer: IRenderer,
102
- blob: Blob,
103
- view: HTMLCanvasElement
104
- ): Promise<Command>;
105
- }
106
-
107
- /**
108
- * Swaps two adjacent elements in an array.
109
- * @param array The array to swap elements in.
110
- * @param index The index of the first element to swap.
111
- */
112
- function swap_adjacent(array: any[], index: number): void {
113
- if (index < 0 || index >= array.length - 1) {
114
- throw new Error("Index out of bounds");
115
- }
116
-
117
- [array[index], array[index + 1]] = [array[index + 1], array[index]];
118
- }
119
-
120
- /**
121
- * Creates a layer manager.
122
- * @param canvas_resize a function to resize the canvas
123
- * @returns a layer manager
124
- */
125
- export function layer_manager(): LayerManager {
126
- let _layers: LayerScene[] = [];
127
- let current_layer = 0;
128
- let position = 0;
129
-
130
- return {
131
- add_layer: function (
132
- container: Container,
133
- renderer: IRenderer,
134
- width: number,
135
- height: number,
136
- sprite?: Sprite
137
- ): Command {
138
- let layer_container: Container & DisplayObject;
139
- let layer_number: number;
140
- let that = this;
141
- return {
142
- execute: function () {
143
- layer_container = new Container() as Container & DisplayObject;
144
- position++;
145
- layer_container.zIndex = position;
146
-
147
- const composite_texture = RenderTexture.create({
148
- width,
149
- height
150
- });
151
-
152
- const composite = new Sprite(composite_texture) as Sprite &
153
- DisplayObject;
154
-
155
- layer_container.addChild(composite);
156
-
157
- composite.zIndex = position;
158
-
159
- const layer_scene: LayerScene = {
160
- draw_texture: RenderTexture.create({
161
- width,
162
- height
163
- }),
164
- erase_texture: RenderTexture.create({
165
- width,
166
- height
167
- }),
168
- composite
169
- };
170
-
171
- const erase_filter = new Filter(undefined, erase_shader, {
172
- uEraserTexture: layer_scene.erase_texture,
173
- uDrawingTexture: layer_scene.draw_texture
174
- });
175
-
176
- composite.filters = [erase_filter];
177
-
178
- container.addChild(layer_container);
179
- _layers.push(layer_scene);
180
- that.layers.update((s) => [...s, layer_scene]);
181
- that.active_layer.set(layer_scene);
182
-
183
- layer_number = get(that.layers).length - 1;
184
-
185
- if (sprite) {
186
- renderer.render(sprite, {
187
- renderTexture: layer_scene.draw_texture
188
- });
189
- }
190
- },
191
- undo: function () {
192
- container.removeChild(layer_container);
193
-
194
- _layers = get(that.layers);
195
- _layers = _layers.filter((_, i) => i !== layer_number);
196
- that.layers.set(_layers);
197
- const new_layer = _layers[layer_number - 1] || _layers[0] || null;
198
- that.active_layer.set(new_layer);
199
- }
200
- };
201
- },
202
-
203
- swap_layers: function (
204
- layer: number,
205
- direction: "up" | "down"
206
- ): LayerScene {
207
- if (direction === "up") {
208
- swap_adjacent(_layers, layer);
209
- } else {
210
- swap_adjacent(_layers, layer - 1);
211
- }
212
- return _layers[layer];
213
- },
214
-
215
- change_active_layer: function (layer: number): LayerScene {
216
- // current_layer = layer;
217
- this.active_layer.set(get(this.layers)[layer]);
218
- return _layers[layer];
219
- },
220
- reset() {
221
- _layers.forEach((layer) => {
222
- layer.draw_texture.destroy(true);
223
- layer.erase_texture.destroy(true);
224
- layer.composite.destroy(true);
225
- });
226
- _layers = [];
227
- current_layer = 0;
228
- position = 0;
229
- this.active_layer.set(null);
230
- this.layers.set([]);
231
- },
232
- async add_layer_from_blob(
233
- container: Container,
234
- renderer: IRenderer,
235
- blob: Blob,
236
- view: HTMLCanvasElement
237
- ): Promise<Command> {
238
- const img = await createImageBitmap(blob);
239
- const bitmap_texture = Texture.from(img);
240
-
241
- const [w, h] = resize_to_fit(
242
- bitmap_texture.width,
243
- bitmap_texture.height,
244
- view.width,
245
- view.height
246
- );
247
-
248
- const sprite = new Sprite(bitmap_texture) as Sprite & DisplayObject;
249
- sprite.zIndex = 0;
250
-
251
- sprite.width = w;
252
- sprite.height = h;
253
-
254
- return this.add_layer(
255
- container,
256
- renderer,
257
- view.width,
258
- view.height,
259
- sprite
260
- );
261
- },
262
- get_layers() {
263
- return _layers;
264
- },
265
- layers: writable([]),
266
- active_layer: writable(null)
267
- };
268
- }
269
-
270
- function resize_to_fit(
271
- inner_width: number,
272
- inner_height: number,
273
- outer_width: number,
274
- outer_height: number
275
- ): [number, number] {
276
- if (inner_width <= outer_width && inner_height <= outer_height) {
277
- return [inner_width, inner_height];
278
- }
279
-
280
- const inner_aspect = inner_width / inner_height;
281
- const outer_aspect = outer_width / outer_height;
282
-
283
- let new_width, new_height;
284
-
285
- if (inner_aspect > outer_aspect) {
286
- new_width = outer_width;
287
- new_height = outer_width / inner_aspect;
288
- } else {
289
- new_height = outer_height;
290
- new_width = outer_height * inner_aspect;
291
- }
292
-
293
- return [new_width, new_height];
294
- }