-
Notifications
You must be signed in to change notification settings - Fork 4.7k
RichText: Reuse DOM document across calls to createEmpty #12402
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
038769c
RichText: Reuse DOM document across calls to createEmpty
aduth f0c9aa5
RichText: Reuse document in createElement
ellatrix bdce846
Rich Text: Update tests to clone node to retain reference
aduth f9e9e89
Rich Text: Refactor createEmpty to use createElement
aduth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next
Next commit
RichText: Reuse DOM document across calls to createEmpty
- Loading branch information
commit 038769c184f3bcf4948faee16e32077d9e8e8e27
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,9 +58,28 @@ function getNodeByPath( node, path ) { | |
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new instance of a DOM tree upon which RichText operations can be | ||
| * applied. | ||
| * | ||
| * Note: The current implementation will return a shared reference, reset on | ||
| * each call to `createEmpty`. Therefore, you should not hold a reference to | ||
| * the value to operate upon asynchronously, as it may have unexpected results. | ||
| * | ||
| * @return {WPRichTextTree} RichText tree. | ||
| */ | ||
| function createEmpty() { | ||
| const { body } = document.implementation.createHTMLDocument( '' ); | ||
| return body; | ||
| // Because `createHTMLDocument` is an expensive operation, and with this | ||
| // function being internal to `rich-text` (full control in avoiding a risk | ||
| // of asynchronous operations on the shared reference), a single document | ||
| // is reused and reset for each call to the function. | ||
| if ( createEmpty.body ) { | ||
|
||
| createEmpty.body.innerHTML = ''; | ||
| } else { | ||
| createEmpty.body = document.implementation.createHTMLDocument( '' ).body; | ||
| } | ||
|
|
||
| return createEmpty.body; | ||
| } | ||
|
|
||
| function append( element, child ) { | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
There's also
createElement, see #12470. It would be great if we could merge these two functions into one?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.
Maybe we can update the PR here to also address
createElementand only keep one.