Skip to content

refactor(core): use the new position helpers in the keyboard shortcuts #3101

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
YousefED wants to merge 1 commit into
base: refactor/block-info-api
Choose a base branch
from
+39 −56
Open

refactor(core): use the new position helpers in the keyboard shortcuts #3101

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
7 changes: 5 additions & 2 deletions packages/core/src/api/getBlockInfoFromPos.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ export type BlockInfo = {
* boundary — the first cell's paragraph start, or the last cell's paragraph
* end.
*/
export function tableContentCaretPos(
function tableContentCaretPos(
content: { beforePos: number; afterPos: number },
edge: "start" | "end",
): number {
Expand Down Expand Up @@ -565,7 +565,10 @@ export function getInsertionPos(
: null;
}

// Ordinary nesting creates its blockGroup lazily.
// Only a regular block reaches here: every container has a `children`
// holder, even when it holds nothing, so ordinary nesting is what is left -
// and its `blockGroup` is created lazily. `hasContent` narrows the union so
// `content` can be read; it cannot be false at this point.
if (!info.children) {
const group = nodeType.schema.nodes["blockGroup"];
return info.hasContent && group?.contentMatch.matchType(nodeType)
Expand Down
88 changes: 34 additions & 54 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 @@ -12,13 +12,13 @@ import { fixColumnList } from "../../../api/blockManipulation/commands/replaceBl
import { splitBlockCommand } from "../../../api/blockManipulation/commands/splitBlock/splitBlock.js";
import { updateBlockCommand } from "../../../api/blockManipulation/commands/updateBlock/updateBlock.js";
import {
blockEdgePos,
getBlockInfoAt,
getBlockInfoFromSelection,
getLastDescendantBlockInfo,
getNextBlockInfo,
getParentBlockInfo,
getPrevBlockInfo,
tableContentCaretPos,
} from "../../../api/getBlockInfoFromPos.js";
import { BlockNoteEditor } from "../../../editor/BlockNoteEditor.js";
import { FilePanelExtension } from "../../FilePanel/FilePanel.js";
Expand Down Expand Up @@ -49,7 +49,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
}

const selectionAtBlockStart =
state.selection.from === blockInfo.content.beforePos + 1;
state.selection.from === blockInfo.contentStart;
const isParagraph =
blockInfo.content.node.type.name === "paragraph";

Expand All @@ -71,10 +71,9 @@ export const KeyboardShortcutsExtension = Extension.create<{
if (!blockInfo.hasContent) {
return false;
}
const { content } = blockInfo;
const { contentStart } = blockInfo;

const selectionAtBlockStart =
state.selection.from === content.beforePos + 1;
const selectionAtBlockStart = state.selection.from === contentStart;

if (selectionAtBlockStart) {
return liftItem(
Expand All @@ -94,7 +93,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
if (!blockInfo.hasContent) {
return false;
}
const { block, content } = blockInfo;
const { block, contentStart } = blockInfo;

const prevBlockInfo = getPrevBlockInfo(
state.doc,
Expand All @@ -111,8 +110,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
return false;
}

const selectionAtBlockStart =
state.selection.from === content.beforePos + 1;
const selectionAtBlockStart = state.selection.from === contentStart;
const selectionEmpty = state.selection.empty;

const posBetweenBlocks = block.beforePos;
Expand All @@ -136,7 +134,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
}

const selectionAtBlockStart =
state.selection.from === blockInfo.content.beforePos + 1;
state.selection.from === blockInfo.contentStart;
if (!selectionAtBlockStart) {
return false;
}
Expand Down Expand Up @@ -175,7 +173,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
}

const selectionAtBlockStart =
tr.selection.from === blockInfo.content.beforePos + 1;
tr.selection.from === blockInfo.contentStart;
if (!selectionAtBlockStart) {
return false;
}
Expand Down Expand Up @@ -258,24 +256,15 @@ export const KeyboardShortcutsExtension = Extension.create<{
);
}

if (bottomNestedPrevBlockInfo.contentKind === "table") {
chainedCommands = chainedCommands.setTextSelection(
tableContentCaretPos(
bottomNestedPrevBlockInfo.content,
"end",
),
);
} else if (bottomNestedPrevBlockInfo.contentKind === "none") {
chainedCommands = chainedCommands.setNodeSelection(
bottomNestedPrevBlockInfo.content.beforePos,
);
} else {
const contentEndPos =
bottomNestedPrevBlockInfo.content.afterPos - 1;

chainedCommands =
chainedCommands.setTextSelection(contentEndPos);
}
// No caret position means content that holds no text (an
// image), which is selected as a node instead.
const prevEdge = blockEdgePos(bottomNestedPrevBlockInfo, "end");
chainedCommands =
prevEdge !== null
? chainedCommands.setTextSelection(prevEdge)
: chainedCommands.setNodeSelection(
bottomNestedPrevBlockInfo.content.beforePos,
);

return chainedCommands
.deleteRange({
Expand All @@ -300,7 +289,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
}

const selectionAtBlockStart =
state.selection.from === blockInfo.content.beforePos + 1;
state.selection.from === blockInfo.contentStart;
const selectionEmpty = state.selection.empty;

const prevBlockInfo = getPrevBlockInfo(
Expand Down Expand Up @@ -356,10 +345,9 @@ export const KeyboardShortcutsExtension = Extension.create<{
if (!blockInfo.hasContent || !blockInfo.children) {
return false;
}
const { content, children } = blockInfo;
const { children, contentEnd } = blockInfo;

const selectionAtBlockEnd =
state.selection.from === content.afterPos - 1;
const selectionAtBlockEnd = state.selection.from === contentEnd;
const selectionEmpty = state.selection.empty;

const firstChildBlockInfo = getBlockInfoAt(
Expand Down Expand Up @@ -420,7 +408,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
if (!blockInfo.hasContent) {
return false;
}
const { block, content } = blockInfo;
const { block, contentEnd } = blockInfo;

const nextBlockInfo = getNextBlockInfo(
state.doc,
Expand All @@ -430,8 +418,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
return false;
}

const selectionAtBlockEnd =
state.selection.from === content.afterPos - 1;
const selectionAtBlockEnd = state.selection.from === contentEnd;
const selectionEmpty = state.selection.empty;

const posBetweenBlocks = block.afterPos;
Expand All @@ -455,7 +442,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
}

const selectionAtBlockEnd =
state.selection.from === blockInfo.content.afterPos - 1;
state.selection.from === blockInfo.contentEnd;
if (!selectionAtBlockEnd) {
return false;
}
Expand Down Expand Up @@ -498,7 +485,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
}

const selectionAtBlockEnd =
tr.selection.from === blockInfo.content.afterPos - 1;
tr.selection.from === blockInfo.contentEnd;
if (!selectionAtBlockEnd) {
return false;
}
Expand Down Expand Up @@ -555,10 +542,9 @@ export const KeyboardShortcutsExtension = Extension.create<{
if (!blockInfo.hasContent) {
return false;
}
const { content } = blockInfo;
const { contentEnd } = blockInfo;

const selectionAtBlockEnd =
state.selection.from === content.afterPos - 1;
const selectionAtBlockEnd = state.selection.from === contentEnd;
const selectionEmpty = state.selection.empty;

if (selectionAtBlockEnd && selectionEmpty) {
Expand Down Expand Up @@ -644,19 +630,13 @@ export const KeyboardShortcutsExtension = Extension.create<{

let chainedCommands = chain();

if (nextBlockInfo.contentKind === "table") {
chainedCommands = chainedCommands.setTextSelection(
tableContentCaretPos(nextBlockInfo.content, "start"),
);
} else if (nextBlockInfo.contentKind === "none") {
chainedCommands = chainedCommands.setNodeSelection(
nextBlockInfo.content.beforePos,
);
} else {
chainedCommands = chainedCommands.setTextSelection(
nextBlockInfo.content.beforePos + 1,
);
}
const nextEdge = blockEdgePos(nextBlockInfo, "start");
chainedCommands =
nextEdge !== null
? chainedCommands.setTextSelection(nextEdge)
: chainedCommands.setNodeSelection(
nextBlockInfo.content.beforePos,
);

return chainedCommands
.deleteRange({
Expand All @@ -681,7 +661,7 @@ export const KeyboardShortcutsExtension = Extension.create<{
}

const selectionAtBlockEnd =
state.selection.from === blockInfo.content.afterPos - 1;
state.selection.from === blockInfo.contentEnd;
const selectionEmpty = state.selection.empty;

const nextBlockInfo = getNextBlockInfo(
Expand Down
Loading