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(core): draw the pointer when a screenshot renders

Luis Ortiz0fe2bfb63a65
diff --git a/apps/desktop/src/renderer/cursor.ts b/packages/core/src/screenshot/cursor.ts
similarity index 59%
rename from apps/desktop/src/renderer/cursor.ts
rename to packages/core/src/screenshot/cursor.ts
index 5e788ef..674df1e 100644
--- a/apps/desktop/src/renderer/cursor.ts
+++ b/packages/core/src/screenshot/cursor.ts
@@ -1,11 +1,4 @@
-export type CursorStyle = 'arrow' | 'hand' | 'dot';
-
-export interface CursorMark {
- x: number;
- y: number;
- style: CursorStyle;
- scale: number;
-}
+import type { CursorMark } from './types';
const ARROW: [number, number][] = [
[0, 0],
@@ -35,7 +28,9 @@ const HAND: [number, number][] = [
[6, 14.6],
];
-function traceOutline(ctx: OffscreenCanvasRenderingContext2D, points: [number, number][], size: number): void {
+type Ctx = OffscreenCanvasRenderingContext2D | CanvasRenderingContext2D;
+
+function traceOutline(ctx: Ctx, points: [number, number][], size: number): void {
ctx.beginPath();
points.forEach(([x, y], index) => {
const px = (x / 20) * size;
@@ -48,7 +43,7 @@ function traceOutline(ctx: OffscreenCanvasRenderingContext2D, points: [number, n
ctx.stroke();
}
-export function drawCursor(ctx: OffscreenCanvasRenderingContext2D, mark: CursorMark): void {
+export function drawCursor(ctx: Ctx, mark: CursorMark): void {
const size = 22 * mark.scale;
ctx.save();
@@ -74,18 +69,3 @@ export function drawCursor(ctx: OffscreenCanvasRenderingContext2D, mark: CursorM
ctx.restore();
}
-
-export async function withCursor(png: Uint8Array, width: number, height: number, mark: CursorMark): Promise<Blob> {
- const source = await createImageBitmap(new Blob([Uint8Array.from(png)], { type: 'image/png' }));
- const canvas = new OffscreenCanvas(width, height);
- const ctx = canvas.getContext('2d');
- if (!ctx) {
- source.close();
- return new Blob([Uint8Array.from(png)], { type: 'image/png' });
- }
-
- ctx.drawImage(source, 0, 0);
- source.close();
- drawCursor(ctx, mark);
- return canvas.convertToBlob({ type: 'image/png' });
-}
diff --git a/packages/core/src/screenshot/render.ts b/packages/core/src/screenshot/render.ts
index 2853375..7ec82f8 100644
--- a/packages/core/src/screenshot/render.ts
+++ b/packages/core/src/screenshot/render.ts
@@ -1,4 +1,5 @@
import type { Screenshot, ScreenshotBounds } from '@/core/guides/types';
+import { drawCursor } from './cursor';
import { drawAnnotation } from './draw';
import { resolveTarget, resolveViewport } from './geometry';
@@ -49,5 +50,8 @@ export async function renderScreenshot(screenshot: Screenshot, opts: RenderOptio
for (const a of screenshot.edits?.annotations ?? []) drawAnnotation(ctx, a, viewport.x, viewport.y);
+ const cursor = screenshot.edits?.cursor;
+ if (cursor) drawCursor(ctx, cursor);
+
return canvas.convertToBlob({ type: format, quality });
}
diff --git a/packages/core/src/screenshot/types.ts b/packages/core/src/screenshot/types.ts
index 5dfb947..ad556a4 100644
--- a/packages/core/src/screenshot/types.ts
+++ b/packages/core/src/screenshot/types.ts
@@ -138,9 +138,19 @@ export type Annotation =
| { id: string; type: 'redact'; x: number; y: number; w: number; h: number; style: 'blur' | 'solid' }
| { id: string; type: 'target'; x: number; y: number; w: number; h: number; color: string; border: TargetBorder };
+export type CursorStyle = 'arrow' | 'hand' | 'dot';
+
+export interface CursorMark {
+ x: number;
+ y: number;
+ style: CursorStyle;
+ scale: number;
+}
+
export interface ScreenshotEdits {
viewport?: ScreenshotBounds;
target?: ClickTarget | null;
annotations?: Annotation[];
+ cursor?: CursorMark | null;
alt?: string;
}