Skip to content

fix: correct return type of getDefaultReactSlashMenuItems to include key #2416

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

Open
ysds wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −2
Open

fix: correct return type of getDefaultReactSlashMenuItems to include key #2416

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
2 changes: 1 addition & 1 deletion packages/react/src/blocks/PageBreak/getPageBreakReactSlashMenuItems.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export function getPageBreakReactSlashMenuItems<
S extends StyleSchema,
>(
editor: BlockNoteEditor<BSchema, I, S>,
): (Omit<DefaultReactSuggestionItem, "key"> & { key: "page_break" })[] {
): (DefaultReactSuggestionItem & { key: "page_break" })[] {
return getPageBreakSlashMenuItems(editor).map((item) => {
const Icon = icons[item.key];
return {
Expand Down
7 changes: 6 additions & 1 deletion packages/react/src/components/SuggestionMenu/getDefaultReactSlashMenuItems.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {
BlockNoteEditor,
BlockSchema,
Dictionary,
InlineContentSchema,
StyleSchema,
} from "@blocknote/core";
Expand Down Expand Up @@ -61,7 +62,11 @@ export function getDefaultReactSlashMenuItems<
BSchema extends BlockSchema,
I extends InlineContentSchema,
S extends StyleSchema,
>(editor: BlockNoteEditor<BSchema, I, S>): DefaultReactSuggestionItem[] {
>(
editor: BlockNoteEditor<BSchema, I, S>,
): (DefaultReactSuggestionItem & {
key: keyof Omit<Dictionary["slash_menu"], "page_break">;
Copy link
Contributor

@nperez0111 nperez0111 Feb 4, 2026

Choose a reason for hiding this comment

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

I don't think this is correct right? Aren't you marking all of the items as having a page_break key, when that is not actually the case. Shouldn't you change DefaultReactSuggestionItem instead?

Copy link
Contributor Author

@ysds ysds Feb 5, 2026

Choose a reason for hiding this comment

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

Thanks for taking a look. I’ll check it out.

Copy link
Contributor Author

@ysds ysds Feb 5, 2026

Choose a reason for hiding this comment

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

To clarify, Omit<Dictionary["slash_menu"], "page_break"> here represents "a union of keys excluding page_break", not "marking items as having a page_break key". This pattern follows the same approach used in the DefaultSuggestionItem.ts

I believe the current implementation is correct, but I do agree that modifying DefaultReactSuggestionItem could be a better approach.

However, changing DefaultReactSuggestionItem requires a deeper understanding of BlockNote's design decisions. The key property was removed from DefaultReactSuggestionItem in #652, but the PR doesn't explain why. I can only speculate on the reasons:

  • Potential conflicts with React's key prop
  • Custom suggestion items may not need a key

Making changes to DefaultReactSuggestionItem feels beyond my current understanding of the codebase. This PR at least addresses the immediate type issue.

})[] {
return getDefaultSlashMenuItems(editor).map((item) => {
const Icon = icons[item.key];
return {
Expand Down
Loading