-
Notifications
You must be signed in to change notification settings - Fork 179
Support cache for list #3204
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
Support cache for list #3204
Conversation
There was a problem hiding this 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 introduces caching support for list and list item elements to improve editing performance when working with long lists. The cache prevents unnecessary recreation of list structures when only formatting changes occur.
Key changes:
- Adds a new experimental feature
CacheList(enabled by default in demo site) - Introduces
refNodetracking in list stack to manage element reuse - Implements caching logic for both list containers (OL/UL) and list items (LI)
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
ExperimentalFeature.ts |
Adds CacheList experimental feature flag |
ModelToDomFormatContext.ts |
Adds refNode property to track next insertion point in list stack |
EditorContext.ts |
Adds allowCacheListItem flag to control list caching behavior |
stackFormat.ts |
Preserves and restores nodeStack during format operations |
cleanUpRestNodes.ts |
New utility to remove remaining DOM nodes during rewrite |
handleList.ts |
Implements caching logic for list container elements (OL/UL) |
handleListItem.ts |
Implements caching logic for list item elements (LI) |
handleBlockGroupChildren.ts |
Adds cleanup of list node stack between non-list blocks |
createEditorContext.ts |
Enables allowCacheListItem when CacheList feature is active |
setListType.ts |
Uses readonly types and mutateBlock for immutability |
| Various test files | Updates tests to include refNode: null in expectations and adds comprehensive cache tests |
| Demo files | Enables CacheList feature by default in demo site |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/roosterjs-content-model-dom/lib/modelToDom/handlers/handleList.ts
Show resolved
Hide resolved
packages/roosterjs-content-model-dom/lib/modelToDom/handlers/handleBlockGroupChildren.ts
Outdated
Show resolved
Hide resolved
…andleBlockGroupChildren.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* support RTL (#3177) * Update ContextMenuProvider to accept event parameter and adjust related tests (#3175) * refactor: remove deprecated features and clean up related code in CachePlugin and CopyPastePlugin (#3178) * Add `test:fast` for faster unit test runs (#3179) * refactor: optimize karma configuration for improved performance * feat: add fast karma configuration and update package.json for debugging * refactor: streamline karma plugin declaration and update test scripts for clarity * refactor: update test commands to use fast karma configuration * Add support for retaining formats when splitting paragraphs on Enter/Delete/Backspace keypress (#3180) * refactor: optimize karma configuration for improved performance * feat: add fast karma configuration and update package.json for debugging * refactor: streamline karma plugin declaration and update test scripts for clarity * Add support for retaining formats when splitting paragraphs on Enter key press - Introduced `formatsToKeep` option in `EditOptions` to specify which formats to retain. - Updated `keyboardEnter`, `handleEnterOnParagraph`, and `splitParagraph` functions to handle the new formats. - Enhanced tests to verify the correct behavior of format retention during paragraph splits. * Remove unused import for handleEnterOnParagraph in keyboardEnterTest * Remove stray backtick from splitParagraph function * refactor: update test commands to use fast karma configuration * feat: implement class format handling and preserve formatting on paragraph split * feat: rename formatsToKeep to formatsToPreserveOnMerge and update related functionality * test: update spies in keyboardDelete tests and fix format property in preserveParagraphFormat tests * Support rowSpan equal to 0 (#3181) * fix: handle zero colSpan and rowSpan in tableProcessor to ensure proper cell creation * fix: correct colSpan condition in tableProcessor for accurate cell processing * feat: add spanUntilNextSection support in table cell processing and handling * refactor: remove spanUntilNextSection from table cell handling and related tests * refactor: simplify rowSpan handling and improve tableProcessor tests for edge cases * Remove unneeded changes * Remove * fix: update source map configuration for improved debugging accuracy (#3186) * Support passing event to getContextMenuItems when plugin is a MixedPlugin (#3188) * feat: enhance context menu handling to support V9 providers with event parameter * fix: enhance isV9ContextMenuProvider to check for mixed plugins * refactor: simplify spyOn usage for DarkColorHandler in BridgePlugin tests * fix: enhance isV9ContextMenuProvider to validate V9 provider signature * fix: update context menu provider check to use isMixedPluginProvider * New getContentForCopy API (#3182) New getContentForCopy API * feat: add announce options for bold, italic, and underline formatting (#3194) * feat: add announce options for bold, italic, and underline formatting; update shortcuts and tests * refactor: update context initialization in toggleBold, toggleItalic, and toggleUnderline tests for type safety * Address comments from review * test: add unit tests for bold, italic, and underline shortcuts with announceFormatChange * Add Find and Replace API and plugin (#3190) * Add Find and Replace API and plugin * Fix a comment * improve * feat: add announcements for table selection and unselection in the editor (#3195) * feat: add announce options for bold, italic, and underline formatting; update shortcuts and tests * refactor: update context initialization in toggleBold, toggleItalic, and toggleUnderline tests for type safety * feat: add announcements for text selection and unselection in the editor * refactor: simplify table selection logic by using TableSelection type in getIsSelectingOrUnselecting function * Update packages/roosterjs-content-model-core/lib/corePlugin/selection/tableSelectionUtils.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Address comments from review * test: add unit tests for bold, italic, and underline shortcuts with announceFormatChange * Move functionality to a new plugin * Fix * Fix * Fix comment --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix #396891 (#3199) * Fix #396891 * improve * improve * first colunm (#3202) * Fix 400434 (#3200) * Add format when insert table (#3203) Add the format parameter in the insertTable API, then it will be possible to insert a table with a predefined format. It can be used to add margin bottom to the table, then when a table is inserted under another their border does not overlay. * Move graduated feature to a separate type (#3205) * Move graduated feature to a separate type * improve * fix build * Translate lineHeight normal to 120% when pasting from Word Desktop and move parsers to their own file (#3209) * Translate lineHeight normal to 120% and move parsers to their own file * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix text to bullet issue (#3210) * Fix text to bullet issue * fix test * Refactor paste source validation to use getDocumentSource (#3208) * Refactor paste source validation to use getDocumentSource - Updated shouldConvertToSingleImage to utilize htmlFirstLevelChildTags instead of clipboardData. - Replaced instances of getPasteSource with getDocumentSource across various tests and implementations. - Introduced getDocumentSource function to centralize document source determination logic. - Added retrieveDocumentMetadata utility to extract metadata from documents. - Ensured all related tests are updated to reflect changes in function calls and parameters. * Refactor paste handling and add tests for negative text indent parser * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix #3171 #3184 (#3211) * Fix #3171 #3184 * Update packages/roosterjs-content-model-plugins/lib/edit/EditPlugin.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Use getPromoteLink to verify if a link can be promoted (#3213) Add getPromoteLink function to verify if a link can be promoted. * [fix] Keep format on the selection marker when reconcile Text (#3220) * [fix] Keep format on the selection marker when reconcile Text * update ut * update test * [Image Edit] Fix 394371 (#3219) Check if the selectedImage property exists when the content changed event is triggered, * Update the Entity's format when applying format on the content inside the Entity (#3196) * Update the Entity's format when applying format on the content inside the Entity * fix test * Fix Align Attribute being removed on paste for containers (#3217) * Add wordContainerParser to handle negative margin-left values and update processPastedContentFromWordDesktop to use it * asd * Refactor wordContainerParser to remove unused parameters * remove * update * Support cache for list (#3204) * Support cache for list * fix build * improve * add tests * add test * add test * Update packages/roosterjs-content-model-dom/lib/modelToDom/handlers/handleBlockGroupChildren.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Try generate url data (#3222) wrap the draw image function in a try statement, if successful the image will be drawn in the canvas, if not return the data URL of the previous image --------- Co-authored-by: Julia Roldi <87443959+juliaroldi@users.noreply.github.com> Co-authored-by: Bryan Valverde U <bvalverde@microsoft.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Haowen Chen <haowchen@microsoft.com>
Content Model cache was not working for list and list items because they are too complex. But when adding long enough content under list, we still need the cache to help improve editing performance, otherwise every time we do format change, the whole list need to be rebuilt.
In this change I start to enable cache for list and list item. It is under a new experimental feature
CacheListand it is by default turned on in demo site. With this flight, all behaviors should be the same with before, but list won't be recreated unless list itself is changedBefore:

After: