Interactivity API docs: Add wp-async directives doc #62663
Merged
Conversation
This file contains 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
cbravobernal
added
the
[Type] Developer Documentation
cbravobernal
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
westonruter
requested changes
Jun 18, 2024
| @@ -383,6 +392,10 @@ store( "myPlugin", { | |||
|
|
|||
| The callback passed as the reference receives [the event](https://developer.mozilla.org/en-US/docs/Web/API/Event) (`event`), and the returned value by this callback is ignored. When the element is removed from the DOM, the event listener is also removed. | |||
|
|
|||
| ### `wp-on-document-async` | |||
|
|
|||
| Similar to `wp-on-async`. An optimized version of `wp-on-document` that prevents blocking the main thread on long tasks. Use this directive for any `wp-on-document` that doesn't need the `event` object (`event.preventDefault()`, `event.stopPropagation()`, etc.) | |||
There was a problem hiding this comment.
Suggested change
| Similar to `wp-on-async`. An optimized version of `wp-on-document` that prevents blocking the main thread on long tasks. Use this directive for any `wp-on-document` that doesn't need the `event` object (`event.preventDefault()`, `event.stopPropagation()`, etc.) | |
| Similar to `wp-on-async`. An optimized version of `wp-on-document` that prevents blocking the main thread on long tasks. Use this directive for any `wp-on` that doesn't need synchronous access to the `event` object, in particular the methods `event.preventDefault()`, `event.stopPropagation()`, and `event.stopImmediatePropagation()`. This event listener is also added as `passive`. |
There was a problem hiding this comment.
Done in e3b0497
|
See also #62665 which would impact the docs here, especially the "async actions" section. |
|
Flaky tests detected in e3b0497. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9571563158
|
westonruter
approved these changes
Jun 19, 2024
ellatrix
added
the
Backport to WP 6.6 Beta/RC
ellatrix
pushed a commit
that referenced
this pull request
Jun 25, 2024
* Add wp-async directives doc * Changes requested * Add notes to use async and further refine copy * Add links including to async actions section * Add async action example which yields to the main thread --------- Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: westonruter <westonruter@git.wordpress.org>
|
I just cherry-picked this PR to the wp/6.6-rc-1 branch to get it included in the next release: c8372ed |
ellatrix
added
Backported to WP Core
ellatrix
pushed a commit
that referenced
this pull request
Jun 25, 2024
* Add wp-async directives doc * Changes requested * Add notes to use async and further refine copy * Add links including to async actions section * Add async action example which yields to the main thread --------- Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: westonruter <westonruter@git.wordpress.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Add documentation for
data-wp-asyncdirectives.Completes #61885