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): show a loading screen while the app starts

Luis Ortizbb8a79f4c4ee
diff --git a/apps/desktop/electron.vite.config.ts b/apps/desktop/electron.vite.config.ts
index 31c3639..8a3c2bc 100644
--- a/apps/desktop/electron.vite.config.ts
+++ b/apps/desktop/electron.vite.config.ts
@@ -68,6 +68,7 @@ export default defineConfig({
index: resolve(__dirname, 'src/renderer/index.html'),
'check-storage': resolve(__dirname, 'src/renderer/check-storage.html'),
overlay: resolve(__dirname, 'src/renderer/overlay.html'),
+ splash: resolve(__dirname, 'src/renderer/splash.html'),
'check-pipeline': resolve(__dirname, 'src/renderer/check-pipeline.html'),
},
},
diff --git a/apps/desktop/scripts/check-overlay.ts b/apps/desktop/scripts/check-overlay.ts
index e6bb5a0..faf7701 100644
--- a/apps/desktop/scripts/check-overlay.ts
+++ b/apps/desktop/scripts/check-overlay.ts
@@ -1,3 +1,4 @@
+import { join } from 'node:path';
import { app, BrowserWindow, globalShortcut, screen, webContents } from 'electron';
import { clampToDisplays, defaultRegion, loadRegion, type Region, saveRegion } from '../src/main/capture/region';
import type { CaptureMode } from '../src/main/capture/settings';
@@ -386,6 +387,22 @@ app.whenReady().then(async () => {
overlay.destroy();
saveRegion(defaultRegion());
+ const splash = new BrowserWindow({ width: 400, height: 300, show: false, frame: false });
+ await splash.loadFile(join(__dirname, '../renderer/splash.html'));
+ const splashed = JSON.parse(
+ String(
+ await splash.webContents.executeJavaScript(
+ "JSON.stringify({ word: document.querySelector('#wordmark')?.textContent, paths: document.querySelectorAll('#mascot svg path').length, meter: Boolean(document.querySelector('#meter span')) })",
+ ),
+ ),
+ ) as { word?: string; paths?: number; meter?: boolean };
+ splash.destroy();
+ check(
+ 'the loading screen draws the mascot, the name and the bar',
+ splashed.word === 'Mimik' && (splashed.paths ?? 0) >= 5 && splashed.meter === true,
+ `wordmark ${splashed.word}, ${splashed.paths} mascot paths, bar ${splashed.meter}`,
+ );
+
for (const result of results) {
process.stdout.write(`${result.ok ? 'ok ' : 'FAIL'} ${result.name.padEnd(32)} ${result.detail}\n`);
}
diff --git a/apps/desktop/src/main/index.ts b/apps/desktop/src/main/index.ts
index 1f0b5f7..3e45736 100644
--- a/apps/desktop/src/main/index.ts
+++ b/apps/desktop/src/main/index.ts
@@ -72,6 +72,55 @@ function showWindow(): void {
mainWindow.focus();
}
+const SPLASH_MIN_MS = 1500;
+const SPLASH_MAX_WAIT_MS = 3000;
+let splash: BrowserWindow | null = null;
+let splashShownAt: number | null = null;
+
+function openSplash(): void {
+ splash = new BrowserWindow({
+ width: 400,
+ height: 300,
+ frame: false,
+ transparent: true,
+ resizable: false,
+ movable: false,
+ skipTaskbar: true,
+ alwaysOnTop: true,
+ show: false,
+ center: true,
+ });
+ splash.once('ready-to-show', () => {
+ splash?.show();
+ splashShownAt = Date.now();
+ });
+ splash.on('closed', () => {
+ splash = null;
+ });
+ if (process.env.ELECTRON_RENDERER_URL) splash.loadURL(`${process.env.ELECTRON_RENDERER_URL}/splash.html`);
+ else splash.loadFile(join(__dirname, '../renderer/splash.html'));
+}
+
+function closeSplash(then: () => void): void {
+ const close = () => {
+ if (splash && !splash.isDestroyed()) splash.close();
+ then();
+ };
+ if (!splash || splash.isDestroyed()) {
+ then();
+ return;
+ }
+ if (splashShownAt === null) {
+ const giveUp = setTimeout(close, SPLASH_MAX_WAIT_MS);
+ splash.once('show', () => {
+ clearTimeout(giveUp);
+ setTimeout(close, SPLASH_MIN_MS);
+ });
+ return;
+ }
+ setTimeout(close, Math.max(0, SPLASH_MIN_MS - (Date.now() - splashShownAt)));
+}
+
function createWindow(): void {
mainWindow = new BrowserWindow({
width: 1100,
@@ -90,7 +139,9 @@ function createWindow(): void {
});
mainWindow.once('ready-to-show', () => {
- if (!app.getLoginItemSettings().wasOpenedAsHidden) mainWindow?.show();
+ closeSplash(() => {
+ if (!app.getLoginItemSettings().wasOpenedAsHidden) mainWindow?.show();
+ });
});
mainWindow.on('close', (event) => {
@@ -247,6 +298,7 @@ if (!app.requestSingleInstanceLock()) {
app.on('second-instance', () => showWindow());
app.whenReady().then(() => {
+ if (!app.getLoginItemSettings().wasOpenedAsHidden) openSplash();
registerScreenshotProtocol();
registerAiFetch();
ipcMain.handle('mimik:openAtLogin:get', () => opensAtLogin());
diff --git a/apps/desktop/src/renderer/overlay/camera-mascot.ts b/apps/desktop/src/renderer/overlay/camera-mascot.ts
index 98d484e..9edb217 100644
--- a/apps/desktop/src/renderer/overlay/camera-mascot.ts
+++ b/apps/desktop/src/renderer/overlay/camera-mascot.ts
@@ -6,7 +6,7 @@ import {
MASCOT_CROWN,
MASCOT_FACES,
MASCOT_SEAM,
-} from '@mimik/ui';
+} from '@mimik/ui/common/lib/mascot-shapes';
import { svg } from './svg';
export function cameraMascot(size: number): SVGSVGElement {
diff --git a/apps/desktop/src/renderer/overlay/mascot.ts b/apps/desktop/src/renderer/overlay/mascot.ts
index 155890c..5a63c76 100644
--- a/apps/desktop/src/renderer/overlay/mascot.ts
+++ b/apps/desktop/src/renderer/overlay/mascot.ts
@@ -6,7 +6,7 @@ import {
MASCOT_FACES,
MASCOT_SEAM,
MASCOT_VIEW_BOX,
-} from '@mimik/ui';
+} from '@mimik/ui/common/lib/mascot-shapes';
import { svg } from './svg';
export function mascot(size = 42): SVGSVGElement {
diff --git a/apps/desktop/src/renderer/splash.css b/apps/desktop/src/renderer/splash.css
new file mode 100644
index 0000000..f9f27f8
--- /dev/null
+++ b/apps/desktop/src/renderer/splash.css
@@ -0,0 +1,93 @@
+@import '@fontsource/poppins/700.css';
+
+:root {
+ --accent: #4f46e5;
+ --deep: #1e1b4b;
+ --lavender: #c7d2fe;
+ --violet-mid: #3730a3;
+}
+
+html,
+body {
+ margin: 0;
+ height: 100%;
+ background: transparent;
+ overflow: hidden;
+ user-select: none;
+}
+
+#splash {
+ box-sizing: border-box;
+ height: 100%;
+ display: flex;
+ flex-direction: column;
+ align-items: center;
+ justify-content: center;
+ gap: 14px;
+ border: 1px solid var(--lavender);
+ border-radius: 14px;
+ background: #f5f6fb;
+ font-family: 'Poppins', system-ui, sans-serif;
+}
+
+#mascot {
+ display: flex;
+}
+
+#mascot path:nth-of-type(4) {
+ transform-box: fill-box;
+ transform-origin: center;
+ animation: wink 3.2s ease infinite;
+}
+
+#wordmark {
+ margin: 0;
+ font-size: 22px;
+ font-weight: 700;
+ letter-spacing: -0.01em;
+ color: var(--deep);
+}
+
+#meter {
+ position: relative;
+ width: 140px;
+ height: 3px;
+ border-radius: 3px;
+ background: var(--lavender);
+ overflow: hidden;
+}
+
+#meter span {
+ position: absolute;
+ top: 0;
+ left: 0;
+ width: 40%;
+ height: 3px;
+ border-radius: 3px;
+ background: var(--accent);
+ animation: sweep 1.6s ease-in-out infinite;
+}
+
+@keyframes wink {
+ 0%,
+ 70% {
+ transform: scaleY(1);
+ }
+ 74%,
+ 76% {
+ transform: scaleY(0.05);
+ }
+ 80%,
+ 100% {
+ transform: scaleY(1);
+ }
+}
+
+@keyframes sweep {
+ 0% {
+ transform: translateX(-100%);
+ }
+ 100% {
+ transform: translateX(250%);
+ }
+}
diff --git a/apps/desktop/src/renderer/splash.html b/apps/desktop/src/renderer/splash.html
new file mode 100644
index 0000000..3745c46
--- /dev/null
+++ b/apps/desktop/src/renderer/splash.html
@@ -0,0 +1,10 @@
+<!doctype html>
+<html lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <title>Mimik</title>
+ </head>
+ <body>
+ <script type="module" src="./splash.ts"></script>
+ </body>
+</html>
diff --git a/apps/desktop/src/renderer/splash.ts b/apps/desktop/src/renderer/splash.ts
new file mode 100644
index 0000000..9366cac
--- /dev/null
+++ b/apps/desktop/src/renderer/splash.ts
@@ -0,0 +1,13 @@
+import './splash.css';
+import { el } from './overlay/el';
+import { mascot } from './overlay/mascot';
+
+document.body.append(
+ el(
+ 'main',
+ { id: 'splash' },
+ el('div', { id: 'mascot' }, mascot(116)),
+ el('p', { id: 'wordmark' }, 'Mimik'),
+ el('div', { id: 'meter', role: 'progressbar', ariaLabel: 'Loading' }, el('span', {})),
+ ),
+);
diff --git a/biome.json b/biome.json
index 2d6bea2..806d263 100644
--- a/biome.json
+++ b/biome.json
@@ -104,7 +104,12 @@
"options": {
"patterns": [
{
- "group": ["@mimik/ui/**", "!@mimik/ui/env", "!@mimik/ui/global.css"],
+ "group": [
+ "@mimik/ui/**",
+ "!@mimik/ui/env",
+ "!@mimik/ui/global.css",
+ "!@mimik/ui/common/lib/mascot-shapes"
+ ],
"message": "Import from '@mimik/ui'. Add the export to packages/ui/src/index.ts if it is missing."
}
]