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(sidepanel): add edit mode and link version history to full view

Luis Ortizb14798e12cc6
diff --git a/src/ui/fullview/App.tsx b/src/ui/fullview/App.tsx
index 7fe8e27..e6df69d 100644
--- a/src/ui/fullview/App.tsx
+++ b/src/ui/fullview/App.tsx
@@ -38,7 +38,12 @@ export default function FullViewApp() {
{route.page === 'guide' && (
<main className="flex-1 py-10 px-6">
<div className={`mx-auto ${historyOpen ? 'max-w-[1032px]' : 'max-w-[720px]'}`}>
- <GuideContent guideId={route.guideId} initialStepId={route.stepId} initialTool={route.tool} />
+ <GuideContent
+ guideId={route.guideId}
+ initialStepId={route.stepId}
+ initialTool={route.tool}
+ initialHistory={route.history}
+ />
</div>
</main>
)}
diff --git a/src/ui/fullview/GuideContent.tsx b/src/ui/fullview/GuideContent.tsx
index b2f60ad..3dac5f8 100644
--- a/src/ui/fullview/GuideContent.tsx
+++ b/src/ui/fullview/GuideContent.tsx
@@ -26,6 +26,7 @@ interface GuideContentProps {
guideId: string;
initialStepId?: string;
initialTool?: 'annotate' | 'redact' | 'crop' | 'target';
+ initialHistory?: boolean;
}
interface GuideData {
@@ -55,7 +56,7 @@ async function buildPreview(snapshot: Snapshot): Promise<PreviewData> {
return { snapshotId: snapshot.id, steps, screenshots };
}
-export default function GuideContent({ guideId, initialStepId, initialTool }: GuideContentProps) {
+export default function GuideContent({ guideId, initialStepId, initialTool, initialHistory }: GuideContentProps) {
const {
setGuideTitle,
setGuideStepCount,
@@ -86,6 +87,7 @@ export default function GuideContent({ guideId, initialStepId, initialTool }: Gu
const [previewData, setPreviewData] = useState<PreviewData | null>(null);
const titleRef = useRef('');
const appliedInitialRef = useRef(false);
+ const appliedHistoryRef = useRef(false);
const loadGuide = useCallback(async () => {
const result = await getGuide(guideId);
@@ -195,6 +197,12 @@ export default function GuideContent({ guideId, initialStepId, initialTool }: Gu
}
}, [data, initialStepId, initialTool, scrollToStep]);
+ useEffect(() => {
+ if (appliedHistoryRef.current || !data || !initialHistory) return;
+ appliedHistoryRef.current = true;
+ setHistoryOpen(true);
+ }, [data, initialHistory, setHistoryOpen]);
+
if (loading)
return (
<div>
diff --git a/src/ui/fullview/router.ts b/src/ui/fullview/router.ts
index 3675720..017606f 100644
--- a/src/ui/fullview/router.ts
+++ b/src/ui/fullview/router.ts
@@ -2,7 +2,13 @@ import { useEffect, useState } from 'react';
export type Route =
| { page: 'library'; category: 'all' | 'starred' | 'trash' }
- | { page: 'guide'; guideId: string; stepId?: string; tool?: 'annotate' | 'redact' | 'crop' | 'target' };
+ | {
+ page: 'guide';
+ guideId: string;
+ stepId?: string;
+ tool?: 'annotate' | 'redact' | 'crop' | 'target';
+ history?: boolean;
+ };
function parseHash(hash: string): Route {
const h = hash.replace(/^#\/?/, '');
@@ -32,9 +38,13 @@ export function useRoute(): Route {
if (guideId) {
const stepId = params.get('stepId') ?? undefined;
const toolParam = params.get('tool');
- const tool = toolParam === 'annotate' || toolParam === 'redact' || toolParam === 'crop' ? toolParam : undefined;
+ const tool =
+ toolParam === 'annotate' || toolParam === 'redact' || toolParam === 'crop' || toolParam === 'target'
+ ? toolParam
+ : undefined;
+ const showHistory = params.get('history') === '1';
window.history.replaceState(null, '', `${window.location.pathname}#guide/${guideId}`);
- return { page: 'guide', guideId, stepId, tool };
+ return { page: 'guide', guideId, stepId, tool, history: showHistory };
}
return parseHash(window.location.hash);
});
diff --git a/src/ui/sidepanel/GuideEditor.tsx b/src/ui/sidepanel/GuideEditor.tsx
index 7c197f6..3f7f110 100644
--- a/src/ui/sidepanel/GuideEditor.tsx
+++ b/src/ui/sidepanel/GuideEditor.tsx
@@ -1,11 +1,26 @@
-import { ArrowLeft, Layers, Maximize2, Play } from 'lucide-react';
+import { ArrowLeft, Check, History, Layers, Maximize2, MoreHorizontal, Pencil, Play } from 'lucide-react';
import { useCallback, useEffect, useState } from 'react';
import { i18n } from '#imports';
-import { deleteStep, getGuide, reorderSteps, updateGuideTitle, updateStepDescription } from '@/core/guides/service';
+import {
+ createSnapshot,
+ deleteStep,
+ getGuide,
+ onGuidesChanged,
+ reorderSteps,
+ updateGuideTitle,
+ updateStepDescription,
+} from '@/core/guides/service';
import type { Guide, Screenshot, Step } from '@/core/guides/types';
import { createTab, focusWindow, getExtensionURL, queryTabs, updateTab } from '@/lib/browser-api';
+import { logger } from '@/lib/logger';
import { sendMessage } from '@/lib/messaging';
import { getMostCommonDomain } from '@/lib/utils';
+import {
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuItem,
+ DropdownMenuTrigger,
+} from '@/ui/components/ui/dropdown-menu';
import { Input } from '@/ui/components/ui/input';
import EmptyGuideState from '@/ui/shared/EmptyGuideState';
import FaviconImg from '@/ui/shared/FaviconImg';
@@ -19,17 +34,29 @@ interface GuideEditorProps {
onGuideMe?: (guideId: string) => void;
}
+interface OpenInFullViewOptions {
+ stepId?: string;
+ tool?: 'annotate' | 'redact' | 'crop' | 'target';
+ history?: boolean;
+}
+
interface GuideData {
guide: Guide;
steps: Step[];
screenshots: Map<string, Screenshot>;
}
+function flushFocusedField() {
+ const el = document.activeElement;
+ if (el instanceof HTMLTextAreaElement || el instanceof HTMLInputElement) el.blur();
+}
+
export default function GuideEditor({ guideId, onBack, onGuideMe }: GuideEditorProps) {
const [data, setData] = useState<GuideData | null>(null);
const [loading, setLoading] = useState(true);
const [notFound, setNotFound] = useState(false);
const [title, setTitle] = useState('');
+ const [editing, setEditing] = useState(false);
const [dragIndex, setDragIndex] = useState<number | null>(null);
const [dragOverIndex, setDragOverIndex] = useState<number | null>(null);
@@ -49,6 +76,12 @@ export default function GuideEditor({ guideId, onBack, onGuideMe }: GuideEditorP
loadGuide();
}, [loadGuide]);
+ useEffect(() => {
+ return onGuidesChanged(() => {
+ if (!editing) loadGuide();
+ });
+ }, [editing, loadGuide]);
+
const handleTitleBlur = useCallback(async () => {
if (!data || title === data.guide.title) return;
await updateGuideTitle(guideId, title);
@@ -79,23 +112,37 @@ export default function GuideEditor({ guideId, onBack, onGuideMe }: GuideEditorP
[guideId, loadGuide],
);
- const openInFullView = useCallback(
- (targetGuideId: string, stepId?: string, tool?: 'annotate' | 'redact' | 'crop' | 'target') => {
- const params = new URLSearchParams({ guideId: targetGuideId });
- if (stepId) params.set('stepId', stepId);
- if (tool) params.set('tool', tool);
- const url = getExtensionURL(`/fullview.html?${params.toString()}`);
- queryTabs({ url: getExtensionURL('/fullview.html') }).then((tabs) => {
- if (tabs.length > 0 && tabs[0].id) {
- updateTab(tabs[0].id, { active: true, url });
- if (tabs[0].windowId) focusWindow(tabs[0].windowId);
- } else {
- createTab({ url });
- }
- });
- },
- [],
- );
+ const openInFullView = useCallback((targetGuideId: string, options?: OpenInFullViewOptions) => {
+ const params = new URLSearchParams({ guideId: targetGuideId });
+ if (options?.stepId) params.set('stepId', options.stepId);
+ if (options?.tool) params.set('tool', options.tool);
+ if (options?.history) params.set('history', '1');
+ const url = getExtensionURL(`/fullview.html?${params.toString()}`);
+ queryTabs({ url: getExtensionURL('/fullview.html') }).then((tabs) => {
+ if (tabs.length > 0 && tabs[0].id) {
+ updateTab(tabs[0].id, { active: true, url });
+ if (tabs[0].windowId) focusWindow(tabs[0].windowId);
+ } else {
+ createTab({ url });
+ }
+ });
+ }, []);
+
+ const toggleEditing = useCallback(() => {
+ if (editing) {
+ flushFocusedField();
+ setEditing(false);
+ return;
+ }
+ setEditing(true);
+ createSnapshot(guideId).catch((err) => logger.error(' Snapshot before editing failed', err));
+ }, [editing, guideId]);
+
+ const openVersionHistory = useCallback(() => {
+ flushFocusedField();
+ setEditing(false);
+ openInFullView(guideId, { history: true });
+ }, [guideId, openInFullView]);
if (loading) return <p className="text-sm text-purple p-4">{i18n.t('common.loading')}</p>;
@@ -122,12 +169,18 @@ export default function GuideEditor({ guideId, onBack, onGuideMe }: GuideEditorP
>
<ArrowLeft size={18} />
</button>
- <Input
- value={title}
- onChange={(e) => setTitle(e.target.value)}
- onBlur={handleTitleBlur}
- className="text-lg font-bold bg-transparent border-0 border-b border-transparent hover:border-border focus-visible:ring-0 focus-visible:border-accent shadow-none p-0 h-auto text-foreground"
- />
+ {editing ? (
+ <Input
+ value={title}
+ onChange={(e) => setTitle(e.target.value)}
+ onBlur={handleTitleBlur}
+ className="text-lg font-bold bg-transparent border-0 border-b border-transparent hover:border-border focus-visible:ring-0 focus-visible:border-accent shadow-none p-0 h-auto text-foreground"
+ />
+ ) : (
+ <h2 className="flex-1 min-w-0 text-lg font-bold truncate text-foreground" title={title}>
+ {title}
+ </h2>
+ )}
<button
onClick={() => openInFullView(guideId)}
className="shrink-0 p-1.5 rounded-md transition-colors text-purple hover:text-accent hover:bg-secondary"
@@ -148,8 +201,35 @@ export default function GuideEditor({ guideId, onBack, onGuideMe }: GuideEditorP
<Play size={15} />
</button>
)}
- <div className="ml-auto shrink-0">
+ <div className="ml-auto shrink-0 flex items-center gap-1">
+ <button
+ onClick={toggleEditing}
+ className="shrink-0 p-1.5 rounded-md transition-colors text-purple hover:text-accent hover:bg-secondary"
+ title={editing ? i18n.t('editor.done') : i18n.t('editor.edit')}
+ aria-label={editing ? i18n.t('editor.done') : i18n.t('editor.edit')}
+ >
+ {editing ? <Check size={15} /> : <Pencil size={15} />}
+ </button>
<ExportMenu guideId={guideId} guide={data.guide} steps={data.steps} screenshots={data.screenshots} />
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <button
+ type="button"
+ onPointerDown={flushFocusedField}
+ className="shrink-0 p-1.5 rounded-md transition-colors text-purple hover:text-accent hover:bg-secondary"
+ title={i18n.t('editor.moreActions')}
+ aria-label={i18n.t('editor.moreActions')}
+ >
+ <MoreHorizontal size={15} />
+ </button>
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="end">
+ <DropdownMenuItem onSelect={openVersionHistory}>
+ <History size={14} />
+ {i18n.t('editor.versionHistory')}
+ </DropdownMenuItem>
+ </DropdownMenuContent>
+ </DropdownMenu>
</div>
</div>
<div className="text-[11px] flex items-center gap-2 text-muted-foreground" style={{ marginLeft: '34px' }}>
@@ -187,34 +267,39 @@ export default function GuideEditor({ guideId, onBack, onGuideMe }: GuideEditorP
placeholderRatio={siblingRatio(data.screenshots)}
onDescriptionChange={handleDescriptionChange}
onDelete={handleDeleteStep}
- onOpenEditor={(stepId, tool) => openInFullView(guideId, stepId, tool)}
- dragHandleProps={{
- onDragStart: (e: React.DragEvent) => {
- setDragIndex(idx);
- e.dataTransfer.effectAllowed = 'move';
- },
- onDragOver: (e: React.DragEvent) => {
- e.preventDefault();
- setDragOverIndex(idx);
- },
- onDragEnd: () => {
- if (dragIndex !== null && dragOverIndex !== null && dragIndex !== dragOverIndex) {
- setData((prev) => {
- if (!prev) return prev;
- const newSteps = [...prev.steps];
- const [moved] = newSteps.splice(dragIndex, 1);
- newSteps.splice(dragOverIndex, 0, moved);
- reorderSteps(
- guideId,
- newSteps.map((s) => s.id),
- );
- return { ...prev, steps: newSteps };
- });
- }
- setDragIndex(null);
- setDragOverIndex(null);
- },
- }}
+ onOpenEditor={(stepId, tool) => openInFullView(guideId, { stepId, tool })}
+ readOnly={!editing}
+ dragHandleProps={
+ editing
+ ? {
+ onDragStart: (e: React.DragEvent) => {
+ setDragIndex(idx);
+ e.dataTransfer.effectAllowed = 'move';
+ },
+ onDragOver: (e: React.DragEvent) => {
+ e.preventDefault();
+ setDragOverIndex(idx);
+ },
+ onDragEnd: () => {
+ if (dragIndex !== null && dragOverIndex !== null && dragIndex !== dragOverIndex) {
+ setData((prev) => {
+ if (!prev) return prev;
+ const newSteps = [...prev.steps];
+ const [moved] = newSteps.splice(dragIndex, 1);
+ newSteps.splice(dragOverIndex, 0, moved);
+ reorderSteps(
+ guideId,
+ newSteps.map((s) => s.id),
+ );
+ return { ...prev, steps: newSteps };
+ });
+ }
+ setDragIndex(null);
+ setDragOverIndex(null);
+ },
+ }
+ : undefined
+ }
/>
</div>
))