π¬ A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots π
TypeScript browser-extensionchrome-extensiondocumentationfirefox-extensionguide-generatorlocal-firstmanifest-v3privacy-firstproductivityreactscreenshotstep-by-step-guidetutorialtypescriptworkflowwxt
feat(desktop): open the app on a home screen and pick the mode before recording
Luis Ortiz5a727fa99bb9
diff --git a/apps/desktop/src/renderer/App.tsx b/apps/desktop/src/renderer/App.tsxindex e28d35b..280e820 100644--- a/apps/desktop/src/renderer/App.tsx+++ b/apps/desktop/src/renderer/App.tsx@@ -1,13 +1,15 @@-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 GuideContent from '@mimik/ui/fullview/GuideContent';+import { useEffect, useState } from 'react';+import CaptureSheet from './CaptureSheet';+import HomeScreen from './HomeScreen';import SettingsPanel from './SettingsPanel';import TopBar from './TopBar';export default function App() {const [guideId, setGuideId] = useState<string | null>(null);const [settingsOpen, setSettingsOpen] = useState(false);+ const [sheetOpen, setSheetOpen] = useState(false);useEffect(() => {const onHash = () => {@@ -23,6 +25,7 @@ export default function App() {window.mimik.capture.onCommand((command, _state, _region, id) => {if (command === 'stop' && id) {setSettingsOpen(false);+ setSheetOpen(false);window.location.hash = `#guide/${id}`;}});@@ -43,10 +46,14 @@ export default function App() {</div></main>) : (- <main className="flex-1 p-8 max-w-6xl mx-auto w-full">- <LibraryContent category="all" />- </main>+ <HomeScreen+ onOpen={(id) => {+ window.location.hash = `#guide/${id}`;+ }}+ onStart={() => setSheetOpen(true)}+ />)}+ {sheetOpen && <CaptureSheet onClose={() => setSheetOpen(false)} />}</div></TooltipProvider>);diff --git a/apps/desktop/src/renderer/CaptureSheet.tsx b/apps/desktop/src/renderer/CaptureSheet.tsxnew file mode 100644index 0000000..e08d99e--- /dev/null+++ b/apps/desktop/src/renderer/CaptureSheet.tsx@@ -0,0 +1,108 @@+import { i18n } from '@mimik/core/env';+import { Button } from '@mimik/ui/components/ui/button';+import { AppWindow, Crop, Monitor, Video, X } from 'lucide-react';+import { useEffect, useState } from 'react';+import type { CaptureSettings } from '../main/capture/settings';++type Mode = CaptureSettings['captureMode'];++const MODES: { id: Mode; label: string; Icon: typeof AppWindow }[] = [+ { id: 'window', label: 'desktop_modeWindow', Icon: AppWindow },+ { id: 'screen', label: 'desktop_modeScreen', Icon: Monitor },+ { id: 'region', label: 'desktop_modeRegion', Icon: Crop },+];++export default function CaptureSheet({ 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));+ };++ const start = async () => {+ onClose();+ if (settings?.captureMode === 'region') await window.mimik.capture.edit();+ else await window.mimik.capture.arm();+ };++ return (+ <div className="fixed inset-0 z-50 flex justify-end">+ <button+ type="button"+ aria-label={i18n.t('common_close')}+ onClick={onClose}+ className="absolute inset-0 bg-deep/40"+ />++ <aside className="relative flex h-full w-[416px] flex-col border-l border-border bg-card shadow-2xl">+ <div className="flex items-center border-b border-secondary px-6 pb-4 pt-5">+ <h2 className="mr-auto text-base font-semibold text-foreground">{i18n.t('desktop_startSheetTitle')}</h2>+ <button+ type="button"+ aria-label={i18n.t('common_close')}+ onClick={onClose}+ className="rounded-lg p-1.5 text-muted-foreground transition-colors hover:bg-secondary hover:text-foreground"+ >+ <X size={17} />+ </button>+ </div>++ <div className="flex flex-1 flex-col gap-5 px-6 py-5">+ <div>+ <p className="mb-2.5 text-[10.5px] font-semibold uppercase tracking-[0.1em] text-muted-foreground">+ {i18n.t('desktop_captureMode')}+ </p>+ <div className="flex flex-col gap-2">+ {MODES.map(({ id, label, Icon }) => {+ const active = settings?.captureMode === id;+ return (+ <button+ key={id}+ type="button"+ aria-pressed={active}+ onClick={() => save({ captureMode: id })}+ className={`flex w-full items-center gap-3.5 rounded-xl bg-clip-padding text-left transition-colors ${+ active+ ? 'border-2 border-accent bg-secondary px-[13px] py-3'+ : 'border border-border bg-card px-[14px] py-[13px] hover:border-accent'+ }`}+ >+ <span+ className={`flex size-[34px] shrink-0 items-center justify-center rounded-[10px] ${+ active ? 'bg-primary text-primary-foreground' : 'bg-secondary text-muted-foreground'+ }`}+ >+ <Icon size={17} />+ </span>+ <span className="min-w-0 flex-1 text-sm font-semibold text-foreground">{i18n.t(label)}</span>+ <span+ className={`flex size-5 shrink-0 items-center justify-center rounded-full border-2 ${+ active ? 'border-accent' : 'border-border'+ }`}+ >+ {active && <span className="size-2.5 rounded-full bg-accent" />}+ </span>+ </button>+ );+ })}+ </div>+ </div>+ </div>++ <div className="flex gap-2.5 border-t border-secondary px-6 pb-5 pt-4">+ <Button variant="outline" className="flex-1" onClick={onClose}>+ {i18n.t('common_cancel')}+ </Button>+ <Button className="flex-[1.6]" disabled={!settings} onClick={start}>+ <Video size={17} />+ {i18n.t('desktop_startButton')}+ </Button>+ </div>+ </aside>+ </div>+ );+}diff --git a/apps/desktop/src/renderer/HomeScreen.tsx b/apps/desktop/src/renderer/HomeScreen.tsxnew file mode 100644index 0000000..916088a--- /dev/null+++ b/apps/desktop/src/renderer/HomeScreen.tsx@@ -0,0 +1,151 @@+import { i18n } from '@mimik/core/env';+import {+ type GuideChangeEvent,+ getGuides,+ onGuidesChanged,+ softDeleteGuide,+ toggleStar,+} from '@mimik/core/guides/service';+import type { Guide } from '@mimik/core/guides/types';+import { Button } from '@mimik/ui/components/ui/button';+import { Input } from '@mimik/ui/components/ui/input';+import { formatRelativeTime, getDomainInitial } from '@mimik/ui/lib/utils';+import MascotIcon from '@mimik/ui/shared/MascotIcon';+import { Search, Star, Trash2, Video } from 'lucide-react';+import { useCallback, useEffect, useState } from 'react';++export default function HomeScreen({ onOpen, onStart }: { onOpen(guideId: string): void; onStart(): void }) {+ const [guides, setGuides] = useState<Guide[]>([]);+ const [query, setQuery] = useState('');++ const load = useCallback(async () => {+ setGuides(await getGuides());+ }, []);++ useEffect(() => {+ load();+ }, [load]);++ useEffect(+ () =>+ onGuidesChanged((event: GuideChangeEvent) => {+ if (event.type === 'starred') {+ setGuides((prev) => prev.map((g) => (g.id === event.id ? { ...g, starred: event.starred } : g)));+ } else {+ load();+ }+ }),+ [load],+ );++ const star = async (event: React.MouseEvent, id: string) => {+ event.stopPropagation();+ setGuides((prev) => prev.map((g) => (g.id === id ? { ...g, starred: !g.starred } : g)));+ await toggleStar(id);+ };++ const trash = async (event: React.MouseEvent, id: string) => {+ event.stopPropagation();+ await softDeleteGuide(id);+ await load();+ };++ const filtered = query ? guides.filter((g) => g.title.toLowerCase().includes(query.toLowerCase())) : guides;++ return (+ <div className="flex flex-1 flex-col">+ <section className="flex flex-col items-center gap-3.5 border-b border-border bg-secondary px-7 py-9">+ <MascotIcon size={68} />+ <div className="text-center">+ <h1 className="text-[22px] font-semibold text-foreground">{i18n.t('sidepanel_heroTitle')}</h1>+ <p className="mt-1 text-[13px] text-muted-foreground">{i18n.t('sidepanel_heroSubtitle')}</p>+ </div>+ <Button size="lg" className="mt-1 h-auto rounded-xl px-8 py-3.5 text-[15px] font-semibold" onClick={onStart}>+ <Video size={19} />+ {i18n.t('sidepanel_startCapture')}+ </Button>+ </section>++ <div className="flex flex-1 flex-col gap-4 px-10 pb-7 pt-6">+ <div className="flex items-center gap-3.5">+ <div className="relative w-[340px]">+ <Search size={16} className="absolute left-3.5 top-1/2 -translate-y-1/2 text-accent" />+ <Input+ type="search"+ aria-label={i18n.t('sidepanel_searchPlaceholder')}+ placeholder={i18n.t('sidepanel_searchPlaceholder')}+ value={query}+ onChange={(e) => setQuery(e.target.value)}+ className="rounded-xl pl-10 !text-[13px]"+ />+ </div>+ <p className="text-[11px] font-semibold uppercase tracking-[0.08em] text-muted-foreground">+ {i18n.t('sidepanel_recentLabel')} ·{' '}+ {filtered.length === 1+ ? i18n.t('desktop_guideCount', [String(filtered.length)])+ : i18n.t('desktop_guideCountPlural', [String(filtered.length)])}+ </p>+ </div>++ {filtered.length === 0 ? (+ <p className="py-10 text-center text-sm text-muted-foreground">+ {query ? i18n.t('library_noMatchingGuides') : i18n.t('library_noGuidesSub')}+ </p>+ ) : (+ <div className="grid grid-cols-2 gap-3">+ {filtered.map((guide) => {+ const { letter, gradient } = getDomainInitial(guide.title || '?');+ return (+ <div+ key={guide.id}+ className="flex items-center gap-3.5 rounded-[13px] border border-border bg-card px-4 py-3.5 transition-colors focus-within:border-accent hover:border-accent"+ >+ <button+ type="button"+ onClick={() => onOpen(guide.id)}+ className="flex min-w-0 flex-1 items-center gap-3.5 text-left"+ >+ <span+ className="flex size-[34px] shrink-0 items-center justify-center rounded-[10px] text-sm font-semibold text-white"+ style={{ background: `linear-gradient(135deg, ${gradient[0]}, ${gradient[1]})` }}+ aria-hidden="true"+ >+ {letter}+ </span>+ <span className="min-w-0 flex-1">+ <span className="block truncate text-[13.5px] font-semibold text-foreground">{guide.title}</span>+ <span className="mt-1 flex items-center gap-2">+ <span className="text-[11px] text-muted-foreground">{formatRelativeTime(guide.updatedAt)}</span>+ <span className="rounded-full bg-secondary px-2 py-0.5 text-[10px] font-semibold leading-none text-accent">+ {guide.stepIds.length !== 1+ ? i18n.t('fullview_stepCountPlural', [String(guide.stepIds.length)])+ : i18n.t('fullview_stepCount', [String(guide.stepIds.length)])}+ </span>+ </span>+ </span>+ </button>+ <button+ type="button"+ aria-label={guide.starred ? i18n.t('common_unstar') : i18n.t('common_star')}+ onClick={(e) => star(e, guide.id)}+ className={`rounded-lg p-1.5 transition-colors hover:text-accent ${guide.starred ? 'text-accent' : 'text-border'}`}+ >+ <Star size={15} fill={guide.starred ? 'currentColor' : 'none'} />+ </button>+ <button+ type="button"+ aria-label={i18n.t('library_moveToTrash')}+ onClick={(e) => trash(e, guide.id)}+ className="rounded-lg p-1.5 text-border transition-colors hover:text-destructive"+ >+ <Trash2 size={15} />+ </button>+ </div>+ );+ })}+ </div>+ )}+ </div>+ </div>+ );+}diff --git a/apps/desktop/src/renderer/TopBar.tsx b/apps/desktop/src/renderer/TopBar.tsxindex ef706d1..51e5479 100644--- a/apps/desktop/src/renderer/TopBar.tsx+++ b/apps/desktop/src/renderer/TopBar.tsx@@ -1,26 +1,24 @@-import { Circle, Crop, Settings } from 'lucide-react';import { i18n } from '@mimik/core/env';-import { Button } from '@mimik/ui/components/ui/button';+import { Settings } from 'lucide-react';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>+ <header className="flex items-center gap-3.5 border-b border-border bg-card px-7 py-3">+ <span className="mr-auto text-[17px] font-semibold tracking-tight 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>+ <span className="flex items-center gap-1.5 text-xs font-medium text-muted-foreground">+ <span className="size-[7px] rounded-full bg-success" aria-hidden="true" />+ {i18n.t('desktop_readyToRecord')}+ </span>- <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>+ <button+ type="button"+ aria-label={i18n.t('settings_title')}+ onClick={onSettings}+ className="flex size-[34px] items-center justify-center rounded-[9px] text-muted-foreground transition-colors hover:bg-secondary hover:text-accent"+ >+ <Settings size={17} />+ </button></header>);}