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): add setting to turn off spellcheck underlines (#472)

Dariusz Koryto18c4833ef5a7
diff --git a/apps/web/src/components/EditorPane.tsx b/apps/web/src/components/EditorPane.tsx
index 3cf58cc5..c6f836f5 100644
--- a/apps/web/src/components/EditorPane.tsx
+++ b/apps/web/src/components/EditorPane.tsx
@@ -221,6 +221,7 @@ import {
AI_SELECTION_MENU_CHANGED_EVENT,
readAiSelectionMenuPreference,
} from "@/lib/ai-selection-menu-preference";
+import { useEditorSpellcheckPreference } from "@/lib/editor-spellcheck-preference";
import {
clipSelectionForSend,
translationReplacement,
@@ -473,6 +474,7 @@ const RichEditorPane = ({
writeAiSidebarOpen(open);
}, []);
const aiBubbleMenu = useAiBubbleMenu();
+ const spellcheckEnabled = useEditorSpellcheckPreference();
const [selectionPin, setSelectionPin] = useState<SelectionAiPin | null>(null);
const [selectionRequest, setSelectionRequest] = useState<SelectionAiRequest | null>(null);
const selectionPinRef = useRef<SelectionAiPin | null>(null);
@@ -1209,6 +1211,7 @@ const RichEditorPane = ({
editorProps: {
attributes: {
class: "edgeever-note-rich-editor prose prose-slate max-w-none focus:outline-none min-h-[240px] lg:min-h-[180px]",
+ spellcheck: spellcheckEnabled ? "true" : "false",
},
handleKeyDown: (view, event) => {
const { selection } = view.state;
@@ -4193,7 +4196,7 @@ const RichEditorPane = ({
enterKeyHint="enter"
inputMode="text"
name="memo-body"
- spellCheck
+ spellCheck={spellcheckEnabled}
data-edgeever-mobile-editor="plain-textarea"
aria-label={t("editor.noteBodyAria")}
className="block min-h-[60dvh] w-full resize-none border border-slate-200 bg-card px-4 py-3 pr-32 text-base leading-7 text-slate-950 outline-none placeholder:text-slate-400 sm:px-7"
diff --git a/apps/web/src/components/settings/PreferenceCard.tsx b/apps/web/src/components/settings/PreferenceCard.tsx
index 353cc6d0..04d0659f 100644
--- a/apps/web/src/components/settings/PreferenceCard.tsx
+++ b/apps/web/src/components/settings/PreferenceCard.tsx
@@ -1,9 +1,14 @@
-import { AlignHorizontalJustifyCenter, AlignVerticalSpaceAround, AppWindow, BookOpenText, ChartNoAxesCombined, Code2, Image, Keyboard, Languages, ListTree, MousePointerClick, Palette, Sparkles, SunMoon, Type } from "lucide-react";
+import { AlignHorizontalJustifyCenter, AlignVerticalSpaceAround, AppWindow, BookOpenText, ChartNoAxesCombined, Code2, Image, Keyboard, Languages, ListTree, MousePointerClick, Palette, Sparkles, SpellCheck, SunMoon, Type } from "lucide-react";
import { useState, useEffect, type ReactNode } from "react";
import { useTranslation } from "react-i18next";
import type { EditorContentWidth } from "@/lib/editor-content-width";
import type { NoteProsePatch, NoteProsePaletteChoice, ResolvedNoteProse } from "@edgeever/shared";
import { DEFAULT_NOTE_PROSE_CSS, MAX_NOTE_PROSE_CSS_BYTES, NOTE_PROSE_FONT_SIZES, NOTE_PROSE_PALETTE_CHOICES, NOTE_PROSE_PALETTES, noteProseCssDropsDeclarations } from "@edgeever/shared";
+import {
+ EDITOR_SPELLCHECK_CHANGED_EVENT,
+ readEditorSpellcheckPreference,
+ writeEditorSpellcheckPreference,
+} from "@/lib/editor-spellcheck-preference";
import {
EDITOR_LINK_OPEN_MODE_CHANGED_EVENT,
getStoredEditorLinkOpenMode,
@@ -221,6 +226,7 @@ export const PreferenceCard = ({
const [linkOpenMode, setLinkOpenMode] = useState<EditorLinkOpenMode>(() => getStoredEditorLinkOpenMode());
const [aiSelectionMenuEnabled, setAiSelectionMenuEnabled] = useState(readAiSelectionMenuPreference);
const [aiSpaceShortcutEnabled, setAiSpaceShortcutEnabled] = useState(readAiSpaceShortcutPreference);
+ const [spellcheckEnabled, setSpellcheckEnabled] = useState(readEditorSpellcheckPreference);
const [editorBodyFont, setEditorBodyFont] = useState(readEditorBodyFontPreference);
const [uiFont, setUiFont] = useState(readUiFontPreference);
@@ -242,6 +248,24 @@ export const PreferenceCard = ({
};
}, []);
+ useEffect(() => {
+ const syncPreference = () => setSpellcheckEnabled(readEditorSpellcheckPreference());
+ const onPreferenceChanged = (event: Event) => {
+ const detail = (event as CustomEvent<boolean>).detail;
+ if (typeof detail === "boolean") {
+ setSpellcheckEnabled(detail);
+ return;
+ }
+ syncPreference();
+ };
+ window.addEventListener(EDITOR_SPELLCHECK_CHANGED_EVENT, onPreferenceChanged);
+ window.addEventListener("storage", syncPreference);
+ return () => {
+ window.removeEventListener(EDITOR_SPELLCHECK_CHANGED_EVENT, onPreferenceChanged);
+ window.removeEventListener("storage", syncPreference);
+ };
+ }, []);
+
useEffect(() => {
const syncPreference = () => setAiSelectionMenuEnabled(readAiSelectionMenuPreference());
const onPreferenceChanged = (event: Event) => {
@@ -578,6 +602,25 @@ export const PreferenceCard = ({
</div>
</div>
+ <div className="flex min-h-16 flex-col items-start gap-3 px-4 py-3 sm:flex-row sm:items-center sm:justify-between sm:gap-4">
+ <div className="flex min-w-0 items-center gap-3">
+ <SpellCheck className="h-4 w-4 shrink-0 text-slate-500" />
+ <div className="min-w-0">
+ <div className={SETTINGS_ITEM_TITLE_CLASSNAME}>{t("settings.spellcheckTitle")}</div>
+ </div>
+ </div>
+ <div className="flex w-full shrink-0 justify-start sm:w-44 sm:justify-end">
+ <Switch
+ checked={spellcheckEnabled}
+ onCheckedChange={(enabled) => {
+ writeEditorSpellcheckPreference(enabled);
+ setSpellcheckEnabled(enabled);
+ }}
+ aria-label={t("settings.spellcheckAria")}
+ />
+ </div>
+ </div>
+
<div className="flex min-h-16 flex-col items-start gap-3 px-4 py-3 sm:flex-row sm:items-center sm:justify-between sm:gap-4">
<div className="flex min-w-0 items-center gap-3">
<Sparkles className="h-4 w-4 shrink-0 text-slate-500" />
diff --git a/apps/web/src/lib/editor-spellcheck-preference.test.mjs b/apps/web/src/lib/editor-spellcheck-preference.test.mjs
new file mode 100644
index 00000000..d3cf5e4e
--- /dev/null
+++ b/apps/web/src/lib/editor-spellcheck-preference.test.mjs
@@ -0,0 +1,78 @@
+import { afterEach, describe, expect, test } from "bun:test";
+import {
+ EDITOR_SPELLCHECK_STORAGE_KEY,
+ readEditorSpellcheckPreference,
+ resolveStoredEditorSpellcheckPreference,
+ writeEditorSpellcheckPreference,
+} from "./editor-spellcheck-preference.ts";
+
+const originalWindow = globalThis.window;
+
+afterEach(() => {
+ if (originalWindow !== undefined) globalThis.window = originalWindow;
+});
+
+const installWindow = () => {
+ const values = new Map();
+ const events = [];
+ globalThis.window = {
+ localStorage: {
+ getItem: (key) => values.get(key) ?? null,
+ setItem: (key, value) => values.set(key, String(value)),
+ },
+ dispatchEvent: (event) => {
+ events.push(event);
+ return true;
+ },
+ };
+ return { events, values };
+};
+
+describe("editor spellcheck preference", () => {
+ test("defaults to enabled unless explicitly disabled", () => {
+ expect(resolveStoredEditorSpellcheckPreference(null)).toBe(true);
+ expect(resolveStoredEditorSpellcheckPreference("unsupported")).toBe(true);
+ expect(resolveStoredEditorSpellcheckPreference("true")).toBe(true);
+ expect(resolveStoredEditorSpellcheckPreference("false")).toBe(false);
+ });
+
+ test("persists changes and notifies the current document", () => {
+ const { events, values } = installWindow();
+ expect(readEditorSpellcheckPreference()).toBe(true);
+
+ writeEditorSpellcheckPreference(false);
+ expect(values.get(EDITOR_SPELLCHECK_STORAGE_KEY)).toBe("false");
+ expect(readEditorSpellcheckPreference()).toBe(false);
+ expect(events.at(-1)?.detail).toBe(false);
+
+ writeEditorSpellcheckPreference(true);
+ expect(values.get(EDITOR_SPELLCHECK_STORAGE_KEY)).toBe("true");
+ expect(readEditorSpellcheckPreference()).toBe(true);
+ expect(events.at(-1)?.detail).toBe(true);
+ });
+
+ test("keeps an unsaved change in memory when local storage is unavailable", () => {
+ const events = [];
+ globalThis.window = {
+ localStorage: {
+ getItem: () => { throw new Error("blocked"); },
+ setItem: () => { throw new Error("blocked"); },
+ },
+ dispatchEvent: (event) => {
+ events.push(event);
+ return true;
+ },
+ };
+
+ expect(readEditorSpellcheckPreference()).toBe(true);
+ expect(() => writeEditorSpellcheckPreference(false)).not.toThrow();
+ expect(events.at(-1)?.detail).toBe(false);
+ expect(readEditorSpellcheckPreference()).toBe(false);
+
+ const { values } = installWindow();
+ writeEditorSpellcheckPreference(true);
+ expect(values.get(EDITOR_SPELLCHECK_STORAGE_KEY)).toBe("true");
+ values.set(EDITOR_SPELLCHECK_STORAGE_KEY, "false");
+ expect(readEditorSpellcheckPreference()).toBe(false);
+ });
+});
diff --git a/apps/web/src/lib/editor-spellcheck-preference.ts b/apps/web/src/lib/editor-spellcheck-preference.ts
new file mode 100644
index 00000000..cb5e5283
--- /dev/null
+++ b/apps/web/src/lib/editor-spellcheck-preference.ts
@@ -0,0 +1,62 @@
+import { useEffect, useState } from "react";
+
+export const EDITOR_SPELLCHECK_STORAGE_KEY = "edgeever.editor.spellcheckEnabled";
+
+export const EDITOR_SPELLCHECK_CHANGED_EVENT = "edgeever:editor-spellcheck-changed";
+
+// Holds the latest choice when localStorage rejects the write, so the setting
+// stays consistent for the rest of the session instead of reverting on remount.
+let unsavedEditorSpellcheckPreference: boolean | null = null;
+
+export const resolveStoredEditorSpellcheckPreference = (stored: string | null): boolean =>
+ stored !== "false";
+
+export const readEditorSpellcheckPreference = (): boolean => {
+ if (unsavedEditorSpellcheckPreference !== null) return unsavedEditorSpellcheckPreference;
+ if (typeof window === "undefined") return true;
+ try {
+ return resolveStoredEditorSpellcheckPreference(
+ window.localStorage?.getItem(EDITOR_SPELLCHECK_STORAGE_KEY) ?? null,
+ );
+ } catch {
+ return true;
+ }
+};
+
+export const writeEditorSpellcheckPreference = (enabled: boolean) => {
+ if (typeof window === "undefined") return;
+ try {
+ window.localStorage?.setItem(EDITOR_SPELLCHECK_STORAGE_KEY, enabled ? "true" : "false");
+ unsavedEditorSpellcheckPreference = null;
+ } catch {
+ // Private mode / blocked storage — keep the preference in memory for this session.
+ unsavedEditorSpellcheckPreference = enabled;
+ }
+ window.dispatchEvent(
+ new CustomEvent(EDITOR_SPELLCHECK_CHANGED_EVENT, { detail: enabled }),
+ );
+};
+
+export const useEditorSpellcheckPreference = (): boolean => {
+ const [enabled, setEnabled] = useState(readEditorSpellcheckPreference);
+
+ useEffect(() => {
+ const syncPreference = () => setEnabled(readEditorSpellcheckPreference());
+ const handlePreferenceChanged = (event: Event) => {
+ const detail = (event as CustomEvent<boolean>).detail;
+ if (typeof detail === "boolean") {
+ setEnabled(detail);
+ return;
+ }
+ syncPreference();
+ };
+ window.addEventListener(EDITOR_SPELLCHECK_CHANGED_EVENT, handlePreferenceChanged);
+ window.addEventListener("storage", syncPreference);
+ return () => {
+ window.removeEventListener(EDITOR_SPELLCHECK_CHANGED_EVENT, handlePreferenceChanged);
+ window.removeEventListener("storage", syncPreference);
+ };
+ }, []);
+
+ return enabled;
+};
diff --git a/packages/shared/src/i18n/en-US.ts b/packages/shared/src/i18n/en-US.ts
index 3bdf1c36..10e36066 100644
--- a/packages/shared/src/i18n/en-US.ts
+++ b/packages/shared/src/i18n/en-US.ts
@@ -765,6 +765,8 @@ export const enUS = {
imageCompressionAria: "Compress note images",
showDescendantNotesTitle: "Show notes from sub-notebooks",
showDescendantNotesAria: "Show notes from sub-notebooks in parent notebooks",
+ spellcheckTitle: "Underline spelling mistakes",
+ spellcheckAria: "Underline possible spelling mistakes in the note editor",
aiSelectionMenuTitle: "Show AI assistant when text is selected",
aiSelectionMenuAria: "Show the AI assistant action when text is selected",
aiSpaceShortcutTitle: "Open AI with Space in an empty block",
diff --git a/packages/shared/src/i18n/ja.ts b/packages/shared/src/i18n/ja.ts
index 83c7d9fe..f3de83a2 100644
--- a/packages/shared/src/i18n/ja.ts
+++ b/packages/shared/src/i18n/ja.ts
@@ -765,6 +765,8 @@ export const ja = {
imageCompressionAria: "ノート内の画像を圧縮する",
showDescendantNotesTitle: "サブノートブックのノートを表示",
showDescendantNotesAria: "親ノートブックにサブノートブックのノートを表示する",
+ spellcheckTitle: "スペルミスに下線を表示",
+ spellcheckAria: "ノートエディタでスペルミスの可能性がある語に下線を表示する",
aiSelectionMenuTitle: "文字選択時に AI アシスタントを表示",
aiSelectionMenuAria: "文字選択時に AI アシスタント操作を表示する",
aiSpaceShortcutTitle: "空のブロックで Space から AI を開く",
diff --git a/packages/shared/src/i18n/zh-CN.ts b/packages/shared/src/i18n/zh-CN.ts
index b95021a5..6593abb8 100644
--- a/packages/shared/src/i18n/zh-CN.ts
+++ b/packages/shared/src/i18n/zh-CN.ts
@@ -765,6 +765,8 @@ export const zhCN = {
imageCompressionAria: "是否压缩笔记内图片",
showDescendantNotesTitle: "父笔记本中显示子笔记本笔记",
showDescendantNotesAria: "是否在父笔记本中显示子笔记本中的笔记",
+ spellcheckTitle: "标记拼写错误",
+ spellcheckAria: "是否在笔记编辑器中用波浪线标记可能的拼写错误",
aiSelectionMenuTitle: "选中文字时显示 AI 助手",
aiSelectionMenuAria: "选中文字时是否显示 AI 助手入口",
aiSpaceShortcutTitle: "空白段落按 Space 唤起 AI",