Skip to content
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.

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

Do not restore cached selection when call select #2075

Merged
merged 4 commits into from
Sep 20, 2023
Merged
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
113 changes: 70 additions & 43 deletions packages/roosterjs-editor-core/lib/coreApi/select.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { contains, createRange, safeInstanceOf } from 'roosterjs-editor-dom';
import {
EditorCore,
NodePosition,
PluginEventType,
PositionType,
Expand All @@ -21,6 +22,35 @@ import {
* @param arg4 (optional) An offset number, or a PositionType
*/
export const select: Select = (core, arg1, arg2, arg3, arg4) => {
let rangeEx = buildRangeEx(core, arg1, arg2, arg3, arg4);

if (rangeEx) {
const skipReselectOnFocus = core.domEvent.skipReselectOnFocus;

// We are applying a new selection, so we don't need to apply cached selection in DOMEventPlugin.
// Set skipReselectOnFocus to skip this behavior
core.domEvent.skipReselectOnFocus = true;

try {
applyRangeEx(core, rangeEx);
} finally {
core.domEvent.skipReselectOnFocus = skipReselectOnFocus;
}
} else {
core.domEvent.tableSelectionRange = core.api.selectTable(core, null);
core.domEvent.imageSelectionRange = core.api.selectImage(core, null);
}

return !!rangeEx;
};

function buildRangeEx(
core: EditorCore,
arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null,
arg2?: NodePosition | number | PositionType | TableSelection | null,
arg3?: Node,
arg4?: number | PositionType
) {
let rangeEx: SelectionRangeEx | null = null;

if (isSelectionRangeEx(arg1)) {
Expand Down Expand Up @@ -65,53 +95,50 @@ export const select: Select = (core, arg1, arg2, arg3, arg4) => {
: null;
}

if (rangeEx) {
switch (rangeEx.type) {
case SelectionRangeTypes.TableSelection:
if (contains(core.contentDiv, rangeEx.table)) {
core.domEvent.imageSelectionRange = core.api.selectImage(core, null);
core.domEvent.tableSelectionRange = core.api.selectTable(
core,
rangeEx.table,
rangeEx.coordinates
);
rangeEx = core.domEvent.tableSelectionRange;
}
break;
case SelectionRangeTypes.ImageSelection:
if (contains(core.contentDiv, rangeEx.image)) {
core.domEvent.tableSelectionRange = core.api.selectTable(core, null);
core.domEvent.imageSelectionRange = core.api.selectImage(core, rangeEx.image);
rangeEx = core.domEvent.imageSelectionRange;
}
break;
case SelectionRangeTypes.Normal:
core.domEvent.tableSelectionRange = core.api.selectTable(core, null);
core.domEvent.imageSelectionRange = core.api.selectImage(core, null);
return rangeEx;
}

if (contains(core.contentDiv, rangeEx.ranges[0])) {
core.api.selectRange(core, rangeEx.ranges[0]);
} else {
rangeEx = null;
}
break;
}
function applyRangeEx(core: EditorCore, rangeEx: SelectionRangeEx | null) {
switch (rangeEx?.type) {
case SelectionRangeTypes.TableSelection:
if (contains(core.contentDiv, rangeEx.table)) {
core.domEvent.imageSelectionRange = core.api.selectImage(core, null);
core.domEvent.tableSelectionRange = core.api.selectTable(
core,
rangeEx.table,
rangeEx.coordinates
);
rangeEx = core.domEvent.tableSelectionRange;
}
break;
case SelectionRangeTypes.ImageSelection:
if (contains(core.contentDiv, rangeEx.image)) {
core.domEvent.tableSelectionRange = core.api.selectTable(core, null);
core.domEvent.imageSelectionRange = core.api.selectImage(core, rangeEx.image);
rangeEx = core.domEvent.imageSelectionRange;
}
break;
case SelectionRangeTypes.Normal:
core.domEvent.tableSelectionRange = core.api.selectTable(core, null);
core.domEvent.imageSelectionRange = core.api.selectImage(core, null);

core.api.triggerEvent(
core,
{
eventType: PluginEventType.SelectionChanged,
selectionRangeEx: rangeEx,
},
true /** broadcast **/
);
} else {
core.domEvent.tableSelectionRange = core.api.selectTable(core, null);
core.domEvent.imageSelectionRange = core.api.selectImage(core, null);
if (contains(core.contentDiv, rangeEx.ranges[0])) {
core.api.selectRange(core, rangeEx.ranges[0]);
} else {
rangeEx = null;
}
break;
}

return !!rangeEx;
};
core.api.triggerEvent(
core,
{
eventType: PluginEventType.SelectionChanged,
selectionRangeEx: rangeEx,
},
true /** broadcast **/
);
}

function isSelectionRangeEx(obj: any): obj is SelectionRangeEx {
const rangeEx = obj as SelectionRangeEx;
Expand Down
18 changes: 10 additions & 8 deletions packages/roosterjs-editor-core/lib/corePlugins/DOMEventPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,15 +162,17 @@ export default class DOMEventPlugin implements PluginWithState<DOMEventPluginSta
};

private onFocus = () => {
const { table, coordinates } = this.state.tableSelectionRange || {};
const { image } = this.state.imageSelectionRange || {};
if (!this.state.skipReselectOnFocus) {
const { table, coordinates } = this.state.tableSelectionRange || {};
const { image } = this.state.imageSelectionRange || {};

if (table && coordinates) {
this.editor?.select(table, coordinates);
} else if (image) {
this.editor?.select(image);
} else if (this.state.selectionRange) {
this.editor?.select(this.state.selectionRange);
if (table && coordinates) {
this.editor?.select(table, coordinates);
} else if (image) {
this.editor?.select(image);
} else if (this.state.selectionRange) {
this.editor?.select(this.state.selectionRange);
}
}

this.state.selectionRange = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,16 @@ describe('DOMEventPlugin verify event handlers while allow keyboard event propag
expect(select.calls.argsFor(0)[0]).toBe(range);
expect(state.selectionRange).toBeNull();
});

it('Skip applying selection when skipReselectOnFocus is true', () => {
const range = document.createRange();
state.selectionRange = range;
state.skipReselectOnFocus = true;
eventMap.focus(<Event>{});

expect(select).not.toHaveBeenCalled();
expect(state.selectionRange).toBeNull();
});
});

describe('DOMEventPlugin verify event handlers while disallow keyboard event propagation', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,9 @@ export default interface DOMEventPluginState {
* Image selection range
*/
imageSelectionRange: ImageSelectionRange | null;

/**
* When set to true, onFocus event will not trigger reselect cached range
*/
skipReselectOnFocus?: boolean;
}