Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots 📖

feat(ui): allow uploading an image for a step that has none

Luis Ortiz5a1e5cc59cf7
diff --git a/src/core/screenshot/render.ts b/src/core/screenshot/render.ts
index 85f3600..39226ec 100644
--- a/src/core/screenshot/render.ts
+++ b/src/core/screenshot/render.ts
@@ -7,6 +7,13 @@ interface RenderOptions {
quality?: number;
}
+export async function imageDimensions(file: Blob): Promise<{ width: number; height: number }> {
+ const bitmap = await createImageBitmap(file);
+ const { width, height } = bitmap;
+ bitmap.close();
+ return { width, height };
+}
+
export async function renderScreenshot(screenshot: Screenshot, opts: RenderOptions = {}): Promise<Blob> {
const { format = 'image/webp', quality = 0.85 } = opts;
const viewport = resolveViewport(screenshot);
diff --git a/src/locales/de.yml b/src/locales/de.yml
index 13b1d99..7011223 100644
--- a/src/locales/de.yml
+++ b/src/locales/de.yml
@@ -357,6 +357,7 @@ screenshotView:
downloadEdited: "Bearbeitetes Bild"
downloadOriginal: "Originalbild"
edit: "Bearbeiten"
+ addImage: "Bild hinzufügen"
replaceImage: "Bild ersetzen"
replaceHint: "Wähle ein neues Bild für diesen Schritt"
replaceDrop: "Klicken zum Auswählen oder Bild hierher ziehen"
diff --git a/src/locales/en.yml b/src/locales/en.yml
index a81ac55..613a19f 100644
--- a/src/locales/en.yml
+++ b/src/locales/en.yml
@@ -219,6 +219,7 @@ screenshotView:
downloadEdited: "Edited image"
downloadOriginal: "Original image"
edit: "Edit"
+ addImage: Add image
replaceImage: Replace image
replaceHint: "Choose a new image for this step"
replaceDrop: "Click to browse or drop an image here"
diff --git a/src/locales/es.yml b/src/locales/es.yml
index 0b81b19..7b101d8 100644
--- a/src/locales/es.yml
+++ b/src/locales/es.yml
@@ -219,6 +219,7 @@ screenshotView:
downloadEdited: "Imagen editada"
downloadOriginal: "Imagen original"
edit: "Editar"
+ addImage: Añadir imagen
replaceImage: Reemplazar imagen
replaceHint: "Elige una nueva imagen para este paso"
replaceDrop: "Haz clic para buscar o suelta una imagen aquí"
diff --git a/src/locales/fr.yml b/src/locales/fr.yml
index 5b0fb34..4de2ebc 100644
--- a/src/locales/fr.yml
+++ b/src/locales/fr.yml
@@ -219,6 +219,7 @@ screenshotView:
downloadEdited: "Image modifiée"
downloadOriginal: "Image originale"
edit: "Modifier"
+ addImage: "Ajouter une image"
replaceImage: "Remplacer l'image"
replaceHint: "Choisissez une nouvelle image pour cette étape"
replaceDrop: "Cliquez pour parcourir ou déposez une image ici"
diff --git a/src/locales/pt-BR.yml b/src/locales/pt-BR.yml
index 74aa7ce..7c231aa 100644
--- a/src/locales/pt-BR.yml
+++ b/src/locales/pt-BR.yml
@@ -219,6 +219,7 @@ screenshotView:
downloadEdited: "Imagem editada"
downloadOriginal: "Imagem original"
edit: "Editar"
+ addImage: Adicionar imagem
replaceImage: Substituir imagem
replaceHint: "Escolha uma nova imagem para esta etapa"
replaceDrop: "Clique para procurar ou solte uma imagem aqui"
diff --git a/src/ui/shared/ImagePlaceholder.tsx b/src/ui/shared/ImagePlaceholder.tsx
index a7d3df6..1ad8fdb 100644
--- a/src/ui/shared/ImagePlaceholder.tsx
+++ b/src/ui/shared/ImagePlaceholder.tsx
@@ -1,16 +1,28 @@
+import { ImageUp } from 'lucide-react';
+import { useState } from 'react';
+import { i18n } from '#imports';
import type { Screenshot } from '@/core/guides/types';
import { resolveViewport } from '@/core/screenshot/geometry';
import MascotIcon from '@/ui/shared/MascotIcon';
+import ReplaceImageDialog from '@/ui/shared/ReplaceImageDialog';
interface ImagePlaceholderProps {
label: string;
ratio?: number;
className?: string;
+ onUpload?: (file: File) => void | Promise<void>;
}
const DEFAULT_RATIO = 16 / 10;
-export default function ImagePlaceholder({ label, ratio = DEFAULT_RATIO, className = '' }: ImagePlaceholderProps) {
+export default function ImagePlaceholder({
+ label,
+ ratio = DEFAULT_RATIO,
+ className = '',
+ onUpload,
+}: ImagePlaceholderProps) {
+ const [uploadOpen, setUploadOpen] = useState(false);
+
return (
<div
className={`flex flex-col items-center justify-center gap-2 rounded-lg border border-dashed border-border bg-secondary/60 text-muted-foreground ${className}`}
@@ -18,6 +30,26 @@ export default function ImagePlaceholder({ label, ratio = DEFAULT_RATIO, classNa
>
<MascotIcon size={64} pose="lookaway" tone="muted" />
<span className="text-[12px] font-semibold text-muted-foreground">{label}</span>
+ {onUpload && (
+ <>
+ <button
+ type="button"
+ onClick={() => setUploadOpen(true)}
+ className="flex items-center gap-1.5 h-7 px-2.5 rounded-md border border-border bg-card/90 text-[11px] font-semibold text-foreground transition-colors hover:bg-secondary hover:text-accent"
+ >
+ <ImageUp size={13} />
+ {i18n.t('screenshotView.addImage')}
+ </button>
+ <ReplaceImageDialog
+ open={uploadOpen}
+ onSelect={(file) => {
+ setUploadOpen(false);
+ void onUpload(file);
+ }}
+ onCancel={() => setUploadOpen(false)}
+ />
+ </>
+ )}
</div>
);
}
diff --git a/src/ui/shared/ScreenshotView.tsx b/src/ui/shared/ScreenshotView.tsx
index f59888c..59e59e1 100644
--- a/src/ui/shared/ScreenshotView.tsx
+++ b/src/ui/shared/ScreenshotView.tsx
@@ -4,7 +4,7 @@ import { i18n } from '#imports';
import { deleteScreenshot, replaceScreenshot, updateScreenshotEdits } from '@/core/guides/service';
import type { Screenshot, ScreenshotBounds } from '@/core/guides/types';
import { panBy, resolveViewport, zoomBy } from '@/core/screenshot/geometry';
-import { renderScreenshot } from '@/core/screenshot/render';
+import { imageDimensions, renderScreenshot } from '@/core/screenshot/render';
import type { ScreenshotEdits } from '@/core/screenshot/types';
import {
DropdownMenu,
@@ -230,9 +230,7 @@ export default function ScreenshotView({
if (saveTimerRef.current) clearTimeout(saveTimerRef.current);
setReplaceOpen(false);
- const bitmap = await createImageBitmap(file);
- const { width, height } = bitmap;
- bitmap.close();
+ const { width, height } = await imageDimensions(file);
const nextEdits: ScreenshotEdits = { ...effectiveEdits, target: null };
delete nextEdits.viewport;
@@ -249,6 +247,7 @@ export default function ScreenshotView({
height,
});
setEditsOverride(nextEdits);
+ setDeleted(false);
onChanged?.();
};
@@ -276,7 +275,14 @@ export default function ScreenshotView({
const ratio = frameRatio ?? ownRatio;
if (deleted) {
- return <ImagePlaceholder label={i18n.t('screenshotView.imageDeleted')} ratio={ratio} className={className} />;
+ return (
+ <ImagePlaceholder
+ label={i18n.t('screenshotView.imageDeleted')}
+ ratio={ratio}
+ className={className}
+ onUpload={readOnly ? undefined : handleReplaceFile}
+ />
+ );
}
if (!fullUrl) {
diff --git a/src/ui/sidepanel/StepCard.tsx b/src/ui/sidepanel/StepCard.tsx
index dd0db6f..a747c51 100644
--- a/src/ui/sidepanel/StepCard.tsx
+++ b/src/ui/sidepanel/StepCard.tsx
@@ -1,8 +1,9 @@
import { Check, Copy, Trash2 } from 'lucide-react';
import { useEffect, useRef, useState } from 'react';
import { i18n } from '#imports';
+import { replaceScreenshot } from '@/core/guides/service';
import type { Screenshot, Step } from '@/core/guides/types';
-import { renderScreenshot } from '@/core/screenshot/render';
+import { imageDimensions, renderScreenshot } from '@/core/screenshot/render';
import { logger } from '@/lib/logger';
import ConfirmDialog from '@/ui/shared/ConfirmDialog';
import ImagePlaceholder from '@/ui/shared/ImagePlaceholder';
@@ -71,6 +72,11 @@ export default function StepCard({
}
};
+ const handleUpload = async (file: File) => {
+ await replaceScreenshot(step.id, file, await imageDimensions(file));
+ onChanged?.();
+ };
+
const handleDragOver = (e: React.DragEvent) => {
e.preventDefault();
setDragOver(true);
@@ -116,6 +122,7 @@ export default function StepCard({
label={i18n.t('editor.noScreenshot')}
ratio={placeholderRatio}
className="w-full !rounded-none border-x-0 border-t-0"
+ onUpload={readOnly ? undefined : handleUpload}
/>
)}
diff --git a/src/ui/sidepanel/__tests__/step-card-upload.test.tsx b/src/ui/sidepanel/__tests__/step-card-upload.test.tsx
new file mode 100644
index 0000000..7fb7a8e
--- /dev/null
+++ b/src/ui/sidepanel/__tests__/step-card-upload.test.tsx
@@ -0,0 +1,44 @@
+// @vitest-environment jsdom
+import { render, screen } from '@testing-library/react';
+import { describe, expect, it, vi } from 'vitest';
+import type { Step } from '@/core/guides/types';
+
+vi.mock('@/core/guides/service', () => ({ replaceScreenshot: vi.fn() }));
+vi.mock('@/core/screenshot/render', () => ({ imageDimensions: vi.fn(), renderScreenshot: vi.fn() }));
+
+import StepCard from '../StepCard';
+
+const step: Step = {
+ id: 's1',
+ guideId: 'g1',
+ index: 0,
+ description: 'Click the thing',
+ action: 'click',
+ url: 'https://a.test',
+ timestamp: 1,
+};
+
+function renderCard(readOnly: boolean) {
+ return render(
+ <StepCard
+ step={step}
+ screenshot={undefined}
+ readOnly={readOnly}
+ onDescriptionChange={vi.fn()}
+ onDelete={vi.fn()}
+ onChanged={vi.fn()}
+ />,
+ );
+}
+
+describe('StepCard without a screenshot', () => {
+ it('offers an upload when the step is editable', () => {
+ renderCard(false);
+ expect(screen.getByRole('button', { name: /screenshotView.addImage/ })).toBeTruthy();
+ });
+
+ it('offers no upload when the step is read-only', () => {
+ renderCard(true);
+ expect(screen.queryByRole('button', { name: /screenshotView.addImage/ })).toBeNull();
+ });
+});