Skip to content

fix: Backspace/enter behaviour in empty block with children #2451

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
matthewlipski wants to merge 1 commit into
base: main
Choose a base branch
from
+704 −12
Open

fix: Backspace/enter behaviour in empty block with children #2451

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
42 changes: 31 additions & 11 deletions ...ges/core/src/extensions/tiptap-extensions/KeyboardShortcuts/KeyboardShortcutsExtension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,13 @@ export const KeyboardShortcutsExtension = Extension.create<{

let chainedCommands = chain();

if (blockInfo.childContainer) {
chainedCommands.insertContentAt(
blockInfo.bnBlock.afterPos,
blockInfo.childContainer?.node.content,
);
}

if (
prevBlockInfo.blockContent.node.type.spec.content ===
"tableRow+"
Expand All @@ -209,8 +216,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
);
} else {
const blockContentStartPos =
prevBlockInfo.blockContent.afterPos -
prevBlockInfo.blockContent.node.nodeSize;
prevBlockInfo.blockContent.afterPos - 1;

chainedCommands =
chainedCommands.setTextSelection(blockContentStartPos);
Expand Down Expand Up @@ -413,7 +419,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
// Creates a new block and moves the selection to it if the current one is empty, while the selection is also
// empty & at the start of the block.
() =>
commands.command(({ state, dispatch }) => {
commands.command(({ state, dispatch, tr }) => {
const blockInfo = getBlockInfoFromSelection(state);
if (!blockInfo.isBlockContainer) {
return false;
Expand All @@ -431,15 +437,29 @@ export const KeyboardShortcutsExtension = Extension.create<{
const newBlockContentPos = newBlockInsertionPos + 2;

if (dispatch) {
const newBlock =
state.schema.nodes["blockContainer"].createAndFill()!;

state.tr
.insert(newBlockInsertionPos, newBlock)
const newBlock = state.schema.nodes[
"blockContainer"
].createAndFill(
undefined,
[
state.schema.nodes["paragraph"].createAndFill() ||
undefined,
blockInfo.childContainer?.node,
].filter((node) => node !== undefined),
)!;

tr.insert(newBlockInsertionPos, newBlock)
.setSelection(
new TextSelection(tr.doc.resolve(newBlockContentPos)),
)
.scrollIntoView();
state.tr.setSelection(
new TextSelection(state.doc.resolve(newBlockContentPos)),
);

if (blockInfo.childContainer) {
tr.delete(
blockInfo.childContainer.beforePos,
blockInfo.childContainer.afterPos,
);
}
}

return true;
Expand Down
44 changes: 43 additions & 1 deletion tests/src/end-to-end/keyboardhandlers/keyboardhandlers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,32 @@ test.describe("Check Keyboard Handlers' Behaviour", () => {
await page.keyboard.press("ArrowUp");
await page.keyboard.press("ArrowUp");
await page.keyboard.press("ArrowUp");
await page.keyboard.press("ArrowUp");
await page.keyboard.press("Control+ArrowLeft");
await page.keyboard.press("ArrowRight");
await page.keyboard.press("Enter");

await compareDocToSnapshot(page, "enterPreservesNestedBlocks.json");
});
test("Check Enter preserves nested blocks for empty block", async ({
page,
}) => {
await focusOnEditor(page);
await page.keyboard.press("#");
await page.keyboard.press(" ");
await page.keyboard.press("ArrowDown", { delay: 10 });
await page.keyboard.press("Tab");
await insertHeading(page, 2);
await page.keyboard.press("Tab");
await insertHeading(page, 3);

await page.waitForTimeout(500);
await page.keyboard.press("ArrowUp");
await page.keyboard.press("ArrowUp");
await page.keyboard.press("ArrowUp");
await page.keyboard.press("Enter");

await compareDocToSnapshot(page, "enterPreservesNestedBlocksEmpty.json");
});
test("Check Backspace at the start of a block", async ({ page }) => {
await focusOnEditor(page);
await insertHeading(page, 1);
Expand Down Expand Up @@ -129,6 +148,29 @@ test.describe("Check Keyboard Handlers' Behaviour", () => {

await compareDocToSnapshot(page, "backspacePreservesNestedBlocks.json");
});
test("Check Backspace preserves nested blocks for empty block", async ({
page,
}) => {
await focusOnEditor(page);
await insertParagraph(page);
await page.keyboard.press("Enter", { delay: 10 });
await page.keyboard.press("Tab");
await insertParagraph(page);
await page.keyboard.press("Tab");
await page.keyboard.press("Tab");
await insertParagraph(page);

for (let i = 0; i < 3; i++) {
await page.keyboard.press("ArrowUp");
}

await page.keyboard.press("Backspace");

await compareDocToSnapshot(
page,
"backspacePreservesNestedBlocksEmpty.json",
);
});
test("Check heading 1 shortcut", async ({ page }) => {
await focusOnEditor(page);
await page.keyboard.type("Paragraph");
Expand Down
97 changes: 97 additions & 0 deletions ...rdhandlers.test.ts-snapshots/backspacePreservesNestedBlocksEmpty-json-chromium-linux.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
{
"type": "doc",
"content": [
{
"type": "blockGroup",
"content": [
{
"type": "blockContainer",
"attrs": {
"id": "0"
},
"content": [
{
"type": "paragraph",
"attrs": {
"backgroundColor": "default",
"textColor": "default",
"textAlignment": "left"
},
"content": [
{
"type": "text",
"text": "Paragraph"
}
]
}
]
},
{
"type": "blockContainer",
"attrs": {
"id": "2"
},
"content": [
{
"type": "paragraph",
"attrs": {
"backgroundColor": "default",
"textColor": "default",
"textAlignment": "left"
},
"content": [
{
"type": "text",
"text": "Paragraph"
}
]
},
{
"type": "blockGroup",
"content": [
{
"type": "blockContainer",
"attrs": {
"id": "3"
},
"content": [
{
"type": "paragraph",
"attrs": {
"backgroundColor": "default",
"textColor": "default",
"textAlignment": "left"
},
"content": [
{
"type": "text",
"text": "Paragraph"
}
]
}
]
}
]
}
]
},
{
"type": "blockContainer",
"attrs": {
"id": "4"
},
"content": [
{
"type": "paragraph",
"attrs": {
"backgroundColor": "default",
"textColor": "default",
"textAlignment": "left"
}
}
]
}
]
}
]
}
97 changes: 97 additions & 0 deletions ...ardhandlers.test.ts-snapshots/backspacePreservesNestedBlocksEmpty-json-firefox-linux.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
{
"type": "doc",
"content": [
{
"type": "blockGroup",
"content": [
{
"type": "blockContainer",
"attrs": {
"id": "0"
},
"content": [
{
"type": "paragraph",
"attrs": {
"backgroundColor": "default",
"textColor": "default",
"textAlignment": "left"
},
"content": [
{
"type": "text",
"text": "Paragraph"
}
]
}
]
},
{
"type": "blockContainer",
"attrs": {
"id": "2"
},
"content": [
{
"type": "paragraph",
"attrs": {
"backgroundColor": "default",
"textColor": "default",
"textAlignment": "left"
},
"content": [
{
"type": "text",
"text": "Paragraph"
}
]
},
{
"type": "blockGroup",
"content": [
{
"type": "blockContainer",
"attrs": {
"id": "3"
},
"content": [
{
"type": "paragraph",
"attrs": {
"backgroundColor": "default",
"textColor": "default",
"textAlignment": "left"
},
"content": [
{
"type": "text",
"text": "Paragraph"
}
]
}
]
}
]
}
]
},
{
"type": "blockContainer",
"attrs": {
"id": "4"
},
"content": [
{
"type": "paragraph",
"attrs": {
"backgroundColor": "default",
"textColor": "default",
"textAlignment": "left"
}
}
]
}
]
}
]
}
Loading
Loading