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(desktop): build the app interface from the shared components

Luis Ortiz18921cc95b02
diff --git a/apps/desktop/electron.vite.config.ts b/apps/desktop/electron.vite.config.ts
index e8c06dd..3764ec1 100644
--- a/apps/desktop/electron.vite.config.ts
+++ b/apps/desktop/electron.vite.config.ts
@@ -1,7 +1,23 @@
+import { readFileSync } from 'node:fs';
import { resolve } from 'node:path';
import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
+import type { PluginOption } from 'vite';
+import { load } from 'js-yaml';
+import react from '@vitejs/plugin-react';
+import tailwindcss from '@tailwindcss/vite';
const core = resolve(__dirname, '../../packages/core/src');
+const locales = resolve(__dirname, '../../src/locales');
+
+function yaml(): PluginOption {
+ return {
+ name: 'mimik-yaml',
+ transform(_code: string, id: string) {
+ if (!id.endsWith('.yml')) return null;
+ return { code: `export default ${JSON.stringify(load(readFileSync(id, 'utf8')))}`, map: null };
+ },
+ };
+}
export default defineConfig({
main: {
@@ -15,6 +31,7 @@ export default defineConfig({
'check-storage': resolve(__dirname, 'scripts/check-storage.ts'),
'check-overlay': resolve(__dirname, 'scripts/check-overlay.ts'),
'check-pipeline': resolve(__dirname, 'scripts/check-pipeline.ts'),
+ 'shot-ui': resolve(__dirname, 'scripts/shot-ui.ts'),
},
output: { entryFileNames: '[name].js', chunkFileNames: '[name].js' },
},
@@ -35,7 +52,15 @@ export default defineConfig({
},
renderer: {
root: resolve(__dirname, 'src/renderer'),
- resolve: { alias: { '@mimik/core': core, '@/core': core } },
+ plugins: [yaml(), react(), tailwindcss()],
+ resolve: {
+ alias: {
+ '@mimik/core': core,
+ '@mimik/ui': resolve(__dirname, '../../packages/ui/src'),
+ '@/core': core,
+ '@mimik/locales': locales,
+ },
+ },
build: {
outDir: resolve(__dirname, 'out/renderer'),
emptyOutDir: true,
diff --git a/apps/desktop/package.json b/apps/desktop/package.json
index 58ad348..28764f3 100644
--- a/apps/desktop/package.json
+++ b/apps/desktop/package.json
@@ -16,16 +16,24 @@
"vm:windows": "bash scripts/windows-vm.sh"
},
"dependencies": {
- "electron-updater": "^6.6.2",
"@mimik/core": "workspace:*",
- "uiohook-napi": "^1.5.5",
+ "@mimik/ui": "workspace:*",
+ "dexie": "^4.3.0",
+ "electron-updater": "^6.6.2",
"get-windows": "^9.3.0",
- "dexie": "^4.3.0"
+ "react": "^19.2.4",
+ "react-dom": "^19.2.4",
+ "uiohook-napi": "^1.5.5"
},
"devDependencies": {
+ "@tailwindcss/vite": "^4.2.2",
+ "@types/js-yaml": "^4.0.9",
+ "@vitejs/plugin-react": "^4.3.4",
"electron": "^33.2.1",
"electron-builder": "^25.1.8",
"electron-vite": "^2.3.0",
+ "js-yaml": "^4.1.0",
+ "tailwindcss": "^4.2.2",
"vite": "^6.0.3"
},
"description": "Mimik desktop shell",
diff --git a/apps/desktop/scripts/shot-ui.ts b/apps/desktop/scripts/shot-ui.ts
new file mode 100644
index 0000000..5515bbd
--- /dev/null
+++ b/apps/desktop/scripts/shot-ui.ts
@@ -0,0 +1,26 @@
+import { writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { app, BrowserWindow } from 'electron';
+
+app.disableHardwareAcceleration();
+app.on('window-all-closed', () => {});
+
+app.whenReady().then(async () => {
+ const win = new BrowserWindow({
+ width: 1200,
+ height: 820,
+ show: false,
+ webPreferences: { preload: join(__dirname, '../preload/index.cjs'), contextIsolation: true },
+ });
+ win.webContents.on('console-message', (_e, level, message, line, source) => {
+ process.stdout.write(`[console ${level}] ${message} (${source}:${line})\n`);
+ });
+ win.webContents.on('render-process-gone', (_e, d) => process.stdout.write(`[gone] ${d.reason}\n`));
+ await win.loadFile(join(__dirname, '../renderer/index.html'));
+ await new Promise((r) => setTimeout(r, 2500));
+ const image = await win.webContents.capturePage();
+ const out = process.env.SHOT_OUT ?? '/tmp/mimik-ui.png';
+ writeFileSync(out, image.toPNG());
+ process.stdout.write(`wrote ${out}\n`);
+ app.exit(0);
+}).catch((e) => { process.stdout.write(`FAIL ${e}\n`); app.exit(1); });
diff --git a/apps/desktop/src/env.d.ts b/apps/desktop/src/env.d.ts
index e815d50..fa471ee 100644
--- a/apps/desktop/src/env.d.ts
+++ b/apps/desktop/src/env.d.ts
@@ -4,6 +4,7 @@ import type { MimikOverlayApi } from './preload/overlay';
declare global {
interface ImportMetaEnv {
readonly COMMAND?: string;
+ readonly BROWSER?: string;
}
interface Window {
diff --git a/apps/desktop/src/main/index.ts b/apps/desktop/src/main/index.ts
index 8e184aa..fac7ed5 100644
--- a/apps/desktop/src/main/index.ts
+++ b/apps/desktop/src/main/index.ts
@@ -12,6 +12,7 @@ let overlay: CaptureOverlay | null = null;
let recorder: DesktopRecorder | null = null;
let guideId: string | null = null;
let captureSettings: CaptureSettings | null = null;
+let stepCount = 0;
function resource(file: string): string {
return app.isPackaged ? join(process.resourcesPath, file) : join(__dirname, '../../resources', file);
@@ -113,6 +114,7 @@ function broadcastOverlay(command: OverlayCommand): void {
async function onOverlayCommand(command: OverlayCommand): Promise<void> {
if (command === 'start' && !guideId) {
+ stepCount = 0;
guideId = await ask<string>(mainWindow?.webContents ?? null, 'mimik:capture:startGuide');
const started = await recorder?.start();
if (started && !started.ok) {
@@ -158,8 +160,14 @@ if (!app.requestSingleInstanceLock()) {
recorder = new DesktopRecorder(
() => overlay?.region ?? { x: 0, y: 0, width: 0, height: 0 },
(fn) => (overlay ? overlay.withHidden(fn) : fn()),
- (request) =>
- ask(mainWindow?.webContents ?? null, 'mimik:capture:step', { ...request, guideId }).catch(() => undefined),
+ async (request) => {
+ const reply = await ask<{ title?: string }>(mainWindow?.webContents ?? null, 'mimik:capture:step', {
+ ...request,
+ guideId,
+ }).catch(() => undefined);
+ if (reply?.title) overlay?.stepCaptured(++stepCount, reply.title);
+ return reply;
+ },
undefined,
() => captureSettings ?? loadSettings(),
);
@@ -171,6 +179,7 @@ if (!app.requestSingleInstanceLock()) {
});
ipcMain.handle('mimik:capture:region', () => overlay?.region);
ipcMain.handle('mimik:capture:edit', () => overlay?.edit());
+ ipcMain.handle('mimik:capture:arm', () => overlay?.arm());
createWindow();
createTray();
diff --git a/apps/desktop/src/main/overlay/index.ts b/apps/desktop/src/main/overlay/index.ts
index 5be924b..f9d698c 100644
--- a/apps/desktop/src/main/overlay/index.ts
+++ b/apps/desktop/src/main/overlay/index.ts
@@ -53,11 +53,13 @@ export class CaptureOverlay {
private controls: BrowserWindow | null = null;
private current: OverlayState = 'hidden';
private rect: Region;
+ private last: { index: number; title: string } | null = null;
constructor(private onCommand: (command: OverlayCommand) => void) {
this.rect = loadRegion();
ipcMain.handle('mimik:overlay:region', () => this.rect);
ipcMain.handle('mimik:overlay:state', () => this.current);
+ ipcMain.handle('mimik:overlay:last', () => this.last);
ipcMain.on('mimik:overlay:setRegion', (_event, next: Region) => this.setRegion(next));
ipcMain.on('mimik:overlay:command', (_event, command: OverlayCommand) => this.command(command));
}
@@ -77,7 +79,12 @@ export class CaptureOverlay {
}
private broadcast(): void {
- for (const win of this.windows()) win.webContents.send('mimik:overlay:update', this.current, this.rect);
+ for (const win of this.windows()) win.webContents.send('mimik:overlay:update', this.current, this.rect, this.last);
+ }
+
+ stepCaptured(index: number, title: string): void {
+ this.last = { index, title };
+ this.broadcast();
}
private setRegion(next: Region): void {
@@ -179,7 +186,10 @@ export class CaptureOverlay {
else if (command === 'arm') this.arm();
else if (command === 'start' || command === 'resume') this.record();
else if (command === 'pause') this.pause();
- else this.hide();
+ else {
+ this.last = null;
+ this.hide();
+ }
this.onCommand(command);
}
@@ -199,7 +209,8 @@ export class CaptureOverlay {
this.boundary = null;
this.controls = null;
this.current = 'hidden';
- for (const channel of ['mimik:overlay:region', 'mimik:overlay:state']) ipcMain.removeHandler(channel);
+ for (const channel of ['mimik:overlay:region', 'mimik:overlay:state', 'mimik:overlay:last'])
+ ipcMain.removeHandler(channel);
ipcMain.removeAllListeners('mimik:overlay:setRegion');
ipcMain.removeAllListeners('mimik:overlay:command');
}
diff --git a/apps/desktop/src/preload/index.ts b/apps/desktop/src/preload/index.ts
index bb13cf0..a53c950 100644
--- a/apps/desktop/src/preload/index.ts
+++ b/apps/desktop/src/preload/index.ts
@@ -13,6 +13,7 @@ const api = {
capture: {
region: (): Promise<Region> => ipcRenderer.invoke('mimik:capture:region'),
edit: (): Promise<void> => ipcRenderer.invoke('mimik:capture:edit'),
+ arm: (): Promise<void> => ipcRenderer.invoke('mimik:capture:arm'),
settings: {
get: (): Promise<CaptureSettings> => ipcRenderer.invoke('mimik:capture:settings:get'),
set: (patch: Partial<CaptureSettings>): Promise<CaptureSettings> =>
diff --git a/apps/desktop/src/preload/overlay.ts b/apps/desktop/src/preload/overlay.ts
index 637c16c..506441e 100644
--- a/apps/desktop/src/preload/overlay.ts
+++ b/apps/desktop/src/preload/overlay.ts
@@ -7,13 +7,21 @@ interface Region {
height: number;
}
+interface LastStep {
+ index: number;
+ title: string;
+}
+
const api = {
region: (): Promise<Region> => ipcRenderer.invoke('mimik:overlay:region'),
state: (): Promise<string> => ipcRenderer.invoke('mimik:overlay:state'),
+ last: (): Promise<LastStep> => ipcRenderer.invoke('mimik:overlay:last'),
setRegion: (region: Region): void => ipcRenderer.send('mimik:overlay:setRegion', region),
command: (command: string): void => ipcRenderer.send('mimik:overlay:command', command),
- onUpdate: (handler: (state: string, region: Region) => void): void => {
- ipcRenderer.on('mimik:overlay:update', (_event, state: string, region: Region) => handler(state, region));
+ onUpdate: (handler: (state: string, region: Region, last: LastStep | null) => void): void => {
+ ipcRenderer.on('mimik:overlay:update', (_event, state: string, region: Region, last: LastStep | null) =>
+ handler(state, region, last),
+ );
},
};
diff --git a/apps/desktop/src/renderer/App.tsx b/apps/desktop/src/renderer/App.tsx
new file mode 100644
index 0000000..ed272b7
--- /dev/null
+++ b/apps/desktop/src/renderer/App.tsx
@@ -0,0 +1,44 @@
+import { useEffect, useState } from 'react';
+import LibraryContent from '@mimik/ui/fullview/LibraryContent';
+import GuideContent from '@mimik/ui/fullview/GuideContent';
+import { TooltipProvider } from '@mimik/ui/components/ui/tooltip';
+import SettingsPanel from './SettingsPanel';
+import TopBar from './TopBar';
+
+export default function App() {
+ const [guideId, setGuideId] = useState<string | null>(null);
+ const [settingsOpen, setSettingsOpen] = useState(false);
+
+ useEffect(() => {
+ const onHash = () => {
+ const match = window.location.hash.match(/^#guide\/(.+)$/);
+ setGuideId(match ? match[1] : null);
+ };
+ onHash();
+ window.addEventListener('hashchange', onHash);
+ return () => window.removeEventListener('hashchange', onHash);
+ }, []);
+
+ return (
+ <TooltipProvider>
+ <div className="min-h-screen flex flex-col bg-background">
+ <TopBar onSettings={() => setSettingsOpen(true)} />
+ {settingsOpen ? (
+ <main className="flex-1">
+ <SettingsPanel onClose={() => setSettingsOpen(false)} />
+ </main>
+ ) : guideId ? (
+ <main className="flex-1 py-10 px-6">
+ <div className="mx-auto max-w-[720px]">
+ <GuideContent guideId={guideId} />
+ </div>
+ </main>
+ ) : (
+ <main className="flex-1 p-8 max-w-6xl mx-auto w-full">
+ <LibraryContent category="all" />
+ </main>
+ )}
+ </div>
+ </TooltipProvider>
+ );
+}
diff --git a/apps/desktop/src/renderer/SettingsPanel.tsx b/apps/desktop/src/renderer/SettingsPanel.tsx
new file mode 100644
index 0000000..ee59454
--- /dev/null
+++ b/apps/desktop/src/renderer/SettingsPanel.tsx
@@ -0,0 +1,86 @@
+import { useEffect, useState } from 'react';
+import { i18n } from '@mimik/core/env';
+import type { CaptureSettings } from '../main/capture/settings';
+import { Button } from '@mimik/ui/components/ui/button';
+
+const STYLES: CaptureSettings['cursorStyle'][] = ['arrow', 'hand', 'dot'];
+
+export default function SettingsPanel({ onClose }: { onClose(): void }) {
+ const [settings, setSettings] = useState<CaptureSettings | null>(null);
+
+ useEffect(() => {
+ window.mimik.capture.settings.get().then(setSettings);
+ }, []);
+
+ const save = async (patch: Partial<CaptureSettings>) => {
+ setSettings(await window.mimik.capture.settings.set(patch));
+ };
+
+ return (
+ <div className="mx-auto w-full max-w-2xl p-8">
+ <div className="mb-6 flex items-center">
+ <h1 className="mr-auto text-lg font-semibold text-foreground">{i18n.t('settings_title')}</h1>
+ <Button variant="ghost" size="sm" onClick={onClose}>
+ {i18n.t('common_close')}
+ </Button>
+ </div>
+
+ {settings && (
+ <section className="mb-8 rounded-xl border border-border bg-secondary/40 p-5">
+ <h2 className="mb-4 text-xs font-semibold uppercase tracking-wider text-muted-foreground">
+ {i18n.t('desktop_capturingSection')}
+ </h2>
+
+ <label className="mb-3 flex items-center gap-3 text-sm text-foreground">
+ <input
+ type="checkbox"
+ checked={settings.showCursor}
+ onChange={(e) => save({ showCursor: e.target.checked })}
+ />
+ {i18n.t('desktop_showCursor')}
+ </label>
+
+ <label className="mb-3 flex items-center gap-3 text-sm text-foreground">
+ <span className="mr-auto">{i18n.t('desktop_pointerStyle')}</span>
+ <select
+ className="rounded-md border border-border bg-background px-2 py-1"
+ value={settings.cursorStyle}
+ disabled={!settings.showCursor}
+ onChange={(e) => save({ cursorStyle: e.target.value as CaptureSettings['cursorStyle'] })}
+ >
+ {STYLES.map((style) => (
+ <option key={style} value={style}>
+ {style}
+ </option>
+ ))}
+ </select>
+ </label>
+
+ <label className="mb-3 flex items-center gap-3 text-sm text-foreground">
+ <span className="mr-auto">{i18n.t('desktop_screenshotDelay')}</span>
+ <input
+ type="number"
+ min={0}
+ max={2000}
+ step={50}
+ className="w-24 rounded-md border border-border bg-background px-2 py-1"
+ value={settings.screenshotDelayMs}
+ onChange={(e) => save({ screenshotDelayMs: Number(e.target.value) })}
+ />
+ <span className="text-muted-foreground">{i18n.t('desktop_milliseconds')}</span>
+ </label>
+
+ <label className="flex items-center gap-3 text-sm text-foreground">
+ <input
+ type="checkbox"
+ checked={settings.captureOutsideClicks}
+ onChange={(e) => save({ captureOutsideClicks: e.target.checked })}
+ />
+ {i18n.t('desktop_captureOutside')}
+ </label>
+ </section>
+ )}
+
+ </div>
+ );
+}
diff --git a/apps/desktop/src/renderer/TopBar.tsx b/apps/desktop/src/renderer/TopBar.tsx
new file mode 100644
index 0000000..ef706d1
--- /dev/null
+++ b/apps/desktop/src/renderer/TopBar.tsx
@@ -0,0 +1,26 @@
+import { Circle, Crop, Settings } from 'lucide-react';
+import { i18n } from '@mimik/core/env';
+import { Button } from '@mimik/ui/components/ui/button';
+
+export default function TopBar({ onSettings }: { onSettings(): void }) {
+ return (
+ <header className="flex items-center gap-2 border-b border-border bg-background px-6 py-3">
+ <span className="mr-auto text-sm font-semibold text-foreground">{i18n.t('app_name')}</span>
+
+ <Button variant="ghost" size="sm" onClick={() => window.mimik.capture.edit()}>
+ <Crop className="size-4" />
+ {i18n.t('desktop_captureArea')}
+ </Button>
+
+ <Button variant="ghost" size="sm" onClick={onSettings}>
+ <Settings className="size-4" />
+ {i18n.t('settings_title')}
+ </Button>
+
+ <Button size="sm" onClick={() => window.mimik.capture.arm()}>
+ <Circle className="size-3 fill-current" />
+ {i18n.t('desktop_record')}
+ </Button>
+ </header>
+ );
+}
diff --git a/apps/desktop/src/renderer/capture-sink.ts b/apps/desktop/src/renderer/capture-sink.ts
index 1025889..d295313 100644
--- a/apps/desktop/src/renderer/capture-sink.ts
+++ b/apps/desktop/src/renderer/capture-sink.ts
@@ -29,7 +29,7 @@ export class DesktopCaptureSink implements CaptureSink {
return guide.id;
}
- async captureStep(data: DesktopCaptureStepData): Promise<CaptureStepResponse> {
+ async captureStep(data: DesktopCaptureStepData): Promise<CaptureStepResponse & { title?: string }> {
const stepId = crypto.randomUUID();
const meta = data.elementMeta;
const index = (await getStepsForGuide(data.guideId)).length;
@@ -65,11 +65,13 @@ export class DesktopCaptureSink implements CaptureSink {
screenshotId = screenshot.id;
}
+ const description = buildFallbackDescription(data.action, meta);
+
await createStep({
id: stepId,
guideId: data.guideId,
index,
- description: buildFallbackDescription(data.action, meta),
+ description,
action: data.action,
url: '',
app: meta.app,
@@ -81,7 +83,7 @@ export class DesktopCaptureSink implements CaptureSink {
});
await addStepToGuide(data.guideId, stepId);
- return { stepId };
+ return { stepId, title: description };
}
async updateInputStep(data: UpdateInputStepData): Promise<UpdateInputStepResponse> {
diff --git a/apps/desktop/src/renderer/index.html b/apps/desktop/src/renderer/index.html
index 010241f..7efab6c 100644
--- a/apps/desktop/src/renderer/index.html
+++ b/apps/desktop/src/renderer/index.html
@@ -7,6 +7,6 @@
</head>
<body>
<div id="root"></div>
- <script type="module" src="./main.ts"></script>
+ <script type="module" src="./main.tsx"></script>
</body>
</html>
diff --git a/apps/desktop/src/renderer/main.ts b/apps/desktop/src/renderer/main.ts
deleted file mode 100644
index 174215d..0000000
--- a/apps/desktop/src/renderer/main.ts
+++ /dev/null
@@ -1,121 +0,0 @@
-import './core-env';
-import { PRESET_LABELS } from '@mimik/core/blur/regexes';
-import type { CaptureStepData } from '@mimik/core/capture/sink';
-import { getGuides } from '@mimik/core/guides/service';
-import type { CaptureSettings } from '../main/capture/settings';
-import { DesktopCaptureSink } from './capture-sink';
-import './style.css';
-
-const sink = new DesktopCaptureSink();
-window.mimik.onRequest('mimik:capture:startGuide', () => sink.startGuide());
-window.mimik.onRequest('mimik:capture:step', (payload) => sink.captureStep(payload as CaptureStepData));
-
-const root = document.getElementById('root') as HTMLElement;
-
-async function render(): Promise<void> {
- const [version, atLogin, region, settings] = await Promise.all([
- window.mimik.version(),
- window.mimik.openAtLogin.get(),
- window.mimik.capture.region(),
- window.mimik.capture.settings.get(),
- ]);
- root.replaceChildren();
-
- const title = document.createElement('h1');
- title.textContent = 'Mimik Desktop';
-
- const meta = document.createElement('p');
- meta.className = 'meta';
- meta.textContent = `Version ${version}`;
-
- const label = document.createElement('label');
- const toggle = document.createElement('input');
- toggle.type = 'checkbox';
- toggle.checked = atLogin;
- toggle.addEventListener('change', async () => {
- toggle.checked = await window.mimik.openAtLogin.set(toggle.checked);
- });
- label.append(toggle, document.createTextNode('Start Mimik when I log in'));
-
- const shared = document.createElement('p');
- shared.className = 'meta';
- shared.textContent = `Smart Blur categories from @mimik/core: ${Object.values(PRESET_LABELS).join(', ')}`;
-
- const area = document.createElement('p');
- area.className = 'meta';
- area.textContent = `Capture area ${region.width} Γ— ${region.height} at ${region.x}, ${region.y}`;
-
- const edit = document.createElement('button');
- edit.textContent = 'Set capture area';
- edit.addEventListener('click', () => window.mimik.capture.edit());
-
- const library = document.createElement('p');
- library.className = 'meta';
- const refresh = async () => {
- const guides = await getGuides();
- library.textContent = `${guides.length} guide(s) in the library`;
- };
- await refresh();
-
- window.mimik.capture.onCommand((_command, _state, next) => {
- area.textContent = `Capture area ${next.width} Γ— ${next.height} at ${next.x}, ${next.y}`;
- void refresh();
- });
-
- const capturing = document.createElement('fieldset');
- const legend = document.createElement('legend');
- legend.textContent = 'Capturing';
- capturing.append(legend);
-
- let current: CaptureSettings = settings;
- const save = async (patch: Partial<CaptureSettings>) => {
- current = await window.mimik.capture.settings.set(patch);
- style.disabled = !current.showCursor;
- };
-
- const cursorRow = document.createElement('label');
- const cursorToggle = document.createElement('input');
- cursorToggle.type = 'checkbox';
- cursorToggle.checked = current.showCursor;
- cursorToggle.addEventListener('change', () => save({ showCursor: cursorToggle.checked }));
- cursorRow.append(cursorToggle, document.createTextNode('Show the cursor in screenshots'));
-
- const styleRow = document.createElement('label');
- const style = document.createElement('select');
- for (const option of ['arrow', 'hand', 'dot'] as const) {
- const node = document.createElement('option');
- node.value = option;
- node.textContent = option;
- node.selected = current.cursorStyle === option;
- style.append(node);
- }
- style.disabled = !current.showCursor;
- style.addEventListener('change', () => save({ cursorStyle: style.value as CaptureSettings['cursorStyle'] }));
- styleRow.append(document.createTextNode('Pointer style'), style);
-
- const delayRow = document.createElement('label');
- const delay = document.createElement('input');
- delay.type = 'number';
- delay.min = '0';
- delay.max = '2000';
- delay.step = '50';
- delay.value = String(current.screenshotDelayMs);
- delay.addEventListener('change', async () => {
- await save({ screenshotDelayMs: Number(delay.value) });
- delay.value = String(current.screenshotDelayMs);
- });
- delayRow.append(document.createTextNode('Screenshot delay (ms)'), delay);
-
- const outsideRow = document.createElement('label');
- const outside = document.createElement('input');
- outside.type = 'checkbox';
- outside.checked = current.captureOutsideClicks;
- outside.addEventListener('change', () => save({ captureOutsideClicks: outside.checked }));
- outsideRow.append(outside, document.createTextNode('Capture clicks outside the capture area'));
-
- capturing.append(cursorRow, styleRow, delayRow, outsideRow);
-
- root.append(title, meta, label, area, edit, capturing, library, shared);
-}
-
-render();
diff --git a/apps/desktop/src/renderer/main.tsx b/apps/desktop/src/renderer/main.tsx
new file mode 100644
index 0000000..cace833
--- /dev/null
+++ b/apps/desktop/src/renderer/main.tsx
@@ -0,0 +1,7 @@
+import './core-env';
+import './ui-env';
+import { createRoot } from 'react-dom/client';
+import App from './App';
+import './styles.css';
+
+createRoot(document.getElementById('root') as HTMLElement).render(<App />);
diff --git a/apps/desktop/src/renderer/overlay.css b/apps/desktop/src/renderer/overlay.css
index 4d335b1..281d27f 100644
--- a/apps/desktop/src/renderer/overlay.css
+++ b/apps/desktop/src/renderer/overlay.css
@@ -201,3 +201,24 @@ button.primary {
background: var(--accent);
color: #fff;
}
+
+#counter {
+ margin-left: 4px;
+ font-variant-numeric: tabular-nums;
+ opacity: 0.7;
+}
+
+#step {
+ position: absolute;
+ left: 12px;
+ right: 12px;
+ bottom: -30px;
+ padding: 5px 10px;
+ border-radius: 8px;
+ background: var(--deep);
+ color: var(--lavender);
+ font-size: 11px;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
diff --git a/apps/desktop/src/renderer/overlay.ts b/apps/desktop/src/renderer/overlay.ts
index b0b0a42..3312fe1 100644
--- a/apps/desktop/src/renderer/overlay.ts
+++ b/apps/desktop/src/renderer/overlay.ts
@@ -1,5 +1,10 @@
import './overlay.css';
+interface LastStep {
+ index: number;
+ title: string;
+}
+
interface Region {
x: number;
y: number;
@@ -7,18 +12,6 @@ interface Region {
height: number;
}
-declare global {
- interface Window {
- mimikOverlay: {
- region(): Promise<Region>;
- state(): Promise<string>;
- setRegion(region: Region): void;
- command(command: string): void;
- onUpdate(handler: (state: string, region: Region) => void): void;
- };
- }
-}
-
const MIN = { width: 240, height: 160 };
const HANDLES = ['nw', 'n', 'ne', 'e', 'se', 's', 'sw', 'w'] as const;
type Handle = (typeof HANDLES)[number];
@@ -155,14 +148,25 @@ function controls(): void {
document.body.className = 'controls';
const dot = el('div', { id: 'dot' });
const label = el('span', {}, 'Ready');
- const status = el('div', { id: 'status' }, dot, label);
+ const counter = el('span', { id: 'counter' });
+ const status = el('div', { id: 'status' }, dot, label, counter);
+ const step = el('div', { id: 'step' });
+ document.body.append(step);
const primary = el('button', { className: 'primary' });
const secondary = el('button', {});
const close = el('button', {}, 'Stop');
document.body.append(status, secondary, primary, close);
- const render = (state: string) => {
+ const render = (state: string, _region?: Region, last?: LastStep | null) => {
document.body.setAttribute('data-state', state);
+ if (last) {
+ counter.textContent = `#${last.index}`;
+ step.textContent = last.title;
+ step.hidden = false;
+ } else {
+ counter.textContent = '';
+ step.hidden = true;
+ }
label.textContent = state === 'recording' ? 'Recording' : state === 'paused' ? 'Paused' : 'Ready';
primary.textContent = state === 'recording' ? 'Pause' : state === 'paused' ? 'Resume' : 'Start';
primary.dataset.command = state === 'recording' ? 'pause' : state === 'paused' ? 'resume' : 'start';
@@ -176,7 +180,9 @@ function controls(): void {
secondary.addEventListener('click', () => window.mimikOverlay.command('edit'));
close.addEventListener('click', () => window.mimikOverlay.command(close.dataset.command ?? 'stop'));
- window.mimikOverlay.state().then(render);
+ Promise.all([window.mimikOverlay.state(), window.mimikOverlay.last()]).then(([state, last]) =>
+ render(state, undefined, last),
+ );
window.mimikOverlay.onUpdate(render);
}
diff --git a/apps/desktop/src/renderer/styles.css b/apps/desktop/src/renderer/styles.css
new file mode 100644
index 0000000..d5e3105
--- /dev/null
+++ b/apps/desktop/src/renderer/styles.css
@@ -0,0 +1,4 @@
+@import "@mimik/ui/global.css";
+
+@source "../../../../packages/ui/src";
+@source ".";
diff --git a/apps/desktop/src/renderer/ui-env.ts b/apps/desktop/src/renderer/ui-env.ts
new file mode 100644
index 0000000..8b29545
--- /dev/null
+++ b/apps/desktop/src/renderer/ui-env.ts
@@ -0,0 +1,23 @@
+import { configureUi } from '@mimik/ui/env';
+
+const unsupported = async (): Promise<never> => {
+ throw new Error('this action needs the browser extension');
+};
+
+configureUi({
+ tabs: {
+ active: async () => null,
+ get: async () => null,
+ query: async () => [],
+ create: async () => null,
+ update: async () => null,
+ focusWindow: async () => undefined,
+ recordable: async () => [],
+ startInsertRecording: unsupported,
+ },
+ panel: {
+ open: () => undefined,
+ requestHostPermissions: async () => false,
+ },
+ send: unsupported,
+});
diff --git a/apps/desktop/src/yaml.d.ts b/apps/desktop/src/yaml.d.ts
new file mode 100644
index 0000000..c464a9b
--- /dev/null
+++ b/apps/desktop/src/yaml.d.ts
@@ -0,0 +1,4 @@
+declare module '*.yml' {
+ const messages: Record<string, unknown>;
+ export default messages;
+}
diff --git a/apps/desktop/tsconfig.json b/apps/desktop/tsconfig.json
index af8cc18..2c2a8cb 100644
--- a/apps/desktop/tsconfig.json
+++ b/apps/desktop/tsconfig.json
@@ -23,8 +23,12 @@
],
"@/core/*": [
"../../packages/core/src/*"
+ ],
+ "@mimik/ui/*": [
+ "../../packages/ui/src/*"
]
- }
+ },
+ "jsx": "react-jsx"
},
"include": [
"src/**/*",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index f92ac3c..2ed92df 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -22,6 +22,9 @@ importers:
'@fontsource/poppins':
specifier: ^5.2.7
version: 5.2.7
+ '@mimik/ui':
+ specifier: workspace:*
+ version: link:packages/ui
'@tailwindcss/vite':
specifier: ^4.2.2
@@ -152,6 +155,9 @@ importers:
'@mimik/core':
specifier: workspace:*
version: link:../../packages/core
+ '@mimik/ui':
+ specifier: workspace:*
+ version: link:../../packages/ui
dexie:
specifier: ^4.3.0
version: 4.4.1
@@ -161,10 +167,25 @@ importers:
get-windows:
specifier: ^9.3.0
version: 9.3.0([email protected])
+ react:
+ specifier: ^19.2.4
+ version: 19.2.4
+ react-dom:
+ specifier: ^19.2.4
+ version: 19.2.4([email protected])
uiohook-napi:
specifier: ^1.5.5
version: 1.5.5
devDependencies:
+ '@tailwindcss/vite':
+ specifier: ^4.2.2
+ '@types/js-yaml':
+ specifier: ^4.0.9
+ version: 4.0.9
+ '@vitejs/plugin-react':
+ specifier: ^4.3.4
electron:
specifier: ^33.2.1
version: 33.4.11
@@ -174,12 +195,20 @@ importers:
electron-vite:
specifier: ^2.3.0
+ js-yaml:
+ specifier: ^4.1.0
+ version: 4.3.2
+ tailwindcss:
+ specifier: ^4.2.2
+ version: 4.2.2
vite:
specifier: ^6.0.3
packages/core: {}
+ packages/ui: {}
+
packages:
@@ -305,6 +334,18 @@ packages:
peerDependencies:
'@babel/core': ^7.0.0-0
+ '@babel/[email protected]':
+ resolution: {integrity: sha512-TL0hMc9xzy86VD31nUiwzd5otRAcyEPcsegCxolO0PvcXuH1v0kECe/UIznYFihpkvU5wg/jk4v0TTEFfm53fw==}
+ engines: {node: '>=6.9.0'}
+ peerDependencies:
+ '@babel/core': ^7.0.0-0
+
+ '@babel/[email protected]':
+ resolution: {integrity: sha512-06IyK09H3wi4cGbhDBwp5gUGo0IKtnYa8tyTiephirPCK6fbobVGiXMMI5zLQ4aKEYP3wZ3ArU44o+8KMrSG/Q==}
+ engines: {node: '>=6.9.0'}
+ peerDependencies:
+ '@babel/core': ^7.0.0-0
+
resolution: {integrity: sha512-KHp2IflsnGywDjBWDkR9iEqiWSpc8GIi0lgTT3mOElT0PP1tG26P4tmFI2YvAdzgq9RGyoHZQEIEdZy6Ec5xCA==}
engines: {node: '>=6.9.0'}
@@ -1842,6 +1883,9 @@ packages:
cpu: [x64]
os: [win32]
+ '@rolldown/[email protected]':
+ resolution: {integrity: sha512-+d0F4MKMCbeVUJwG96uQ4SgAznZNSq93I3V+9NHA4OpvqG8mRCpGdKmK8l/dl02h2CCDHwW2FqilnTyDcAnqjA==}
+
'@rolldown/[email protected]':
resolution: {integrity: sha512-HHMwmarRKvoFsJorqYlFeFRzXZqCt2ETQlEDOb9aqssrnVBB1/+xgTGtuTrIk5vzLNX1MjMtTf7W9z3tsSbrxw==}
@@ -2124,6 +2168,18 @@ packages:
resolution: {integrity: sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==}
+ '@types/[email protected]':
+ resolution: {integrity: sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==}
+
+ '@types/[email protected]':
+ resolution: {integrity: sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg==}
+
+ '@types/[email protected]':
+ resolution: {integrity: sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==}
+
+ '@types/[email protected]':
+ resolution: {integrity: sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q==}
+
resolution: {integrity: sha512-IQ3EbTzGxIigb1I3qPZc1rWJnH0BmSKv5QYTalEwweFvyBDLSAe24zP0le/hyi7ecGfZVlIVAg4BZqb8WBwKqw==}
@@ -2163,6 +2219,9 @@ packages:
resolution: {integrity: sha512-L3LgimLHXtGkWikKnsPg0/VFx9OGZaC+eN1u4r+OB1XRqH3meBIAVC2zr1WdMH+RHmnRkqliQAOHNJ/E0j/e0Q==}
+ '@types/[email protected]':
+ resolution: {integrity: sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==}
+
resolution: {integrity: sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg==}
@@ -2224,6 +2283,12 @@ packages:
'@types/react': ^18.0.0 || ^19.0.0
react: ^18.0.0 || ^19.0.0
+ '@vitejs/[email protected]':
+ resolution: {integrity: sha512-gUu9hwfWvvEDBBmgtAowQCojwZmJ5mcLn3aufeCsitijs3+f2NsrPtlAWIR6OPiqljl96GVCUbLe0HyqIpVaoA==}
+ engines: {node: ^14.18.0 || >=16.0.0}
+ peerDependencies:
+ vite: ^4.2.0 || ^5.0.0 || ^6.0.0 || ^7.0.0
+
'@vitejs/[email protected]':
resolution: {integrity: sha512-l9X/E3cDb+xY3SWzlG1MOGt2usfEHGMNIaegaUGFsLkb3RCn/k8/TOXBcab+OndDI4TBtktT8/9BwwW8Vi9KUQ==}
engines: {node: ^20.19.0 || >=22.12.0}
@@ -4504,6 +4569,10 @@ packages:
resolution: {integrity: sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==}
+ resolution: {integrity: sha512-z6F7K9bV85EfseRCp2bzrpyQ0Gkw1uLoCel9XBVWPg/TjRj94SkJzUTGfOa4bs7iJvBWtQG0Wq7wnI0syw3EBQ==}
+ engines: {node: '>=0.10.0'}
+
resolution: {integrity: sha512-9r+yi9+mgU33AKcj6IbT9oRCO78WriSj6t/cF8DWBZJ9aOGPOTEDvdUDz1FwKim7QXWwmHqtdHnRJfhAxEG46Q==}
engines: {node: '>=10'}
@@ -5603,6 +5672,16 @@ snapshots:
'@babel/core': 7.29.0
'@babel/helper-plugin-utils': 7.29.7
+ dependencies:
+ '@babel/core': 7.29.0
+ '@babel/helper-plugin-utils': 7.29.7
+
+ dependencies:
+ '@babel/core': 7.29.0
+ '@babel/helper-plugin-utils': 7.29.7
+
'@babel/[email protected]': {}
'@babel/[email protected]': {}
@@ -6971,6 +7050,8 @@ snapshots:
'@rolldown/[email protected]':
optional: true
+ '@rolldown/[email protected]': {}
+
'@rolldown/[email protected]': {}
'@rolldown/[email protected]': {}
@@ -7119,6 +7200,13 @@ snapshots:
'@tailwindcss/oxide-win32-arm64-msvc': 4.2.2
'@tailwindcss/oxide-win32-x64-msvc': 4.2.2
+ dependencies:
+ '@tailwindcss/node': 4.2.2
+ '@tailwindcss/oxide': 4.2.2
+ tailwindcss: 4.2.2
+
dependencies:
'@tailwindcss/node': 4.2.2
@@ -7165,6 +7253,27 @@ snapshots:
'@types/[email protected]': {}
+ '@types/[email protected]':
+ dependencies:
+ '@babel/parser': 7.29.2
+ '@babel/types': 7.29.0
+ '@types/babel__generator': 7.27.0
+ '@types/babel__template': 7.4.4
+ '@types/babel__traverse': 7.28.0
+
+ '@types/[email protected]':
+ dependencies:
+ '@babel/types': 7.29.0
+
+ '@types/[email protected]':
+ dependencies:
+ '@babel/parser': 7.29.2
+ '@babel/types': 7.29.0
+
+ '@types/[email protected]':
+ dependencies:
+ '@babel/types': 7.29.0
+
dependencies:
'@types/http-cache-semantics': 4.2.0
@@ -7207,6 +7316,8 @@ snapshots:
'@types/[email protected]': {}
+ '@types/[email protected]': {}
+
dependencies:
'@types/node': 25.5.0
@@ -7272,6 +7383,18 @@ snapshots:
media-captions: 1.0.4
react: 19.2.4
+ dependencies:
+ '@babel/core': 7.29.0
+ '@babel/plugin-transform-react-jsx-self': 7.29.7(@babel/[email protected])
+ '@babel/plugin-transform-react-jsx-source': 7.29.7(@babel/[email protected])
+ '@rolldown/pluginutils': 1.0.0-beta.27
+ '@types/babel__core': 7.20.5
+ react-refresh: 0.17.0
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
'@rolldown/pluginutils': 1.0.0-rc.7
@@ -9894,6 +10017,8 @@ snapshots:
+
dependencies:
react: 19.2.4