Skip to content

fix: Scrolling bug when clicking comment marks #2165

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

Merged
merged 3 commits into from
Nov 11, 2025
Merged

fix: Scrolling bug when clicking comment marks #2165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da07b62
Made comment marks get scrolled to on click instead of the floating t…
matthewlipski Nov 10, 2025
a5ccd28
Implemented PR feedback
matthewlipski Nov 10, 2025
8f82f5d
Added `autoUpdate` to `FloatingThreadController`
matthewlipski Nov 11, 2025
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
6 changes: 3 additions & 3 deletions packages/core/src/extensions/Comments/CommentsPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ export class CommentsPlugin extends BlockNoteExtension {
);

const threadId = commentMark?.attrs.threadId as string | undefined;
self.selectThread(threadId, false);
self.selectThread(threadId);
Copy link
Contributor

@nperez0111 nperez0111 Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the second param? Why is it removed

Copy link
Collaborator Author

@matthewlipski matthewlipski Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could set it to false to prevent scrolling to the mark (scrollToThread). We did this before and handled the scrolling in the Card component instead. Turns out. this was the only place it was set so I removed it outright.

},
},
}),
Expand All @@ -268,7 +268,7 @@ export class CommentsPlugin extends BlockNoteExtension {
/**
* Set the selected thread
*/
public selectThread(threadId: string | undefined, scrollToThread = true) {
public selectThread(threadId: string | undefined) {
if (this.selectedThreadId === threadId) {
return;
}
Expand All @@ -280,7 +280,7 @@ export class CommentsPlugin extends BlockNoteExtension {
}),
);

if (threadId && scrollToThread) {
if (threadId) {
const selectedThreadPosition = this.threadPositions.get(threadId);

if (!selectedThreadPosition) {
Expand Down
17 changes: 3 additions & 14 deletions packages/mantine/src/comments/Card.tsx
View file
Open in desktop
Copy link
Contributor

@nperez0111 nperez0111 Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Always happy to remove an effect!

Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { assertEmpty, mergeCSSClasses } from "@blocknote/core";
import { ComponentProps, mergeRefs } from "@blocknote/react";
import { ComponentProps } from "@blocknote/react";
import {
Card as MantineCard,
Divider as MantineDivider,
Text as MantineText,
} from "@mantine/core";
import { forwardRef, useEffect, useRef } from "react";
import { forwardRef } from "react";

export const Card = forwardRef<
HTMLDivElement,
Expand All @@ -24,24 +24,13 @@ export const Card = forwardRef<

assertEmpty(rest, false);

// Makes the card scroll into view when selected.
const scrollRef = useRef<HTMLDivElement>(null);
useEffect(() => {
if (selected) {
scrollRef.current?.scrollIntoView({
behavior: "smooth",
block: "center",
});
}
}, [selected]);

return (
<MantineCard
className={mergeCSSClasses(className, selected ? "selected" : "")}
onFocus={onFocus}
onBlur={onBlur}
tabIndex={tabIndex}
ref={mergeRefs([ref, scrollRef])}
ref={ref}
>
{headerText && (
<MantineText className={"bn-header-text"}>{headerText}</MantineText>
Expand Down
9 changes: 8 additions & 1 deletion packages/react/src/components/Comments/FloatingThreadController.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ import {
InlineContentSchema,
StyleSchema,
} from "@blocknote/core";
import { UseFloatingOptions, flip, offset, shift } from "@floating-ui/react";
import {
UseFloatingOptions,
autoUpdate,
flip,
offset,
shift,
} from "@floating-ui/react";
import {
ComponentProps,
FC,
Expand Down Expand Up @@ -55,6 +61,7 @@ export const FloatingThreadController = <
editor.focus();
}
},
whileElementsMounted: autoUpdate,
...props.floatingOptions,
});

Expand Down
Loading