Skip to content

Conversation

@JiuqingSong
Copy link
Collaborator

When cursor is next to entity, since there is entity delimiter, sometimes the existing DOM operation code is not handling well. So let's handle it using Content Model.

  1. When there is entity (or possibly has entity), use Content Model to handle enter key. To make the check fast enough, we just check one of the following:
    a. Current paragraph has entity, even it is not next to cursor
    b. Current paragraph is implicit, since this can happen when focus is next to block entity. Although it is possible these can be false positive, but it is fine since ideally we can handle enter key in all scenarios
  2. There is a problem in dom indexer that after restoring undo snapshot, we are reusing entity delimiter DOM nodes and it can have cached indexer which is already out-of-date, so we need to clear it
  3. When handle the enter key, if current paragraph is implicit and only has selection marker, we should not mark it as not implicit since that will introduce additional empty line

This pr fix all issues above to make sure enter key is correctly handled around entity.

Before

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes issue 341291 by improving the handling of the Enter key when the cursor is next to an entity. The changes include updating the Content Model handling in splitParagraph and keyboardEnter, adding logic to clear cached index data for entity delimiters after undo snapshot restoration, and revising tests across the plugins and core modules to support these enhancements.

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/roosterjs-content-model-plugins/lib/edit/keyboardEnter.ts Updated Enter key handling to include entity-based conditions.
packages/roosterjs-content-model-plugins/lib/edit/utils/splitParagraph.ts Adjusted behavior for implicit paragraphs with a selection marker.
packages/roosterjs-content-model-core/lib/corePlugin/entity/entityDelimiterUtils.ts Refactored Enter key event handling for entity delimiters.
packages/roosterjs-content-model-core/lib/corePlugin/cache/domIndexerImpl.ts Added clearIndex method to remove outdated cached index data.
packages/roosterjs-content-model-core/test/coreApi/restoreUndoSnapshot/restoreSnapshotHTMLTest.ts Added tests to verify that delimiter indexes are cleared upon restoring snapshots.
Other test files in domToModel and modelToDom processors Included clearIndex in test contexts to support the updated cache handling.
Comments suppressed due to low confidence (2)

packages/roosterjs-content-model-core/test/corePlugin/entity/entityDelimiterUtilsTest.ts:451

  • Tests related to handling range selections with entity delimiters were removed. Please confirm that the new behavior for Enter key handling around entities is thoroughly covered by the updated test suite.
it('Handle, range selection & delimiter before wrapped in block entity | Enter Key', () => {

packages/roosterjs-content-model-core/lib/corePlugin/entity/entityDelimiterUtils.ts:219

  • The refactoring in the Enter key handling removed the branch for collapsed range handling. Please ensure that this change fully aligns with the intended design and that tests adequately cover both expanded and collapsed selection scenarios around entity delimiters.
if (entity && isNodeOfType(entity, 'ELEMENT_NODE') && helper.isNodeInEditor(entity)) {

: [handleAutoLink, handleEnterOnList, deleteEmptyQuote];

if (handleNormalEnter) {
if (handleNormalEnter || hasEnterForEntity(result.insertPoint?.paragraph)) {
Copy link

Copilot AI May 21, 2025

Choose a reason for hiding this comment

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

[nitpick] The enhanced condition to trigger handleEnterOnParagraph when a paragraph meets entity-related criteria is clear but could benefit from an inline comment explaining that it covers cases where the paragraph is implicit or contains a selection marker.

Copilot uses AI. Check for mistakes.
@JiuqingSong JiuqingSong enabled auto-merge (squash) May 22, 2025 19:49
@JiuqingSong JiuqingSong merged commit 699daed into master May 22, 2025
7 checks passed
@JiuqingSong JiuqingSong deleted the u/jisong/341291 branch May 22, 2025 19:49
ianeli1 added a commit that referenced this pull request May 24, 2025
* Use FormatContainer to represent DIV with id (#3003)

* Fix #3005 (#3007)

* Fix a cache issue (#3006)

* Refactor getStyleMetadata to not rely on DomCreator and only use String handling (#3010)

* Refactor paste plugin to remove unused DOMCreator parameter and enhance style extraction logic

* fix test

* Change search string to lowercase

* Clean image edit when undo (#3015)

* undo image

* undo image

* undo image

* Add 'CustomCopyCut' experimental feature to fix some copy cut bugs (#3000)

* Add 'CustomCopyCut' experimental feature to enhance copy/cut behavior

* Implement pruneUnselectedModel utility for optimizing copy/paste behavior

* Try fix iuld

* Address comment and fix broken tests

* Revert unneeded change

* Refactor pruneUnselectedModel

---------

Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* Demo site: Add preset content for undeleteable anchor (#3014)

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* Revert "Refactor getStyleMetadata to not rely on DomCreator and only use Stri…" (#3020)

This reverts commit 5bbab35.

* Add API playground for createModelFromHTML (#3019)

* Add API playground for createModelFromHTML

* imporve

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* Do not copy div ID on Enter (#3011)

* wip

* insertCustom

* refactor

* formatKeys

* Add image hidden marker (#3021)

Instead of using a dataset to store the isEditing property, a hidden property is now used. To support this, get/set functions and the ImageMarkerFormat were introduced. The imageMarker property can now be accessed through the format property of the image.
This change eliminates the need to manually remove the dataset from the image element when extracting content from the DOM.

* Include ImageMetadata in FormatState (#3023)

* Support List Pasting from PowerPoint Desktop (#3012)

* Refactor paste parsers: add removeNegativeTextIndentParser and deprecatedBorderColorParser; update imports and constants for bullet list types

* Update packages/roosterjs-content-model-plugins/lib/paste/PowerPoint/processPastedContentFromPowerPoint.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Refactor bullet list constants and improve format parser signatures

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Remove comments `<!--` and `-->` from styles and re apply fix for Word Desktop Pasting  (#3024)

* Update dependencies and enhance paste functionality by cleaning HTML comments in style tags

* Reapply "Refactor getStyleMetadata to not rely on DomCreator and only use Stri…" (#3020)

This reverts commit 32f47bf.

* Enhance cleanHtmlComments to handle both HTML comment formats in style tags

* Set original DOMPurify

* Update packages/roosterjs-content-model-plugins/lib/paste/WordDesktop/getStyleMetadata.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Ensure headEndIndex is valid

* address comment

* Address comments

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* insert link in the image (#3027)

When the image is selected, do not replace the image with the link, add the link to image segment.

* square (#3029)

Instead of using a square character, this change updates the square style to use the 'square' style.

* Normalize default format (#3028)

* Normalize default format

* improve

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* auto link (#3026)

* Add margin-inline-start to watermark styles for improved positioning (#3031)

* Allow queryContentModelBlocks to query blocks in entities (#3032)

* Allow queryContentModelBlocks to search children of entity

* Expect EditorContext instead

* Break out createEditorContextForEntity function into separate file and add tests

* Fix 353323: Keep indentation when start a list, and refactor (#3033)

* 353323

* fix build, add test

* improve

* Edit plugin Options (#3036)

* options

* add test

* Do not indent on TAB (#3039)

* keyboard tab

* remove import

* Fix 354663 (#3038)

* Fix 354663

* export the new function

* Fix Word Desktop paste case (#3034)

Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* Add height property to table rows in paste tests and processor (#3045)

* Add height property to table rows in paste tests and processor

* Fix build

* Remove local change

* Fix A11y bug with table selection (#3041)

* Fix A11y bug with table selection

* Add comment

* Fix 341291 (#3046)

* Fix Word Desktop pasting when using Safari (#3047)

* Enhance paste functionality: support additional document types and extract HTML head content

* Fix paste source validations for Safari: update environment handling and improve document detection logic

* Add environment param back

* Prevent multiple event attachments for mousemove in SelectionPlugin (#3049)

* Prevent multiple event attachments for mousemove in SelectionPlugin

* Update packages/roosterjs-content-model-core/test/corePlugin/selection/SelectionPluginTest.ts

* Refactor mouse event handling in SelectionPlugin to ensure proper cleanup and re-attachment on mouseDown events

* Only paste text content of button (#3050)

* Enhance paste functionality: Update setProcessor call counts in tests and add pasteButtonProcessor unit tests

* Refactor pasteButtonProcessor: Enhance button element processing and add comprehensive unit tests

* Support table edit with logical root (#3048)

* Support table edit with logical root

* fix build and test

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* Bump to 9.29.0

* Fix broken code

---------

Co-authored-by: Jiuqing Song <jisong@microsoft.com>
Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>
Co-authored-by: Julia Roldi <87443959+juliaroldi@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: florian-msft <87671048+florian-msft@users.noreply.github.com>
JiuqingSong added a commit that referenced this pull request May 27, 2025
* Use FormatContainer to represent DIV with id (#3003)

* Fix #3005 (#3007)

* Fix a cache issue (#3006)

* Refactor getStyleMetadata to not rely on DomCreator and only use String handling (#3010)

* Refactor paste plugin to remove unused DOMCreator parameter and enhance style extraction logic

* fix test

* Change search string to lowercase

* Clean image edit when undo (#3015)

* undo image

* undo image

* undo image

* Add 'CustomCopyCut' experimental feature to fix some copy cut bugs (#3000)

* Add 'CustomCopyCut' experimental feature to enhance copy/cut behavior

* Implement pruneUnselectedModel utility for optimizing copy/paste behavior

* Try fix iuld

* Address comment and fix broken tests

* Revert unneeded change

* Refactor pruneUnselectedModel

---------

Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* Demo site: Add preset content for undeleteable anchor (#3014)

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* Revert "Refactor getStyleMetadata to not rely on DomCreator and only use Stri…" (#3020)

This reverts commit 5bbab35.

* Add API playground for createModelFromHTML (#3019)

* Add API playground for createModelFromHTML

* imporve

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* Do not copy div ID on Enter (#3011)

* wip

* insertCustom

* refactor

* formatKeys

* Add image hidden marker (#3021)

Instead of using a dataset to store the isEditing property, a hidden property is now used. To support this, get/set functions and the ImageMarkerFormat were introduced. The imageMarker property can now be accessed through the format property of the image.
This change eliminates the need to manually remove the dataset from the image element when extracting content from the DOM.

* Include ImageMetadata in FormatState (#3023)

* Support List Pasting from PowerPoint Desktop (#3012)

* Refactor paste parsers: add removeNegativeTextIndentParser and deprecatedBorderColorParser; update imports and constants for bullet list types

* Update packages/roosterjs-content-model-plugins/lib/paste/PowerPoint/processPastedContentFromPowerPoint.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Refactor bullet list constants and improve format parser signatures

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Remove comments `<!--` and `-->` from styles and re apply fix for Word Desktop Pasting  (#3024)

* Update dependencies and enhance paste functionality by cleaning HTML comments in style tags

* Reapply "Refactor getStyleMetadata to not rely on DomCreator and only use Stri…" (#3020)

This reverts commit 32f47bf.

* Enhance cleanHtmlComments to handle both HTML comment formats in style tags

* Set original DOMPurify

* Update packages/roosterjs-content-model-plugins/lib/paste/WordDesktop/getStyleMetadata.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Ensure headEndIndex is valid

* address comment

* Address comments

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* insert link in the image (#3027)

When the image is selected, do not replace the image with the link, add the link to image segment.

* square (#3029)

Instead of using a square character, this change updates the square style to use the 'square' style.

* Normalize default format (#3028)

* Normalize default format

* improve

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* auto link (#3026)

* Add margin-inline-start to watermark styles for improved positioning (#3031)

* Allow queryContentModelBlocks to query blocks in entities (#3032)

* Allow queryContentModelBlocks to search children of entity

* Expect EditorContext instead

* Break out createEditorContextForEntity function into separate file and add tests

* Fix 353323: Keep indentation when start a list, and refactor (#3033)

* 353323

* fix build, add test

* improve

* Edit plugin Options (#3036)

* options

* add test

* Do not indent on TAB (#3039)

* keyboard tab

* remove import

* Fix 354663 (#3038)

* Fix 354663

* export the new function

* Fix Word Desktop paste case (#3034)

Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* Add height property to table rows in paste tests and processor (#3045)

* Add height property to table rows in paste tests and processor

* Fix build

* Remove local change

* Fix A11y bug with table selection (#3041)

* Fix A11y bug with table selection

* Add comment

* Fix 341291 (#3046)

* Fix Word Desktop pasting when using Safari (#3047)

* Enhance paste functionality: support additional document types and extract HTML head content

* Fix paste source validations for Safari: update environment handling and improve document detection logic

* Add environment param back

* Prevent multiple event attachments for mousemove in SelectionPlugin (#3049)

* Prevent multiple event attachments for mousemove in SelectionPlugin

* Update packages/roosterjs-content-model-core/test/corePlugin/selection/SelectionPluginTest.ts

* Refactor mouse event handling in SelectionPlugin to ensure proper cleanup and re-attachment on mouseDown events

* Only paste text content of button (#3050)

* Enhance paste functionality: Update setProcessor call counts in tests and add pasteButtonProcessor unit tests

* Refactor pasteButtonProcessor: Enhance button element processing and add comprehensive unit tests

* Support table edit with logical root (#3048)

* Support table edit with logical root

* fix build and test

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* If font family already has single quote, keep it (#3055)

* 9.29.1

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>
Co-authored-by: Julia Roldi <87443959+juliaroldi@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: florian-msft <87671048+florian-msft@users.noreply.github.com>
BryanValverdeU added a commit that referenced this pull request May 28, 2025
* Use FormatContainer to represent DIV with id (#3003)

* Fix #3005 (#3007)

* Fix a cache issue (#3006)

* Refactor getStyleMetadata to not rely on DomCreator and only use String handling (#3010)

* Refactor paste plugin to remove unused DOMCreator parameter and enhance style extraction logic

* fix test

* Change search string to lowercase

* Clean image edit when undo (#3015)

* undo image

* undo image

* undo image

* Add 'CustomCopyCut' experimental feature to fix some copy cut bugs (#3000)

* Add 'CustomCopyCut' experimental feature to enhance copy/cut behavior

* Implement pruneUnselectedModel utility for optimizing copy/paste behavior

* Try fix iuld

* Address comment and fix broken tests

* Revert unneeded change

* Refactor pruneUnselectedModel

---------

Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* Demo site: Add preset content for undeleteable anchor (#3014)

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* Revert "Refactor getStyleMetadata to not rely on DomCreator and only use Stri…" (#3020)

This reverts commit 5bbab35.

* Add API playground for createModelFromHTML (#3019)

* Add API playground for createModelFromHTML

* imporve

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* Do not copy div ID on Enter (#3011)

* wip

* insertCustom

* refactor

* formatKeys

* Add image hidden marker (#3021)

Instead of using a dataset to store the isEditing property, a hidden property is now used. To support this, get/set functions and the ImageMarkerFormat were introduced. The imageMarker property can now be accessed through the format property of the image.
This change eliminates the need to manually remove the dataset from the image element when extracting content from the DOM.

* Include ImageMetadata in FormatState (#3023)

* Support List Pasting from PowerPoint Desktop (#3012)

* Refactor paste parsers: add removeNegativeTextIndentParser and deprecatedBorderColorParser; update imports and constants for bullet list types

* Update packages/roosterjs-content-model-plugins/lib/paste/PowerPoint/processPastedContentFromPowerPoint.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Refactor bullet list constants and improve format parser signatures

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Remove comments `<!--` and `-->` from styles and re apply fix for Word Desktop Pasting  (#3024)

* Update dependencies and enhance paste functionality by cleaning HTML comments in style tags

* Reapply "Refactor getStyleMetadata to not rely on DomCreator and only use Stri…" (#3020)

This reverts commit 32f47bf.

* Enhance cleanHtmlComments to handle both HTML comment formats in style tags

* Set original DOMPurify

* Update packages/roosterjs-content-model-plugins/lib/paste/WordDesktop/getStyleMetadata.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Ensure headEndIndex is valid

* address comment

* Address comments

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* insert link in the image (#3027)

When the image is selected, do not replace the image with the link, add the link to image segment.

* square (#3029)

Instead of using a square character, this change updates the square style to use the 'square' style.

* Normalize default format (#3028)

* Normalize default format

* improve

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* auto link (#3026)

* Add margin-inline-start to watermark styles for improved positioning (#3031)

* Allow queryContentModelBlocks to query blocks in entities (#3032)

* Allow queryContentModelBlocks to search children of entity

* Expect EditorContext instead

* Break out createEditorContextForEntity function into separate file and add tests

* Fix 353323: Keep indentation when start a list, and refactor (#3033)

* 353323

* fix build, add test

* improve

* Edit plugin Options (#3036)

* options

* add test

* Do not indent on TAB (#3039)

* keyboard tab

* remove import

* Fix 354663 (#3038)

* Fix 354663

* export the new function

* Fix Word Desktop paste case (#3034)

Co-authored-by: Jiuqing Song <jisong@microsoft.com>

* Add height property to table rows in paste tests and processor (#3045)

* Add height property to table rows in paste tests and processor

* Fix build

* Remove local change

* Fix A11y bug with table selection (#3041)

* Fix A11y bug with table selection

* Add comment

* Fix 341291 (#3046)

* Fix Word Desktop pasting when using Safari (#3047)

* Enhance paste functionality: support additional document types and extract HTML head content

* Fix paste source validations for Safari: update environment handling and improve document detection logic

* Add environment param back

* Prevent multiple event attachments for mousemove in SelectionPlugin (#3049)

* Prevent multiple event attachments for mousemove in SelectionPlugin

* Update packages/roosterjs-content-model-core/test/corePlugin/selection/SelectionPluginTest.ts

* Refactor mouse event handling in SelectionPlugin to ensure proper cleanup and re-attachment on mouseDown events

* Only paste text content of button (#3050)

* Enhance paste functionality: Update setProcessor call counts in tests and add pasteButtonProcessor unit tests

* Refactor pasteButtonProcessor: Enhance button element processing and add comprehensive unit tests

* Support table edit with logical root (#3048)

* Support table edit with logical root

* fix build and test

---------

Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com>

* If font family already has single quote, keep it (#3055)

* Fix announcing in lists (#3058)

* Fix announcing in lists

* fix tests in FF

* Add role="presentation" to generic role elements in list items for better screen reader support

* Bump roosterjs-content-model-dom version to 9.29.2

---------

Co-authored-by: Jiuqing Song <jisong@microsoft.com>
Co-authored-by: Julia Roldi <87443959+juliaroldi@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: florian-msft <87671048+florian-msft@users.noreply.github.com>
@JiuqingSong JiuqingSong mentioned this pull request Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants