feat: Double-link: In-line cursor handling, e.g., up, down, left,right, backspace keys

This commit is contained in:
xiaodong zuo
2022-08-26 09:13:19 +08:00
parent 9169421460
commit 6d770dbfa6
3 changed files with 86 additions and 5 deletions

View File

@@ -41,7 +41,12 @@ import { InlineDate, withDate } from './plugins/date';
import { DoubleLinkComponent } from './plugins/DoubleLink'; import { DoubleLinkComponent } from './plugins/DoubleLink';
import { LinkComponent, LinkModal, withLinks, wrapLink } from './plugins/link'; import { LinkComponent, LinkModal, withLinks, wrapLink } from './plugins/link';
import { InlineRefLink } from './plugins/reflink'; import { InlineRefLink } from './plugins/reflink';
import { Contents, isSelectAll, SlateUtils } from './slate-utils'; import {
Contents,
isSelectAll,
SelectionStartAndEnd,
SlateUtils,
} from './slate-utils';
import { import {
getCommentsIdsOnTextNode, getCommentsIdsOnTextNode,
getExtraPropertiesFromEditorOutmostNode, getExtraPropertiesFromEditorOutmostNode,
@@ -88,8 +93,12 @@ export interface TextProps {
/** Backspace event */ /** Backspace event */
handleBackSpace?: ({ handleBackSpace?: ({
isCollAndStart, isCollAndStart,
splitContents,
selection,
}: { }: {
isCollAndStart: boolean; isCollAndStart: boolean;
splitContents: Contents;
selection: SelectionStartAndEnd;
}) => boolean | undefined | Promise<boolean | undefined>; }) => boolean | undefined | Promise<boolean | undefined>;
/** Whether markdown is supported */ /** Whether markdown is supported */
supportMarkdown?: boolean; supportMarkdown?: boolean;
@@ -464,7 +473,13 @@ export const Text = forwardRef<ExtendedTextUtils, TextProps>((props, ref) => {
if (!isCool) { if (!isCool) {
hideInlineMenu && hideInlineMenu(); hideInlineMenu && hideInlineMenu();
} }
preventBindIfNeeded(handleBackSpace)(e, { isCollAndStart }); const selection = utils.current.getSelectionStartAndEnd();
const splitContents = utils.current.getSplitContentsBySelection();
preventBindIfNeeded(handleBackSpace)(e, {
isCollAndStart,
selection,
splitContents,
});
}; };
const onTab = (e: KeyboardEvent) => { const onTab = (e: KeyboardEvent) => {

View File

@@ -503,7 +503,7 @@ Editor.after = function (
return target; return target;
}; };
type SelectionStartAndEnd = { export type SelectionStartAndEnd = {
selectionStart: Point; selectionStart: Point;
selectionEnd: Point; selectionEnd: Point;
}; };
@@ -517,6 +517,10 @@ export type Contents = {
content: Descendant[]; content: Descendant[];
isEmpty: boolean; isEmpty: boolean;
}; };
contentSelection: {
content: Descendant[];
isEmpty: boolean;
};
}; };
class SlateUtils { class SlateUtils {
@@ -572,6 +576,7 @@ class SlateUtils {
anchor: point1, anchor: point1,
focus: point2, focus: point2,
}); });
if (!fragment.length) { if (!fragment.length) {
console.error('Debug information:', point1, point2, fragment); console.error('Debug information:', point1, point2, fragment);
throw new Error('Failed to get content between!'); throw new Error('Failed to get content between!');
@@ -602,7 +607,7 @@ class SlateUtils {
for (let i = 0; i < fragmentChildren.length; i++) { for (let i = 0; i < fragmentChildren.length; i++) {
const child = fragmentChildren[i]; const child = fragmentChildren[i];
if ('type' in child && child.type === 'link') { if ('type' in child && child.type === 'link') {
i !== fragmentChildren.length - 1 && textChildren.push(child); textChildren.push(child);
continue; continue;
} }
if (!('text' in child)) { if (!('text' in child)) {
@@ -638,6 +643,10 @@ class SlateUtils {
content: this.getContentBetween(selectionEnd, end), content: this.getContentBetween(selectionEnd, end),
isEmpty: Point.equals(end, selectionEnd), isEmpty: Point.equals(end, selectionEnd),
}, },
contentSelection: {
content: this.getContentBetween(selectionStart, selectionEnd),
isEmpty: false,
},
} as Contents; } as Contents;
} }

View File

@@ -1,5 +1,6 @@
/* eslint-disable max-lines */ /* eslint-disable max-lines */
import { import {
CustomText,
Text, Text,
type SlateUtils, type SlateUtils,
type TextProps, type TextProps,
@@ -108,7 +109,7 @@ const findLowestCommonAncestor = async (
export const TextManage = forwardRef<ExtendedTextUtils, CreateTextView>( export const TextManage = forwardRef<ExtendedTextUtils, CreateTextView>(
(props, ref) => { (props, ref) => {
const { block, editor, ...otherOptions } = props; const { block, editor, handleBackSpace, ...otherOptions } = props;
const defaultRef = useRef<ExtendedTextUtils>(null); const defaultRef = useRef<ExtendedTextUtils>(null);
// Maybe there is a better way // Maybe there is a better way
const textRef = const textRef =
@@ -446,6 +447,61 @@ export const TextManage = forwardRef<ExtendedTextUtils, CreateTextView>(
} }
} }
}; };
const onBackspace: TextProps['handleBackSpace'] = async props => {
const { isCollAndStart, splitContents, selection } = props;
if (!isCollAndStart) {
const {
contentBeforeSelection,
contentAfterSelection,
contentSelection,
} = splitContents;
const { selectionStart, selectionEnd } = selection;
let hasDeleteDoubleLink = false;
const beforeContent = [...contentBeforeSelection.content];
const lastItem = beforeContent[beforeContent.length - 1];
if (
'linkType' in lastItem &&
lastItem.linkType === 'doubleLink'
) {
if (
selectionStart === selectionEnd ||
selectionStart.offset
) {
beforeContent.splice(beforeContent.length - 1, 1);
hasDeleteDoubleLink = true;
}
}
const afterContent = [...contentAfterSelection.content];
const beginItem = afterContent[0];
const lastSel = contentSelection.content[0];
if (
selectionEnd.offset &&
'linkType' in beginItem &&
beginItem.linkType === 'doubleLink' &&
'linkType' in lastSel &&
lastSel.linkType === 'doubleLink'
) {
afterContent.splice(0, 1);
hasDeleteDoubleLink = true;
}
if (hasDeleteDoubleLink) {
await block.setProperty('text', {
value: [
...beforeContent,
...afterContent,
] as CustomText[],
});
return true;
}
}
return (handleBackSpace && handleBackSpace(props)) || false;
};
if (!properties || !properties.text) { if (!properties || !properties.text) {
return <></>; return <></>;
} }
@@ -467,6 +523,7 @@ export const TextManage = forwardRef<ExtendedTextUtils, CreateTextView>(
handleUndo={onUndo} handleUndo={onUndo}
handleRedo={onRedo} handleRedo={onRedo}
handleEsc={onKeyboardEsc} handleEsc={onKeyboardEsc}
handleBackSpace={onBackspace}
{...otherOptions} {...otherOptions}
/> />
); );