Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
148 changes: 83 additions & 65 deletions packages/react/src/components/Comments/Comment.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,88 @@ export const Comment = ({

const user = useUser(comment.userId);

const CommentEditorActions = useCallback(
({ isEmpty }: { isFocused: boolean; isEmpty: boolean }) => {
const canAddReaction = threadStore.auth.canAddReaction(comment);

return (
<>
{comment.reactions.length > 0 && !isEditing && (
<Components.Generic.Badge.Group
className={mergeCSSClasses(
"bn-badge-group",
"bn-comment-reactions",
)}
>
{comment.reactions.map((reaction) => (
<ReactionBadge
key={reaction.emoji}
comment={comment}
emoji={reaction.emoji}
onReactionSelect={onReactionSelect}
/>
))}
{canAddReaction && (
<EmojiPicker
onEmojiSelect={(emoji: { native: string }) =>
onReactionSelect(emoji.native)
}
onOpenChange={setEmojiPickerOpen}
>
<Components.Generic.Badge.Root
className={mergeCSSClasses(
"bn-badge",
"bn-comment-add-reaction",
)}
text={"+"}
icon={<RiEmotionLine size={16} />}
mainTooltip={dict.comments.actions.add_reaction}
/>
</EmojiPicker>
)}
</Components.Generic.Badge.Group>
)}
{isEditing && (
<Components.Generic.Toolbar.Root
variant="action-toolbar"
className={mergeCSSClasses(
"bn-action-toolbar",
"bn-comment-actions",
)}
>
<Components.Generic.Toolbar.Button
mainTooltip={dict.comments.save_button_text}
variant="compact"
onClick={onEditSubmit}
isDisabled={isEmpty}
>
{dict.comments.save_button_text}
</Components.Generic.Toolbar.Button>
<Components.Generic.Toolbar.Button
className={"bn-button"}
mainTooltip={dict.comments.cancel_button_text}
variant="compact"
onClick={onEditCancel}
>
{dict.comments.cancel_button_text}
</Components.Generic.Toolbar.Button>
</Components.Generic.Toolbar.Root>
)}
</>
);
},
[
comment,
isEditing,
threadStore,
onReactionSelect,
onEditSubmit,
onEditCancel,
Components,
dict,
],
);

if (!comment.body) {
return null;
}
Expand Down Expand Up @@ -249,71 +331,7 @@ export const Comment = ({
editable={isEditing}
actions={
comment.reactions.length > 0 || isEditing
? ({ isEmpty }) => (
<>
{comment.reactions.length > 0 && !isEditing && (
<Components.Generic.Badge.Group
className={mergeCSSClasses(
"bn-badge-group",
"bn-comment-reactions",
)}
>
{comment.reactions.map((reaction) => (
<ReactionBadge
key={reaction.emoji}
comment={comment}
emoji={reaction.emoji}
onReactionSelect={onReactionSelect}
/>
))}
{canAddReaction && (
<EmojiPicker
onEmojiSelect={(emoji: { native: string }) =>
onReactionSelect(emoji.native)
}
onOpenChange={setEmojiPickerOpen}
>
<Components.Generic.Badge.Root
className={mergeCSSClasses(
"bn-badge",
"bn-comment-add-reaction",
)}
text={"+"}
icon={<RiEmotionLine size={16} />}
mainTooltip={dict.comments.actions.add_reaction}
/>
</EmojiPicker>
)}
</Components.Generic.Badge.Group>
)}
{isEditing && (
<Components.Generic.Toolbar.Root
variant="action-toolbar"
className={mergeCSSClasses(
"bn-action-toolbar",
"bn-comment-actions",
)}
>
<Components.Generic.Toolbar.Button
mainTooltip={dict.comments.save_button_text}
variant="compact"
onClick={onEditSubmit}
isDisabled={isEmpty}
>
{dict.comments.save_button_text}
</Components.Generic.Toolbar.Button>
<Components.Generic.Toolbar.Button
className={"bn-button"}
mainTooltip={dict.comments.cancel_button_text}
variant="compact"
onClick={onEditCancel}
>
{dict.comments.cancel_button_text}
</Components.Generic.Toolbar.Button>
</Components.Generic.Toolbar.Root>
)}
</>
)
? CommentEditorActions
: undefined
}
/>
Expand Down
67 changes: 34 additions & 33 deletions packages/react/src/components/Comments/FloatingComposer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
StyleSchema,
} from "@blocknote/core";
import { CommentsExtension } from "@blocknote/core/comments";
import { useCallback } from "react";

import { useComponentsContext } from "../../editor/ComponentsContext.js";
import { useCreateBlockNote } from "../../hooks/useCreateBlockNote.js";
Expand Down Expand Up @@ -46,45 +47,45 @@ export function FloatingComposer<
schema: comments.commentEditorSchema || defaultCommentEditorSchema,
});

const Actions = useCallback(
({ isEmpty }: { isFocused: boolean; isEmpty: boolean }) => (
<Components.Generic.Toolbar.Root
className={mergeCSSClasses("bn-action-toolbar", "bn-comment-actions")}
variant="action-toolbar"
>
<Components.Generic.Toolbar.Button
className={"bn-button"}
mainTooltip={dict.comments.save_button_text}
variant="compact"
isDisabled={isEmpty}
onClick={async () => {
// (later) For REST API, we should implement a loading state and error state
await comments.createThread({
initialComment: {
body: newCommentEditor.document,
},
});
comments.stopPendingComment();
editor.transact((tr) => {
tr.setSelection(TextSelection.create(tr.doc, tr.selection.to));
});
editor.focus();
}}
>
{dict.comments.save_button_text}
</Components.Generic.Toolbar.Button>
</Components.Generic.Toolbar.Root>
),
[Components, dict, comments, newCommentEditor, editor],
);

return (
<Components.Comments.Card className={"bn-thread"}>
<CommentEditor
autoFocus={true}
editable={true}
editor={newCommentEditor}
actions={({ isEmpty }) => (
<Components.Generic.Toolbar.Root
className={mergeCSSClasses(
"bn-action-toolbar",
"bn-comment-actions",
)}
variant="action-toolbar"
>
<Components.Generic.Toolbar.Button
className={"bn-button"}
mainTooltip={dict.comments.save_button_text}
variant="compact"
isDisabled={isEmpty}
onClick={async () => {
// (later) For REST API, we should implement a loading state and error state
await comments.createThread({
initialComment: {
body: newCommentEditor.document,
},
});
comments.stopPendingComment();
editor.transact((tr) => {
tr.setSelection(
TextSelection.create(tr.doc, tr.selection.to),
);
});
editor.focus();
}}
>
{dict.comments.save_button_text}
</Components.Generic.Toolbar.Button>
</Components.Generic.Toolbar.Root>
)}
actions={Actions}
/>
</Components.Comments.Card>
);
Expand Down
50 changes: 26 additions & 24 deletions packages/react/src/components/Comments/Thread.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,31 @@ export const Thread = ({
newCommentEditor.removeBlocks(newCommentEditor.document);
}, [comments, newCommentEditor, thread.id]);

const ReplyActions = useCallback(
({ isEmpty }: { isFocused: boolean; isEmpty: boolean }) => {
if (isEmpty) {
return null;
}

return (
<Components.Generic.Toolbar.Root
variant="action-toolbar"
className={mergeCSSClasses("bn-action-toolbar", "bn-comment-actions")}
>
<Components.Generic.Toolbar.Button
mainTooltip={dict.comments.save_button_text}
variant="compact"
isDisabled={isEmpty}
onClick={onNewCommentSave}
>
{dict.comments.save_button_text}
</Components.Generic.Toolbar.Button>
</Components.Generic.Toolbar.Root>
);
},
[Components, dict, onNewCommentSave],
);

return (
<Components.Comments.Card
className={"bn-thread"}
Expand All @@ -115,30 +140,7 @@ export const Thread = ({
autoFocus={false}
editable={true}
editor={newCommentEditor}
actions={({ isEmpty }) => {
if (isEmpty) {
return null;
}

return (
<Components.Generic.Toolbar.Root
variant="action-toolbar"
className={mergeCSSClasses(
"bn-action-toolbar",
"bn-comment-actions",
)}
>
<Components.Generic.Toolbar.Button
mainTooltip={dict.comments.save_button_text}
variant="compact"
isDisabled={isEmpty}
onClick={onNewCommentSave}
>
{dict.comments.save_button_text}
</Components.Generic.Toolbar.Button>
</Components.Generic.Toolbar.Root>
);
}}
actions={ReplyActions}
/>
</Components.Comments.CardSection>
)}
Expand Down
46 changes: 45 additions & 1 deletion tests/src/end-to-end/comments/comments.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,54 @@ import { test } from "../../setup/setupScript.js";
import { COMMENTS_URL, LINK_BUTTON_SELECTOR } from "../../utils/const.js";
import { focusOnEditor } from "../../utils/editor.js";

const EMOJI_BUTTON_SELECTOR = "em-emoji-picker button[aria-posinset]";

test.beforeEach(async ({ page }) => {
await page.goto(COMMENTS_URL);
});

test.describe("Check Comments functionality", () => {
test("Should be able to add reactions", async ({ page }) => {
await focusOnEditor(page);

await page.keyboard.type("hello");
await page.locator("text=hello").dblclick();

await page.click('[data-test="addcomment"]');
await page.waitForSelector(".bn-thread");

await page.keyboard.type("test comment");
await page.click('button[data-test="save"]');

// Wait for comment composer to close.
await expect(page.locator(".bn-thread")).toHaveCount(0);

await page.locator("span.bn-thread-mark").first().click();
await expect(page.locator(".bn-thread-comment")).toBeVisible();

// Hover comment to reveal action toolbar.
await page.locator(".bn-thread-comment").first().hover();
await expect(page.locator('[data-test="addreaction"]')).toBeVisible();

// Add a reaction via the action toolbar's add-reaction button.
await page.click('[data-test="addreaction"]');
await expect(page.locator(EMOJI_BUTTON_SELECTOR).first()).toBeVisible();
await page.locator(EMOJI_BUTTON_SELECTOR).first().click();
await expect(page.locator("em-emoji-picker")).toHaveCount(0);
await expect(page.locator(".bn-comment-reaction")).toHaveCount(1);

// Add a second reaction via the add-reaction badge.
await page.locator(".bn-thread-comment").first().hover();
await page.click(".bn-comment-add-reaction");
await expect(page.locator(EMOJI_BUTTON_SELECTOR).first()).toBeVisible();

// Pick a different emoji so it's added as a new reaction rather than
// toggling the first one off.
await page.locator(EMOJI_BUTTON_SELECTOR).nth(5).click();
await expect(page.locator("em-emoji-picker")).toHaveCount(0);
await expect(page.locator(".bn-comment-reaction")).toHaveCount(2);
});

test("Should preserve existing comments when adding a link", async ({
page,
}) => {
Expand All @@ -30,7 +73,7 @@ test.describe("Check Comments functionality", () => {
await page.keyboard.type("https://example.com");
await page.keyboard.press("Enter");

await expect(await page.locator("span.bn-thread-mark")).toBeVisible();
await expect(page.locator("span.bn-thread-mark")).toBeVisible();
});

test("Should select thread on first click and open link on second click", async ({
Expand Down Expand Up @@ -64,6 +107,7 @@ test.describe("Check Comments functionality", () => {
await page.keyboard.press("ArrowDown");
await page.waitForTimeout(500);
await expect(page.locator(".bn-thread-mark-selected")).toHaveCount(0);
await expect(page.locator(".bn-formatting-toolbar")).toBeHidden();

const link = page.locator('a[data-inline-content-type="link"]').first();

Expand Down
Loading