Skip to content

fix: cursor jumping at the beginning #371

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
davidediak wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: cursor jumping at the beginning #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c7808e
fix: cursor jumping at the beginning
davidediak Feb 7, 2024
da83820
test: fixed breaking test and add test for FormControl cursor issue
davidediak Mar 28, 2024
142b88e
Merge remote-tracking branch 'origin/main' into 321-fix-cursor-jumps-…
davidediak May 8, 2024
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
6 changes: 6 additions & 0 deletions tinymce-angular-component/src/main/ts/editor/editor.component.ts
View file
Open in desktop
Copy link

@joe-baudisch joe-baudisch Jul 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

const cursor = this._editor.selection.getBookmark(3) as any
if (cursor['start'] && cursor['start'].startsWith('text()')) {
// do nothing because the cursor initially jumps back to first line with 'text()'
// while pasting in text from outside; moving to this bookmark after set content
// creates this cursor jump which should be avoided;
// if you paste in text from inside the editor or write text by keyboard
// the cursor starts with a paragraph tag created by TMCE like
// 'p[element_index]/text()[0]'
} else {
this._editor.setContent(isNullOrUndefined(value) ? '' : value);
try {
this._editor.selection.moveToBookmark(cursor);
} catch (e) {
/* ignore */
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,13 @@ export class EditorComponent extends Events implements AfterViewInit, ControlVal

public writeValue(value: string | null): void {
if (this._editor && this._editor.initialized) {
const cursor = this._editor.selection.getBookmark(3);
this._editor.setContent(isNullOrUndefined(value) ? '' : value);
try {
this._editor.selection.moveToBookmark(cursor);
} catch (e) {
/* ignore */
}
} else {
this.initialValue = value === null ? undefined : value;
}
Expand Down
118 changes: 77 additions & 41 deletions tinymce-angular-component/src/test/ts/browser/FormControlTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ import { Assertions, Chain, Log, Pipeline } from '@ephox/agar';
import { UnitTest } from '@ephox/bedrock-client';
import { VersionLoader } from '@tinymce/miniature';

import { Editor } from 'tinymce';
import { EditorComponent, EditorModule } from '../../../main/ts/public_api';
import { Version } from '../../../main/ts/editor/editor.component';

UnitTest.asynctest('FormControlTest', (success, failure) => {
@Component({
template: `<editor [formControl]="control"></editor>`
template: `<editor [formControl]="control"></editor>`,
})
class EditorWithFormControl {
public control = new FormControl();
Expand All @@ -22,7 +23,7 @@ UnitTest.asynctest('FormControlTest', (success, failure) => {
interface TestContext {
testComponent: EditorWithFormControl;
fixture: ComponentFixture<EditorWithFormControl>;
editor: any;
editor: Editor;
}

const cSetupEditorWithFormControl = Chain.async<void, TestContext>((_, next) => {
Expand Down Expand Up @@ -54,43 +55,78 @@ UnitTest.asynctest('FormControlTest', (success, failure) => {
TestBed.resetTestingModule();
});

const sTestVersion = (version: Version) => VersionLoader.sWithVersion(
version,
Log.chainsAsStep('', 'FormControl interaction ', [
cSetupEditorWithFormControl,
Chain.op((context: TestContext) => {
Assertions.assertEq(
'Expect editor to have no initial value',
'',
context.editor.getContent()
);

context.testComponent.control.setValue('<p>Some Value</p>');
context.fixture.detectChanges();

Assertions.assertEq(
'Expect editor to have a value',
'<p>Some Value</p>',
context.editor.getContent()
);

context.testComponent.control.reset();
context.fixture.detectChanges();

Assertions.assertEq(
'Expect editor to be empty after reset',
'',
context.editor.getContent()
);
}),
cTeardown
])
);
const setFormValueAndReset = Chain.op((context: TestContext) => {
Assertions.assertEq('Expect editor to have no initial value', '', context.editor.getContent());

context.testComponent.control.setValue('<p>Some Value</p>');
context.fixture.detectChanges();

Assertions.assertEq(
'Expect editor to have a value',
'<p>Some Value</p>',
context.editor.getContent()
);

context.testComponent.control.reset();
context.fixture.detectChanges();

Assertions.assertEq('Expect editor to be empty after reset', '', context.editor.getContent());
});

/** Sets content and set cursor at the end, just like when a real user types */
const doFakeType = (str: string) =>
Chain.op((context: TestContext) => {
context.testComponent.control.patchValue(`${str}`);
context.fixture.detectChanges();

const rng = context.editor.dom.createRng();
const firstChild = context.editor.getBody().firstChild?.firstChild as Text;
rng.setStart(firstChild, str.length);
rng.setEnd(firstChild, str.length);

Pipeline.async({}, [
sTestVersion('4'),
sTestVersion('5'),
sTestVersion('6'),
sTestVersion('7')
], success, failure);
});
context.editor.selection.setRng(rng);
context.fixture.detectChanges();
});

const checkCursor = Chain.op((context: TestContext) => {
const cursorStartPosition = context.editor.selection.getRng().startOffset;
const cursorEndPosition = context.editor.selection.getRng().endOffset;
const content = context.editor.getContent();
const strippedContent = content.replace(/<\/?[^>]+(>|$)/g, '');
Assertions.assertEq(
'Expect cursor start position to be at the end of the content',
cursorStartPosition,
strippedContent.length
);

Assertions.assertEq(
'Expect cursor end position to be at the end of the content',
cursorEndPosition,
strippedContent.length
);
});

const sTestVersion = (version: Version) =>
VersionLoader.sWithVersion(
version,
Log.chainsAsStep('', 'FormControl interaction ', [
cSetupEditorWithFormControl,
setFormValueAndReset,
doFakeType('test'),
checkCursor,
cTeardown,
])
);

Pipeline.async(
{},
[
sTestVersion('4'),
sTestVersion('5'),
sTestVersion('6'),
sTestVersion('7'),
],
success,
failure
);
});