Skip to content

AI-native knowledge base & Evernote/Obsidian alternative with instant sync & native MCP. Free on Cloudflare or self-hosted via Docker.

feat(editor): support @ note links

tianma-if50768925f977
diff --git a/apps/web/src/components/EditorPane.tsx b/apps/web/src/components/EditorPane.tsx
index d007013d..75f4b45f 100644
--- a/apps/web/src/components/EditorPane.tsx
+++ b/apps/web/src/components/EditorPane.tsx
@@ -84,6 +84,10 @@ import {
type SlashCommandActions,
type SlashCommandLabels,
} from "./editor/SlashCommandMenu";
+import {
+ createNoteLinkSuggestionExtension,
+ type NoteLinkSuggestionLabels,
+} from "./editor/NoteLinkSuggestion";
import { WeChatIcon } from "./WeChatIcon";
import { ThemeToggle } from "./ThemeToggle";
import { useEditorTheme } from "./ThemeProvider";
@@ -957,6 +961,29 @@ const RichEditorPane = ({
getLabels: () => slashCommandLabelsRef.current,
});
}
+ const noteLinkSuggestionLabelsRef = useRef<NoteLinkSuggestionLabels>({
+ menu: "",
+ empty: "",
+ close: "",
+ untitled: "",
+ });
+ noteLinkSuggestionLabelsRef.current = {
+ menu: t("noteLinkPicker.title"),
+ empty: t("noteLinkPicker.empty"),
+ close: t("noteLinkPicker.close"),
+ untitled: t("common.untitledMemo"),
+ };
+ const noteLinkSuggestionExtensionRef = useRef<ReturnType<typeof createNoteLinkSuggestionExtension> | null>(null);
+ if (!noteLinkSuggestionExtensionRef.current) {
+ noteLinkSuggestionExtensionRef.current = createNoteLinkSuggestionExtension({
+ getCurrentMemoId: () => memoRef.current?.id ?? null,
+ getLabels: () => noteLinkSuggestionLabelsRef.current,
+ searchMemos: async (query) => {
+ const result = await repository.listMemos({ q: query, limit: 20 });
+ return result.memos;
+ },
+ });
+ }
const hydratingRef = useRef(false);
const hydratedMemoIdRef = useRef<string | null>(null);
/** Last content source applied to the editor — used to skip redundant setContent. */
@@ -1210,6 +1237,7 @@ const RichEditorPane = ({
: t("editor.placeholderCommands"),
}),
slashCommandExtensionRef.current,
+ noteLinkSuggestionExtensionRef.current,
],
content: memo
? resolveMemoContentDoc(memo.contentJson, memo.contentMarkdown)
diff --git a/apps/web/src/components/editor/NoteLinkSuggestion.test.mjs b/apps/web/src/components/editor/NoteLinkSuggestion.test.mjs
new file mode 100644
index 00000000..f93f9d2a
--- /dev/null
+++ b/apps/web/src/components/editor/NoteLinkSuggestion.test.mjs
@@ -0,0 +1,85 @@
+import { describe, expect, test } from "bun:test";
+import { Editor } from "@tiptap/core";
+import StarterKit from "@tiptap/starter-kit";
+import {
+ filterNoteLinkSuggestions,
+ insertSuggestedNoteLink,
+} from "./NoteLinkSuggestion.tsx";
+
+const labels = {
+ menu: "引用笔记",
+ empty: "没有找到可引用的笔记",
+ close: "关闭引用笔记",
+ untitled: "无标题笔记",
+};
+
+const memo = (overrides) => ({
+ id: "memo-1",
+ title: "项目笔记",
+ excerpt: "项目摘要",
+ isDeleted: false,
+ ...overrides,
+});
+
+describe("note link suggestion", () => {
+ test("excludes the current and deleted notes", () => {
+ expect(filterNoteLinkSuggestions([
+ memo({ id: "current" }),
+ memo({ id: "deleted", isDeleted: true }),
+ memo({ id: "available" }),
+ ], "current").map((item) => item.id)).toEqual(["available"]);
+ });
+
+ test("replaces the @ query with the existing internal-note link format", () => {
+ const editor = new Editor({
+ extensions: [StarterKit],
+ content: {
+ type: "doc",
+ content: [{ type: "paragraph", content: [{ type: "text", text: "@项目" }] }],
+ },
+ });
+
+ insertSuggestedNoteLink({
+ editor,
+ item: memo({ id: "target" }),
+ labels,
+ range: { from: 1, to: 4 },
+ });
+
+ expect(editor.getJSON().content[0].content).toEqual([{
+ type: "text",
+ marks: [{
+ type: "link",
+ attrs: {
+ href: "#memo=target",
+ target: "_blank",
+ rel: "noopener noreferrer nofollow",
+ class: "edgeever-note-link",
+ title: null,
+ },
+ }],
+ text: "项目笔记",
+ }]);
+ editor.destroy();
+ });
+
+ test("uses the untitled fallback for an empty title", () => {
+ const editor = new Editor({
+ extensions: [StarterKit],
+ content: {
+ type: "doc",
+ content: [{ type: "paragraph", content: [{ type: "text", text: "@" }] }],
+ },
+ });
+
+ insertSuggestedNoteLink({
+ editor,
+ item: memo({ id: "untitled", title: "" }),
+ labels,
+ range: { from: 1, to: 2 },
+ });
+
+ expect(editor.getText()).toBe("无标题笔记");
+ editor.destroy();
+ });
+});
diff --git a/apps/web/src/components/editor/NoteLinkSuggestion.tsx b/apps/web/src/components/editor/NoteLinkSuggestion.tsx
new file mode 100644
index 00000000..9595bc86
--- /dev/null
+++ b/apps/web/src/components/editor/NoteLinkSuggestion.tsx
@@ -0,0 +1,184 @@
+import { forwardRef, useEffect, useImperativeHandle, useState } from "react";
+import { Extension, type Editor, type Range } from "@tiptap/core";
+import { ReactRenderer } from "@tiptap/react";
+import { PluginKey } from "@tiptap/pm/state";
+import Suggestion, { type SuggestionKeyDownProps, type SuggestionProps } from "@tiptap/suggestion";
+import { Link2 } from "lucide-react";
+import { createMemoLinkHref, type MemoSummary } from "@edgeever/shared";
+import {
+ Command,
+ CommandEmpty,
+ CommandGroup,
+ CommandItem,
+ CommandList,
+} from "@/components/ui/command";
+
+export type NoteLinkSuggestionLabels = {
+ menu: string;
+ empty: string;
+ close: string;
+ untitled: string;
+};
+
+type NoteLinkSuggestionProps = SuggestionProps<MemoSummary, MemoSummary> & {
+ labels: NoteLinkSuggestionLabels;
+};
+
+export type NoteLinkSuggestionHandle = {
+ onKeyDown: (props: SuggestionKeyDownProps) => boolean;
+};
+
+const noteLinkSuggestionPluginKey = new PluginKey("edgeever-note-link-suggestion");
+
+export const filterNoteLinkSuggestions = (items: MemoSummary[], currentMemoId: string | null) =>
+ items.filter((memo) => memo.id !== currentMemoId && !memo.isDeleted);
+
+export const NoteLinkSuggestion = forwardRef<NoteLinkSuggestionHandle, NoteLinkSuggestionProps>(
+ ({ command, items, labels }, ref) => {
+ const [selectedIndex, setSelectedIndex] = useState(0);
+ const selectedItem = items[Math.min(selectedIndex, Math.max(0, items.length - 1))];
+
+ useEffect(() => setSelectedIndex(0), [items]);
+
+ useImperativeHandle(ref, () => ({
+ onKeyDown: ({ event }) => {
+ if (!items.length) return false;
+ if (event.key === "ArrowUp") {
+ setSelectedIndex((current) => (current + items.length - 1) % items.length);
+ return true;
+ }
+ if (event.key === "ArrowDown") {
+ setSelectedIndex((current) => (current + 1) % items.length);
+ return true;
+ }
+ if (event.key === "Enter") {
+ command(items[Math.min(selectedIndex, items.length - 1)]);
+ return true;
+ }
+ return false;
+ },
+ }), [command, items, selectedIndex]);
+
+ return (
+ <Command
+ aria-label={labels.menu}
+ className="w-[min(28rem,calc(100vw-1.5rem))] rounded-xl border border-slate-200 shadow-2xl ring-1 ring-slate-950/5"
+ shouldFilter={false}
+ value={selectedItem?.id}
+ onValueChange={(value) => {
+ const index = items.findIndex((item) => item.id === value);
+ if (index >= 0) setSelectedIndex(index);
+ }}
+ >
+ <CommandList className="max-h-[min(22rem,55dvh)] p-1.5">
+ <CommandEmpty>{labels.empty}</CommandEmpty>
+ <CommandGroup>
+ {items.map((item) => (
+ <CommandItem
+ key={item.id}
+ value={item.id}
+ onMouseDown={(event) => event.preventDefault()}
+ onSelect={() => command(item)}
+ >
+ <Link2 className="h-4 w-4 shrink-0 text-emerald-600" />
+ <span className="min-w-0 flex-1 truncate">{item.title || labels.untitled}</span>
+ <span className="max-w-40 truncate text-xs text-slate-400">{item.excerpt}</span>
+ </CommandItem>
+ ))}
+ </CommandGroup>
+ </CommandList>
+ <div className="flex items-center justify-between border-t border-slate-100 px-3 py-2 text-xs text-slate-400">
+ <span>↑↓ · Enter</span>
+ <span>{labels.close} · Esc</span>
+ </div>
+ </Command>
+ );
+ },
+);
+NoteLinkSuggestion.displayName = "NoteLinkSuggestion";
+
+export const insertSuggestedNoteLink = ({
+ editor,
+ item,
+ labels,
+ range,
+}: {
+ editor: Editor;
+ item: MemoSummary;
+ labels: NoteLinkSuggestionLabels;
+ range: Range;
+}) => {
+ editor
+ .chain()
+ .focus()
+ .deleteRange(range)
+ .insertContent({
+ type: "text",
+ text: item.title || labels.untitled,
+ marks: [{
+ type: "link",
+ attrs: { href: createMemoLinkHref(item.id), class: "edgeever-note-link" },
+ }],
+ })
+ .run();
+};
+
+export const createNoteLinkSuggestionExtension = ({
+ getCurrentMemoId,
+ getLabels,
+ searchMemos,
+}: {
+ getCurrentMemoId: () => string | null;
+ getLabels: () => NoteLinkSuggestionLabels;
+ searchMemos: (query: string) => Promise<MemoSummary[]>;
+}) => Extension.create({
+ name: "edgeeverNoteLinkSuggestion",
+ addProseMirrorPlugins() {
+ return [Suggestion<MemoSummary, MemoSummary>({
+ editor: this.editor,
+ pluginKey: noteLinkSuggestionPluginKey,
+ char: "@",
+ allowSpaces: true,
+ allowedPrefixes: null,
+ placement: "bottom-start",
+ offset: { mainAxis: 6 },
+ decorationClass: "edgeever-note-link-query",
+ allow: ({ state, range }) => {
+ const position = state.doc.resolve(range.from);
+ return this.editor.isEditable && position.parent.type.name === "paragraph";
+ },
+ items: async ({ query }) => {
+ const currentMemoId = getCurrentMemoId();
+ const memos = await searchMemos(query);
+ return filterNoteLinkSuggestions(memos, currentMemoId);
+ },
+ command: ({ editor, range, props }) => insertSuggestedNoteLink({
+ editor,
+ item: props,
+ labels: getLabels(),
+ range,
+ }),
+ render: () => {
+ let renderer: ReactRenderer<NoteLinkSuggestionHandle, NoteLinkSuggestionProps> | null = null;
+ let unmount: (() => void) | null = null;
+ return {
+ onStart: (props) => {
+ renderer = new ReactRenderer(NoteLinkSuggestion, {
+ editor: props.editor,
+ props: { ...props, labels: getLabels() },
+ });
+ unmount = props.mount(renderer.element);
+ },
+ onUpdate: (props) => renderer?.updateProps({ ...props, labels: getLabels() }),
+ onKeyDown: (props) => renderer?.ref?.onKeyDown(props) ?? false,
+ onExit: () => {
+ unmount?.();
+ renderer?.destroy();
+ unmount = null;
+ renderer = null;
+ },
+ };
+ },
+ })];
+ },
+});
diff --git a/packages/shared/src/i18n/en-US.ts b/packages/shared/src/i18n/en-US.ts
index beb19209..da751999 100644
--- a/packages/shared/src/i18n/en-US.ts
+++ b/packages/shared/src/i18n/en-US.ts
@@ -948,8 +948,8 @@ export const enUS = {
deleteDescription: "The attachment will be permanently removed from storage and this note. This cannot be undone.",
failed: "The attachment action failed. Try again.",
},
- placeholder: "Press Space for AI, or type / for commands",
- placeholderCommands: "Type / for commands",
+ placeholder: "Space for AI · / for commands · @ to link notes",
+ placeholderCommands: "/ for commands · @ to link notes",
noteBodyAria: "Note body",
markdownSourceAria: "Markdown source",
loading: "Loading",
diff --git a/packages/shared/src/i18n/zh-CN.ts b/packages/shared/src/i18n/zh-CN.ts
index 7650428b..3f21e11d 100644
--- a/packages/shared/src/i18n/zh-CN.ts
+++ b/packages/shared/src/i18n/zh-CN.ts
@@ -948,8 +948,8 @@ export const zhCN = {
deleteDescription: "附件会从存储空间和当前笔记中永久删除,此操作无法撤销。",
failed: "附件操作失败,请重试。",
},
- placeholder: "按 Space 使用 AI,输入 / 浏览命令",
- placeholderCommands: "输入 / 浏览命令",
+ placeholder: "Space 唤起 AI · / 浏览命令 · @ 引用笔记",
+ placeholderCommands: "/ 浏览命令 · @ 引用笔记",
noteBodyAria: "笔记正文",
markdownSourceAria: "Markdown 源码",
loading: "加载中",