Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Name CodeMirror editor textboxes for screen readers (#7653)

Nick Gomez818c148f0da4
diff --git a/.changeset/codemirror-textbox-names.md b/.changeset/codemirror-textbox-names.md
new file mode 100644
index 000000000..b3af009fe
--- /dev/null
+++ b/.changeset/codemirror-textbox-names.md
@@ -0,0 +1,5 @@
+---
+'@inkeep/open-knowledge': patch
+---
+
+Screen readers now announce a name for each source and code editor, such as Markdown source mode, text files and Mermaid diagram source.
diff --git a/packages/app/src/components/MermaidDocEditor.dom.test.tsx b/packages/app/src/components/MermaidDocEditor.dom.test.tsx
index 80a2cb18a..c292f7748 100644
--- a/packages/app/src/components/MermaidDocEditor.dom.test.tsx
+++ b/packages/app/src/components/MermaidDocEditor.dom.test.tsx
@@ -1,6 +1,6 @@
import type { HocuspocusProvider } from '@hocuspocus/provider';
import * as actualLinguiMacro from '@lingui/react/macro';
-import { cleanup, render } from '@testing-library/react';
+import { cleanup, render, waitFor, within } from '@testing-library/react';
import { afterEach, describe, expect, test, vi } from 'vitest';
import { Awareness } from 'y-protocols/awareness';
import * as Y from 'yjs';
@@ -64,6 +64,19 @@ afterEach(() => {
});
describe('MermaidDocEditor host contract', () => {
+ test('MermaidDocEditor host contract names the source-mode CodeMirror textbox', async () => {
+ const { container, unmount, dispose } = mountMermaidDocEditor(true);
+
+ await waitFor(() => {
+ expect(container.querySelector('.cm-content')).not.toBeNull();
+ });
+ const content = container.querySelector('.cm-content');
+ expect(within(container).getByRole('textbox', { name: /\S/ })).toBe(content);
+
+ unmount();
+ dispose();
+ });
+
test('renders the host attribute used by the composer-inset selector', () => {
const { container, unmount, dispose } = mountMermaidDocEditor(false);
diff --git a/packages/app/src/components/MermaidDocEditor.tsx b/packages/app/src/components/MermaidDocEditor.tsx
index bb1c6d6ca..ffd47edff 100644
--- a/packages/app/src/components/MermaidDocEditor.tsx
+++ b/packages/app/src/components/MermaidDocEditor.tsx
@@ -15,6 +15,7 @@ import { useTheme } from 'next-themes';
import { useEffect, useRef, useState } from 'react';
import { yCollab } from 'y-codemirror.next';
import type * as Y from 'yjs';
+import { codeMirrorContentAttributes } from '@/editor/code-mirror-content-attributes';
import { propEditorHighlight } from '@/editor/components/CodeMirrorPropInput';
import { type MermaidSourceBinding, MermaidView } from '@/editor/components/Mermaid';
import { okCmTheme } from '@/editor/extensions/cm-theme';
@@ -55,11 +56,13 @@ export function replaceYText(ytext: Y.Text, next: string, origin?: unknown): voi
}
function MermaidSourcePane({
+ contentLabel,
docName,
ytext,
provider,
undoManager,
}: {
+ contentLabel: string;
docName: string;
ytext: Y.Text;
provider: HocuspocusProvider;
@@ -76,6 +79,7 @@ function MermaidSourcePane({
state: EditorState.create({
doc: ytext.toString(),
extensions: [
+ codeMirrorContentAttributes(contentLabel),
basicSetup,
yCollab(ytext, provider.awareness, { undoManager }),
mermaid(),
@@ -92,7 +96,7 @@ function MermaidSourcePane({
unregisterFullPageCmView(docName, view);
view.destroy();
};
- }, [docName, ytext, provider, resolvedTheme, undoManager]);
+ }, [docName, ytext, provider, resolvedTheme, undoManager, contentLabel]);
return <div ref={containerRef} className="h-full min-h-0 overflow-auto" />;
}
@@ -228,6 +232,7 @@ export function MermaidDocEditor({
<div className="min-h-0 flex-1 overflow-hidden">
{isSourceMode ? (
<MermaidSourcePane
+ contentLabel={t`Mermaid diagram`}
docName={docName}
ytext={ytext}
provider={provider}
diff --git a/packages/app/src/components/TextDocEditor.dom.test.tsx b/packages/app/src/components/TextDocEditor.dom.test.tsx
index 0fd3fdd21..57a403de8 100644
--- a/packages/app/src/components/TextDocEditor.dom.test.tsx
+++ b/packages/app/src/components/TextDocEditor.dom.test.tsx
@@ -1,6 +1,6 @@
import type { HocuspocusProvider } from '@hocuspocus/provider';
import * as actualLinguiMacro from '@lingui/react/macro';
-import { cleanup, render } from '@testing-library/react';
+import { cleanup, render, waitFor, within } from '@testing-library/react';
import { afterEach, describe, expect, test, vi } from 'vitest';
import { Awareness } from 'y-protocols/awareness';
import * as Y from 'yjs';
@@ -58,6 +58,20 @@ afterEach(() => {
});
describe('TextDocEditor host contract', () => {
+ test('names the CodeMirror textbox', async () => {
+ const { container, unmount, dispose } = mountTextDocEditor();
+
+ await waitFor(() => {
+ expect(container.querySelector('.cm-content')).not.toBeNull();
+ });
+ expect(within(container).getByRole('textbox', { name: /\S/ })).toBe(
+ container.querySelector('.cm-content'),
+ );
+
+ unmount();
+ dispose();
+ });
+
test('renders the host attribute used by the composer-inset selector', () => {
const { container, unmount, dispose } = mountTextDocEditor();
diff --git a/packages/app/src/components/TextDocEditor.tsx b/packages/app/src/components/TextDocEditor.tsx
index 59ec8dc32..75f125f2c 100644
--- a/packages/app/src/components/TextDocEditor.tsx
+++ b/packages/app/src/components/TextDocEditor.tsx
@@ -17,6 +17,7 @@ import { basicSetup } from 'codemirror';
import { useTheme } from 'next-themes';
import { useEffect, useRef } from 'react';
import { yCollab } from 'y-codemirror.next';
+import { codeMirrorContentAttributes } from '@/editor/code-mirror-content-attributes';
import { propEditorHighlight } from '@/editor/components/CodeMirrorPropInput';
import { okCmTheme } from '@/editor/extensions/cm-theme';
import { registerFullPageCmView, unregisterFullPageCmView } from '@/editor/full-page-cm-views';
@@ -61,6 +62,7 @@ export function TextDocEditor({
state: EditorState.create({
doc: ytext.toString(),
extensions: [
+ codeMirrorContentAttributes(t`${basename} — text editor`),
basicSetup,
yCollab(ytext, provider.awareness, { undoManager }),
languageSlot.of([]),
@@ -89,7 +91,7 @@ export function TextDocEditor({
unregisterFullPageCmView(docName, view);
view.destroy();
};
- }, [ytext, provider, resolvedTheme, docName, undoManager]);
+ }, [ytext, provider, resolvedTheme, docName, undoManager, basename, t]);
return (
<section
diff --git a/packages/app/src/components/TextViewer.error-message.dom.test.tsx b/packages/app/src/components/TextViewer.error-message.dom.test.tsx
index 05a4bff42..af84dc3fa 100644
--- a/packages/app/src/components/TextViewer.error-message.dom.test.tsx
+++ b/packages/app/src/components/TextViewer.error-message.dom.test.tsx
@@ -1,4 +1,4 @@
-import { cleanup, render, waitFor } from '@testing-library/react';
+import { cleanup, render, waitFor, within } from '@testing-library/react';
import { afterEach, describe, expect, test } from 'vitest';
const { TextViewer } = await import('./TextViewer.tsx');
@@ -19,6 +19,22 @@ describe('TextViewer — human-readable load errors', () => {
globalThis.fetch = originalFetch;
});
+ test('TextViewer host contract names the CodeMirror textbox after a successful load', async () => {
+ const { container } = render(
+ <TextViewer
+ loadText={async () => ({ ok: true, text: 'plain text' })}
+ fileName="notes.txt"
+ extension="txt"
+ />,
+ );
+
+ await waitFor(() => {
+ expect(container.querySelector('.cm-content')).not.toBeNull();
+ });
+ const content = container.querySelector('.cm-content');
+ expect(within(container).getByRole('textbox', { name: /\S/ })).toBe(content);
+ });
+
test('413 renders a size-limit explanation, not a bare status code', async () => {
globalThis.fetch = mockFetchStatus(413);
const { container } = render(
diff --git a/packages/app/src/components/TextViewer.tsx b/packages/app/src/components/TextViewer.tsx
index 542908878..bd8baf5ee 100644
--- a/packages/app/src/components/TextViewer.tsx
+++ b/packages/app/src/components/TextViewer.tsx
@@ -5,6 +5,7 @@ import { codeLanguageForExtension } from '@inkeep/open-knowledge-core/constants/
import { basicSetup } from 'codemirror';
import { useTheme } from 'next-themes';
import { useEffect, useRef } from 'react';
+import { codeMirrorContentAttributes } from '@/editor/code-mirror-content-attributes';
import { okCmTheme, okSyntaxHighlight } from '@/editor/extensions/cm-theme';
import { loadCodeMirrorLanguageForExtension } from './text-viewer-languages';
import { useViewerText, type ViewerTextSource } from './use-viewer-text';
@@ -47,6 +48,7 @@ export function TextViewer({ fileName, extension, ...source }: TextViewerProps)
if (aborted) return;
if (!containerRef.current) return;
const extensions = [
+ codeMirrorContentAttributes(fileName),
basicSetup,
syntaxHighlighting(okSyntaxHighlight),
...(language ? [language] : []),
@@ -67,7 +69,7 @@ export function TextViewer({ fileName, extension, ...source }: TextViewerProps)
view?.destroy();
viewRef.current = null;
};
- }, [loadedContent, extension, resolvedTheme]);
+ }, [loadedContent, extension, resolvedTheme, fileName]);
const extraAttrs = { 'data-text-viewer-extension': extension };
if (fetchState.status === 'loading') {
diff --git a/packages/app/src/editor/SourceEditor.dom.test.tsx b/packages/app/src/editor/SourceEditor.dom.test.tsx
index 1f55115f4..c5f5daab1 100644
--- a/packages/app/src/editor/SourceEditor.dom.test.tsx
+++ b/packages/app/src/editor/SourceEditor.dom.test.tsx
@@ -2,7 +2,7 @@ import { EditorSelection } from '@codemirror/state';
import { EditorView } from '@codemirror/view';
import type { HocuspocusProvider } from '@hocuspocus/provider';
import type { Config } from '@inkeep/open-knowledge-core';
-import { act, cleanup, fireEvent, render, waitFor } from '@testing-library/react';
+import { act, cleanup, fireEvent, render, waitFor, within } from '@testing-library/react';
import { Activity } from 'react';
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
import { Awareness } from 'y-protocols/awareness';
@@ -44,6 +44,45 @@ vi.mock('./mode-switch-landing', async (importOriginal) => {
};
});
+const appLanguage = vi.hoisted(() => {
+ const english = (text: string) => text;
+ let translate = english;
+ const listeners = new Set<() => void>();
+ return {
+ current: () => translate,
+ subscribe(listener: () => void) {
+ listeners.add(listener);
+ return () => {
+ listeners.delete(listener);
+ };
+ },
+ switchTo(next: (text: string) => string) {
+ translate = next;
+ for (const listener of listeners) listener();
+ },
+ reset() {
+ translate = english;
+ },
+ };
+});
+
+vi.mock('@lingui/react/macro', async (importOriginal) => {
+ const actual = await importOriginal<typeof import('@lingui/react/macro')>();
+ const { useSyncExternalStore } = await import('react');
+ const { renderLinguiTemplate } = await import('@/test-utils/lingui-mock');
+ return {
+ ...actual,
+ useLingui: () => {
+ const translate = useSyncExternalStore(appLanguage.subscribe, appLanguage.current);
+ return {
+ ...actual.useLingui(),
+ t: (...args: Parameters<typeof renderLinguiTemplate>) =>
+ translate(renderLinguiTemplate(...args)),
+ };
+ },
+ };
+});
+
const originalFetch = globalThis.fetch;
(globalThis as { Window?: typeof window.Window }).Window = window.Window;
Object.defineProperty(window.Range.prototype, 'getClientRects', {
@@ -136,8 +175,32 @@ function setPlatform(platform: string): void {
}
describe('SourceEditor host contract', () => {
+ test('names the CodeMirror textbox', async () => {
+ const { provider, ytext } = makeProvider('source-editor-accessible-name');
+ const { container } = render(<Harness provider={provider} ytext={ytext} wordWrap={true} />);
+
+ const content = await findCmContent(container);
+
+ expect(within(container).getByRole('textbox', { name: /\S/ })).toBe(content);
+ });
+
+ test('renames the mounted CodeMirror textbox when the app language changes', async () => {
+ const { provider, ytext } = makeProvider('source-editor-language-switch');
+ const { container } = render(<Harness provider={provider} ytext={ytext} wordWrap={true} />);
+ const content = await findCmContent(container);
+ expect(within(container).getByRole('textbox', { name: 'Markdown source' })).toBe(content);
+
+ const french: Record<string, string> = { 'Markdown source': 'Source Markdown' };
+ act(() => {
+ appLanguage.switchTo((text) => french[text] ?? text);
+ });
+
+ expect(within(container).getByRole('textbox', { name: 'Source Markdown' })).toBe(content);
+ });
+
afterEach(() => {
cleanup();
+ appLanguage.reset();
for (const docName of mountedDocNames) {
evictCmEditor(docName);
}
diff --git a/packages/app/src/editor/SourceEditor.tsx b/packages/app/src/editor/SourceEditor.tsx
index 2d8fc134c..215ddcd7c 100644
--- a/packages/app/src/editor/SourceEditor.tsx
+++ b/packages/app/src/editor/SourceEditor.tsx
@@ -8,6 +8,7 @@ import {
type PersistedLinterConfig,
toEffectiveBase,
} from '@inkeep/open-knowledge-core/markdown/lint';
+import { useLingui } from '@lingui/react/macro';
import { useTheme } from 'next-themes';
import { useEffect, useRef, useState } from 'react';
import { yCollab, yUndoManagerKeymap } from 'y-codemirror.next';
@@ -29,6 +30,10 @@ import { emitDiagnosticBreadcrumb } from '@/lib/diagnostic-breadcrumb';
import { editorToolbarOverlapPx } from '@/lib/editor-toolbar-overlap';
import { claimNoteWindowInitialFocus } from '@/lib/note-window-focus';
import { createSourceClipboardExtension } from './clipboard/index.ts';
+import {
+ codeMirrorContentAttributes,
+ relabelCodeMirrorContent,
+} from './code-mirror-content-attributes';
import { type CmCacheEntry, mountCmEditor, parkCmEditor } from './editor-cache';
import { registerFullPageCmView, unregisterFullPageCmView } from './full-page-cm-views';
import { useDocLintConfig } from './lint-config-client';
@@ -163,6 +168,8 @@ export function SourceEditor({
const [mountError, setMountError] = useState<Error | null>(null);
if (mountError) throw mountError;
const { resolvedTheme } = useTheme();
+ const { t } = useLingui();
+ const contentLabel = t`Markdown source`;
const { merged } = useConfigContext();
const sourceModeActiveRef = useRef(isSourceModeActive);
const wordWrap = merged?.editor?.wordWrap ?? true;
@@ -175,7 +182,7 @@ export function SourceEditor({
const linterConfigKey = JSON.stringify(linterConfig);
const cmEntryRef = useRef<CmCacheEntry | null>(null);
- // biome-ignore lint/correctness/useExhaustiveDependencies: ytext and provider are the remount keys; docName is fixed for the lifetime of a mounted SourceEditor, and theme, wrap, placeholder and lint config reconfigure the live view through compartments
+ // biome-ignore lint/correctness/useExhaustiveDependencies: ytext and provider are the remount keys; docName is fixed for the lifetime of a mounted SourceEditor, and theme, wrap, placeholder, content label and lint config reconfigure the live view through compartments
useEffect(() => {
const container = containerRef.current;
if (!container) return;
@@ -208,6 +215,7 @@ export function SourceEditor({
const state = EditorState.create({
doc: ytext.toString(),
extensions: [
+ codeMirrorContentAttributes(contentLabel),
sourceModeSetup,
sourceLineDirection,
search({
@@ -376,6 +384,12 @@ export function SourceEditor({
});
}, [placeholder]);
+ useEffect(() => {
+ const entry = cmEntryRef.current;
+ if (!entry) return;
+ relabelCodeMirrorContent(entry.view, contentLabel);
+ }, [contentLabel]);
+
// biome-ignore lint/correctness/useExhaustiveDependencies: linterConfig is keyed by linterConfigKey
useEffect(() => {
const entry = cmEntryRef.current;
diff --git a/packages/app/src/editor/code-mirror-content-attributes.ts b/packages/app/src/editor/code-mirror-content-attributes.ts
new file mode 100644
index 000000000..925f970a5
--- /dev/null
+++ b/packages/app/src/editor/code-mirror-content-attributes.ts
@@ -0,0 +1,16 @@
+import { Compartment } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+
+const contentLabelCompartment = new Compartment();
+
+function contentLabelAttributes(label: string) {
+ return EditorView.contentAttributes.of({ 'aria-label': label });
+}
+
+export function codeMirrorContentAttributes(label: string) {
+ return contentLabelCompartment.of(contentLabelAttributes(label));
+}
+
+export function relabelCodeMirrorContent(view: EditorView, label: string): void {
+ view.dispatch({ effects: contentLabelCompartment.reconfigure(contentLabelAttributes(label)) });
+}
diff --git a/packages/app/src/editor/components/CodePreviewEditModal.dom.test.tsx b/packages/app/src/editor/components/CodePreviewEditModal.dom.test.tsx
index ed47c5b9a..1287912cc 100644
--- a/packages/app/src/editor/components/CodePreviewEditModal.dom.test.tsx
+++ b/packages/app/src/editor/components/CodePreviewEditModal.dom.test.tsx
@@ -1,5 +1,5 @@
import { EditorView } from '@codemirror/view';
-import { act, cleanup, fireEvent, render, screen, waitFor } from '@testing-library/react';
+import { act, cleanup, fireEvent, render, screen, waitFor, within } from '@testing-library/react';
import { useState } from 'react';
import { afterEach, describe, expect, test } from 'vitest';
import { CodePreviewEditModal } from './CodePreviewEditModal';
@@ -45,6 +45,17 @@ function Harness(props: {
}
describe('CodePreviewEditModal', () => {
+ test('CodePreviewEditModal names the CodeMirror textbox', async () => {
+ render(<Harness onSave={() => {}} />);
+ const host = await screen.findByTestId('ok-code-preview-edit-modal-source');
+
+ await waitFor(() => {
+ expect(host.querySelector('.cm-content')).not.toBeNull();
+ });
+ const content = host.querySelector('.cm-content');
+ expect(within(host).getByRole('textbox', { name: /\S/ })).toBe(content);
+ });
+
test('Cancel discards the draft (onSave not called)', async () => {
let saveCount = 0;
render(
diff --git a/packages/app/src/editor/components/CodePreviewEditModal.tsx b/packages/app/src/editor/components/CodePreviewEditModal.tsx
index aa6151c09..1f284bd3a 100644
--- a/packages/app/src/editor/components/CodePreviewEditModal.tsx
+++ b/packages/app/src/editor/components/CodePreviewEditModal.tsx
@@ -28,6 +28,10 @@ import {
DialogTitle,
} from '@/components/ui/dialog';
import { Kbd } from '@/components/ui/kbd';
+import {
+ codeMirrorContentAttributes,
+ relabelCodeMirrorContent,
+} from '@/editor/code-mirror-content-attributes';
import { propEditorHighlight } from './CodeMirrorPropInput';
type SupportedLanguage =
@@ -118,12 +122,18 @@ export function CodePreviewEditModal({
const viewRef = useRef<EditorView | null>(null);
const languageRef = useRef(language);
const initialValueRef = useRef(initialValue);
+ const titleRef = useRef(title);
useEffect(() => {
languageRef.current = language;
}, [language]);
useEffect(() => {
initialValueRef.current = initialValue;
}, [initialValue]);
+ useEffect(() => {
+ titleRef.current = title;
+ const view = viewRef.current;
+ if (view) relabelCodeMirrorContent(view, title);
+ }, [title]);
const setHostRef = (host: HTMLDivElement | null) => {
if (!host) {
@@ -139,6 +149,7 @@ export function CodePreviewEditModal({
const state = EditorState.create({
doc: initialValueRef.current,
extensions: [
+ codeMirrorContentAttributes(titleRef.current),
lineNumbers(),
history(),
indentOnInput(),
diff --git a/packages/app/src/editor/extensions/RawMdxFallbackCMView.dom.test.tsx b/packages/app/src/editor/extensions/RawMdxFallbackCMView.dom.test.tsx
index 3ea1920ba..a2cf98dc9 100644
--- a/packages/app/src/editor/extensions/RawMdxFallbackCMView.dom.test.tsx
+++ b/packages/app/src/editor/extensions/RawMdxFallbackCMView.dom.test.tsx
@@ -1,10 +1,49 @@
import type { Config } from '@inkeep/open-knowledge-core';
-import { cleanup, render, waitFor } from '@testing-library/react';
+import { act, cleanup, render, waitFor, within } from '@testing-library/react';
import type { NodeViewProps } from '@tiptap/core';
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
import { ConfigContext, type ConfigContextValue } from '@/lib/config-context';
import { RawMdxFallbackView } from './RawMdxFallbackCMView';
+const appLanguage = vi.hoisted(() => {
+ const english = (text: string) => text;
+ let translate = english;
+ const listeners = new Set<() => void>();
+ return {
+ current: () => translate,
+ subscribe(listener: () => void) {
+ listeners.add(listener);
+ return () => {
+ listeners.delete(listener);
+ };
+ },
+ switchTo(next: (text: string) => string) {
+ translate = next;
+ for (const listener of listeners) listener();
+ },
+ reset() {
+ translate = english;
+ },
+ };
+});
+
+vi.mock('@lingui/react/macro', async (importOriginal) => {
+ const actual = await importOriginal<typeof import('@lingui/react/macro')>();
+ const { useSyncExternalStore } = await import('react');
+ const { renderLinguiTemplate } = await import('@/test-utils/lingui-mock');
+ return {
+ ...actual,
+ useLingui: () => {
+ const translate = useSyncExternalStore(appLanguage.subscribe, appLanguage.current);
+ return {
+ ...actual.useLingui(),
+ t: (...args: Parameters<typeof renderLinguiTemplate>) =>
+ translate(renderLinguiTemplate(...args)),
+ };
+ },
+ };
+});
+
const originalFetch = globalThis.fetch;
(globalThis as { Window?: typeof window.Window }).Window = window.Window;
@@ -101,6 +140,38 @@ describe('RawMdxFallbackView word-wrap preference wiring', () => {
afterEach(() => {
globalThis.fetch = originalFetch;
cleanup();
+ appLanguage.reset();
+ });
+
+ test('RawMdxFallbackView names the nested CodeMirror textbox', async () => {
+ const props = makeProps();
+ const { container } = render(<Harness props={props} wordWrap={true} />);
+
+ const content = await findCmContent(container);
+ expect(within(container).getByRole('textbox', { name: /\S/ })).toBe(content);
+ });
+
+ test('renames the mounted nested CodeMirror textbox when the app language changes', async () => {
+ const props = makeProps();
+ const { container } = render(<Harness props={props} wordWrap={true} />);
+ const content = await findCmContent(container);
+ expect(
+ within(container).getByRole('textbox', { name: 'Editing broken MDX source: Parse failed' }),
+ ).toBe(content);
+
+ const french: Record<string, string> = {
+ 'Editing broken MDX source: Parse failed':
+ 'Modification de la source MDX invalide : Parse failed',
+ };
+ act(() => {
+ appLanguage.switchTo((text) => french[text] ?? text);
+ });
+
+ expect(
+ within(container).getByRole('textbox', {
+ name: 'Modification de la source MDX invalide : Parse failed',
+ }),
+ ).toBe(content);
});
test('applies editor.wordWrap to the nested CodeMirror instance', async () => {
diff --git a/packages/app/src/editor/extensions/RawMdxFallbackCMView.tsx b/packages/app/src/editor/extensions/RawMdxFallbackCMView.tsx
index 772eefdb5..39e79496c 100644
--- a/packages/app/src/editor/extensions/RawMdxFallbackCMView.tsx
+++ b/packages/app/src/editor/extensions/RawMdxFallbackCMView.tsx
@@ -15,6 +15,10 @@ import { NodeViewWrapper } from '@tiptap/react';
import { Trash2 } from 'lucide-react';
import { useTheme } from 'next-themes';
import { useEffect, useRef } from 'react';
+import {
+ codeMirrorContentAttributes,
+ relabelCodeMirrorContent,
+} from '@/editor/code-mirror-content-attributes';
import { useConfigContext } from '@/lib/config-provider';
import { markUserTyping } from '../observers';
import { getEditorView } from '../utils/get-editor-view';
@@ -148,6 +152,7 @@ export function RawMdxFallbackView({ node, editor, getPos }: NodeViewProps) {
const { merged } = useConfigContext();
const wordWrap = merged?.editor?.wordWrap ?? true;
const reason = (node.attrs.reason as string) || t`Parse failed`;
+ const contentLabel = t`Editing broken MDX source: ${reason}`;
const severity = classifySeverity(reason);
const style = SEVERITY_STYLES[severity];
const unregisteredComponentName =
@@ -184,7 +189,7 @@ export function RawMdxFallbackView({ node, editor, getPos }: NodeViewProps) {
updatingRef.current = false;
};
- // biome-ignore lint/correctness/useExhaustiveDependencies: CM view mounts once imperatively; re-mount on deps change would destroy the editor state. Theme/word-wrap handled by separate compartment effects; content sync handled by PM→CM sync effect below.
+ // biome-ignore lint/correctness/useExhaustiveDependencies: CM view mounts once imperatively; re-mount on deps change would destroy the editor state. Theme, word-wrap and the content label handled by separate compartment effects; content sync handled by PM→CM sync effect below.
useEffect(() => {
const container = cmContainerRef.current;
if (!container) return;
@@ -258,6 +263,7 @@ export function RawMdxFallbackView({ node, editor, getPos }: NodeViewProps) {
extraKeymaps: undoRedoKeymap,
});
extensions.push(escapeKeymap);
+ extensions.push(codeMirrorContentAttributes(contentLabel));
extensions.push(
CMEditorView.updateListener.of((update) => {
@@ -363,6 +369,12 @@ export function RawMdxFallbackView({ node, editor, getPos }: NodeViewProps) {
});
}, [wordWrap]);
+ useEffect(() => {
+ const cmView = cmViewRef.current;
+ if (!cmView) return;
+ relabelCodeMirrorContent(cmView, contentLabel);
+ }, [contentLabel]);
+
useEffect(() => {
const handler = () => {
const pos = typeof getPos === 'function' ? getPos() : undefined;