Files
paseo/plugin-examples/markdown-panel/client/rich-markdown.tsx
T
Mohamed Boudra 4fe006df86 feat(plugins): unify panel props and persist tab state (#7685)
* feat(plugins): unify panel props and persist tab state

* refactor(plugins): make agent panel registration canonical

* docs(plugins): update Chinese panel API reference and migration
2026-10-23 13:26:19 +07:00

233 lines
7.9 KiB
TypeScript

import { z } from "zod";
import {
PluginFileConflictError,
PluginFileDeletedError,
type PluginFilePanelProps,
useFileText,
useTabState,
} from "@getpaseo/plugin/client";
import { Loading, Markdown } from "@getpaseo/plugin/client/ui";
import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from "react";
import { Pressable, ScrollView, Text, View } from "react-native";
import { type MarkdownEditorHandle, mountEditor } from "./web";
const SAVE_DELAY_MS = 500;
type EditorState = "loading" | "ready" | "conflict" | "deleted";
/**
* Reads the file once, writes 500 ms after the last edit, and follows the disk while nothing is
* unsaved. With unsaved edits, a change on disk is a conflict: Reload or Overwrite.
*/
function MarkdownEditor({ file, tab: { setModified }, theme }: PluginFilePanelProps) {
const parent = useRef<View>(null);
const editor = useRef<MarkdownEditorHandle | null>(null);
const text = useRef("");
const unsaved = useRef<string | null>(null);
const saveTimer = useRef<ReturnType<typeof setTimeout> | undefined>(undefined);
const [state, setState] = useState<EditorState>("loading");
const [error, setError] = useState<string | null>(null);
const load = useCallback(async () => {
try {
text.current = await file.readText();
} catch (cause) {
setError(messageOf(cause));
return;
}
unsaved.current = null;
setModified(false);
editor.current?.setText(text.current);
setError(null);
setState("ready");
}, [file, setModified]);
const save = useCallback(
async (force: boolean) => {
const next = unsaved.current;
if (next === null) return;
try {
await file.writeText(next, { force });
} catch (cause) {
if (cause instanceof PluginFileConflictError) setState("conflict");
else if (cause instanceof PluginFileDeletedError) setState("deleted");
else setError(messageOf(cause));
return;
}
if (unsaved.current === next) {
unsaved.current = null;
setModified(false);
}
setError(null);
setState("ready");
},
[file, setModified],
);
useLayoutEffect(() => {
editor.current = mountEditor(parent.current, text.current, theme, (next) => {
text.current = next;
unsaved.current = next;
setModified(true);
clearTimeout(saveTimer.current);
saveTimer.current = setTimeout(() => void save(false), SAVE_DELAY_MS);
});
return () => {
editor.current?.destroy();
editor.current = null;
};
}, [save, setModified, theme]);
useEffect(() => {
void load();
const unwatch = file.watch((event) => {
if (event.type === "deleted") setState("deleted");
else if (unsaved.current === null) void load();
else setState("conflict");
});
return () => {
unwatch();
clearTimeout(saveTimer.current);
// Switching panels keeps the edit. Closing the tab asks first and drops it if discarded.
// The panel is gone, so a failed write (a conflict, a lost connection) can only be reported.
if (unsaved.current !== null) {
void file.writeText(unsaved.current).catch((cause) => {
console.warn(`Unsaved edits to ${file.name} were not written: ${messageOf(cause)}`);
});
}
};
}, [file, load]);
const styles = useMemo(
() => ({
panel: { flex: 1, minHeight: 0, backgroundColor: theme.colors.surface0 },
editor: { flex: 1, minHeight: 0 },
banner: {
flexDirection: "row" as const,
alignItems: "center" as const,
gap: 12,
paddingHorizontal: 16,
paddingVertical: 8,
backgroundColor: theme.colors.surface1,
borderBottomWidth: 1,
borderBottomColor: theme.colors.border,
},
bannerText: { flex: 1, color: theme.colors.foreground },
error: { color: theme.colors.statusDanger, paddingHorizontal: 16, paddingVertical: 8 },
action: { color: theme.colors.accent },
}),
[theme],
);
const overwrite = useCallback(() => void save(true), [save]);
const reload = useCallback(() => void load(), [load]);
return (
<View style={styles.panel}>
{state === "conflict" ? (
<View style={styles.banner} testID="rich-markdown-conflict">
<Text style={styles.bannerText}>The file changed on disk.</Text>
<Pressable accessibilityRole="button" onPress={reload}>
<Text style={styles.action}>Reload</Text>
</Pressable>
<Pressable accessibilityRole="button" onPress={overwrite}>
<Text style={styles.action}>Overwrite</Text>
</Pressable>
</View>
) : null}
{state === "deleted" ? (
<View style={styles.banner}>
<Text style={styles.bannerText}>The file was deleted. Edits are kept here.</Text>
</View>
) : null}
{error ? <Text style={styles.error}>{error}</Text> : null}
<View ref={parent} style={styles.editor} />
{state === "loading" && !error ? <Loading /> : null}
</View>
);
}
/** Native has no editor: selectable, read-only text that follows the disk. */
function MarkdownText({ file, theme }: PluginFilePanelProps) {
const text = useFileText(file);
const styles = useMemo(
() => ({
screen: { flex: 1, backgroundColor: theme.colors.surface0 },
text: { color: theme.colors.foreground, padding: 16 },
error: { color: theme.colors.statusDanger, padding: 16 },
}),
[theme],
);
if (text.status === "loading") return <Loading />;
if (text.status === "error") return <Text style={styles.error}>{text.error.message}</Text>;
return (
<ScrollView style={styles.screen}>
<Text selectable style={styles.text}>
{text.text}
</Text>
</ScrollView>
);
}
const viewSchema = z.object({ view: z.enum(["preview", "source"]) });
const defaultView = { view: "source" } as const;
function MarkdownPreview({ file, theme }: PluginFilePanelProps) {
const text = useFileText(file);
const errorStyle = useMemo(() => ({ color: theme.colors.statusDanger }), [theme]);
if (text.status === "loading") return <Loading />;
if (text.status === "error") return <Text style={errorStyle}>{text.error.message}</Text>;
return (
<ScrollView>
<Markdown>{text.text}</Markdown>
</ScrollView>
);
}
const toolbarStyle = { flexDirection: "row", gap: 16, padding: 12 } as const;
const selected = { selected: true };
const unselected = { selected: false };
export function RichMarkdownPanel(props: PluginFilePanelProps) {
const [state, setState] = useTabState(props.tab, viewSchema, defaultView);
const styles = useMemo(
() => ({
panel: { flex: 1, minHeight: 0, backgroundColor: props.theme.colors.surface0 },
label: { color: props.theme.colors.foreground },
}),
[props.theme],
);
const showPreview = useCallback(() => setState({ view: "preview" }), [setState]);
const showSource = useCallback(() => setState({ view: "source" }), [setState]);
let content;
if (state.view === "preview") content = <MarkdownPreview {...props} />;
else if (props.layout.platform === "web") content = <MarkdownEditor {...props} />;
else content = <MarkdownText {...props} />;
return (
<View style={styles.panel}>
<View style={toolbarStyle}>
<Pressable
accessibilityRole="button"
accessibilityLabel="Rich Markdown Preview"
accessibilityState={state.view === "preview" ? selected : unselected}
onPress={showPreview}
>
<Text style={styles.label}>Preview</Text>
</Pressable>
<Pressable
accessibilityRole="button"
accessibilityLabel="Rich Markdown Source"
accessibilityState={state.view === "source" ? selected : unselected}
onPress={showSource}
>
<Text style={styles.label}>Source</Text>
</Pressable>
</View>
{content}
</View>
);
}
function messageOf(cause: unknown): string {
return cause instanceof Error ? cause.message : String(cause);
}