Interactiviy API Docs: Merge Interactivity docs to keep consistency with other packages. #59270
Conversation
cbravobernal
added
[Type] Developer Documentation
cbravobernal
requested review from
luisherranz,
DAreRodz,
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. |
|
Flaky tests detected in d5d92fb. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/8005211442
|
packages/interactivity/README.md
Outdated
| Install the module: | ||
|
|
||
| At this point, some of the questions you have about the Interactivity API may be: | ||
| ```bash | ||
| npm install @wordpress/interactivity --save | ||
| ``` |
There was a problem hiding this comment.
I know this was there in the previous docs but I would add a note here that this step is only required if you are building outside of WordPress...
Within WordPress you don't need to install the package via NPM because it is bundled with WordPress core and all you need to do to ensure it is loaded is adding wp-interactivity to the dependency array of the module script.
Which happens automatically when you use the dependency ectraction webpack plugin that is used in tools like wp-scripts.
packages/interactivity/README.md
Outdated
|
|
||
| ### Where can I share my feedback about the API? | ||
| When the plugin folder is generated, the build process needs to be launched to get the final version of the interactive block that can be used from WordPress. |
There was a problem hiding this comment.
| When the plugin folder is generated, the build process needs to be launched to get the final version of the interactive block that can be used from WordPress. | |
| When the plugin folder is generated, the build process needs to be launched to get a working version of the interactive block that can be used in WordPress. |
| @@ -659,7 +659,7 @@ It would generate the following output: | |||
| </ul> | |||
| ``` | |||
|
|
|||
| The prop that holds the item in the context can be changed by passing a suffix to the directive name. In the following example, we change the default prop `item` to `greeting`. | |||
| The prop that holds the item in the context can be changed by passing a suffix to the directive name. In the following example, the default prop changes from `item` to `greeting`. | |||
|
|
|||
| ```html | |||
| <ul data-wp-context='{ "list": [ "hello", "hola", "olá" ] }'> | |||
There was a problem hiding this comment.
I'm still a little confised when you would use wp_interactivity_state over a raw data-wp-context
There was a problem hiding this comment.
The main difference between state and context is that the first one is globally accessible, i.e., any directive at any part of the page can access it (as long as it's not locked), whereas the second one is "inherited" (only directives inside of it can access the context), and can be locally extended or "shadowed" by adding other elements inside it with their own data-wp-context directive.
What?
This PR moves the Interactivity API docs folder to a main README file. It also updates the docs with the last changes, removing all the experimental references and adding the 6.5 Core announcement.