Skip to content

fix(frontend): prevent markdown editor from scrolling to bottom on Enter key #3843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mmabrouk wants to merge 1 commit into
base: main
Choose a base branch
from
+100 −14
Draft

fix(frontend): prevent markdown editor from scrolling to bottom on Enter key #3843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 50 additions & 7 deletions web/oss/src/components/Editor/plugins/markdown/markdownPlugin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,19 +123,47 @@ const MarkdownPlugin = ({id}: {id: string}) => {
return editor.registerCommand(
KEY_ENTER_COMMAND,
(event) => {
editor.update(() => {
// Read-only check: determine if cursor is inside a markdown CodeNode
const shouldHandle = editor.getEditorState().read(() => {
const selection = $getSelection()
if (!$isRangeSelection(selection)) return false

const anchorNode = selection.anchor.getNode()
const topNode = anchorNode.getTopLevelElementOrThrow()
return $isCodeNode(topNode) && topNode.getLanguage() === "markdown"
})

if (!shouldHandle) return false

event?.preventDefault()

// Save scroll position before inserting text to prevent
// the browser from auto-scrolling to the bottom
const rootElement = editor.getRootElement()
const scrollContainer = rootElement?.closest(
".agenta-editor-wrapper",
) as HTMLElement | null
const savedScrollTop = scrollContainer?.scrollTop ?? 0
const savedElementScrollTop = rootElement?.scrollTop ?? 0

// {discrete: true} ensures DOM is flushed synchronously
editor.update(
() => {
const selection = $getSelection()
if ($isRangeSelection(selection)) {
selection.insertRawText("\n")
}
},
{discrete: true},
)

if ($isCodeNode(topNode) && topNode.getLanguage() === "markdown") {
event?.preventDefault()
selection.insertRawText("\n")
return true
}
// Restore scroll after DOM flush.
// Use rAF to also cover the merge-back update from
// the registerUpdateListener that follows this effect.
requestAnimationFrame(() => {
if (scrollContainer) scrollContainer.scrollTop = savedScrollTop
if (rootElement) rootElement.scrollTop = savedElementScrollTop
})

return true
},
COMMAND_PRIORITY_HIGH,
Expand All @@ -157,13 +185,28 @@ const MarkdownPlugin = ({id}: {id: string}) => {
const trailingNodes = children.slice(index + 1)

if (trailingNodes.length > 0) {
// Save scroll position before merging trailing nodes back,
// as this second editor.update() can also trigger scroll jumps
const rootElement = editor.getRootElement()
const scrollContainer = rootElement?.closest(
".agenta-editor-wrapper",
) as HTMLElement | null
const savedScrollTop = scrollContainer?.scrollTop ?? 0
const savedElementScrollTop = rootElement?.scrollTop ?? 0

editor.update(() => {
for (const node of trailingNodes) {
const content = node.getTextContent()
markdownCodeNode.append($createTextNode("\n" + content))
node.remove()
}
})

// Restore scroll after the merge-back DOM update
requestAnimationFrame(() => {
if (scrollContainer) scrollContainer.scrollTop = savedScrollTop
if (rootElement) rootElement.scrollTop = savedElementScrollTop
})
}
})
})
Expand Down
57 changes: 50 additions & 7 deletions web/packages/agenta-ui/src/Editor/plugins/markdown/markdownPlugin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,19 +124,47 @@ const MarkdownPlugin = ({id}: {id: string}) => {
return editor.registerCommand(
KEY_ENTER_COMMAND,
(event) => {
editor.update(() => {
// Read-only check: determine if cursor is inside a markdown CodeNode
const shouldHandle = editor.getEditorState().read(() => {
const selection = $getSelection()
if (!$isRangeSelection(selection)) return false

const anchorNode = selection.anchor.getNode()
const topNode = anchorNode.getTopLevelElementOrThrow()
return $isCodeNode(topNode) && topNode.getLanguage() === "markdown"
})

if (!shouldHandle) return false

event?.preventDefault()

// Save scroll position before inserting text to prevent
// the browser from auto-scrolling to the bottom
const rootElement = editor.getRootElement()
const scrollContainer = rootElement?.closest(
".agenta-editor-wrapper",
) as HTMLElement | null
const savedScrollTop = scrollContainer?.scrollTop ?? 0
const savedElementScrollTop = rootElement?.scrollTop ?? 0

// {discrete: true} ensures DOM is flushed synchronously
editor.update(
() => {
const selection = $getSelection()
if ($isRangeSelection(selection)) {
selection.insertRawText("\n")
}
},
{discrete: true},
)

if ($isCodeNode(topNode) && topNode.getLanguage() === "markdown") {
event?.preventDefault()
selection.insertRawText("\n")
return true
}
// Restore scroll after DOM flush.
// Use rAF to also cover the merge-back update from
// the registerUpdateListener that follows this effect.
requestAnimationFrame(() => {
if (scrollContainer) scrollContainer.scrollTop = savedScrollTop
if (rootElement) rootElement.scrollTop = savedElementScrollTop
})

return true
},
COMMAND_PRIORITY_HIGH,
Expand All @@ -158,6 +186,15 @@ const MarkdownPlugin = ({id}: {id: string}) => {
const trailingNodes = children.slice(index + 1)

if (trailingNodes.length > 0) {
// Save scroll position before merging trailing nodes back,
// as this second editor.update() can also trigger scroll jumps
const rootElement = editor.getRootElement()
const scrollContainer = rootElement?.closest(
".agenta-editor-wrapper",
) as HTMLElement | null
const savedScrollTop = scrollContainer?.scrollTop ?? 0
const savedElementScrollTop = rootElement?.scrollTop ?? 0

editor.update(() => {
for (const node of trailingNodes) {
const content = node.getTextContent()
Expand All @@ -167,6 +204,12 @@ const MarkdownPlugin = ({id}: {id: string}) => {
node.remove()
}
})

// Restore scroll after the merge-back DOM update
requestAnimationFrame(() => {
if (scrollContainer) scrollContainer.scrollTop = savedScrollTop
if (rootElement) rootElement.scrollTop = savedElementScrollTop
})
}
})
})
Expand Down