Epic: Interactivity API - public 1.0 version

Question

Epic: Interactivity API - public 1.0 version

luisherranz opened this issue a year ago · 45 comments

Answer 1 · 2023-12-19T10:48:31.000Z

The directive processing of only interactive blocks is ready for review. I will add more tests during this week.

Answer 2 · 2023-12-20T18:44:51.000Z

Related to the server-side directive processing and the above PR #56302, are there any plans to provide an API function that is decoupled from blocks? I think there are many use-cases (primarily classic "hard-coded" HTML in core, plugins, and themes) that could use the Interactivity API. If such use-cases could then call a simple function to process the directives on the HTML string, that would be really helpful.

Potentially the function gutenberg_process_interactive_html() introduced in #56302 could be what I'm looking for? As far as I can tell, the only block specific part is $inner_blocks which could be omitted?

Answer 3 · 2024-01-05T16:31:05.000Z

@felixarntz yeah, we're still trying different things here. To be honest, I'm not very happy with the current approach. And as you say, it's quite coupled with blocks.

I think we can simplify it to process only on the "root interactive blocks" and try to encapsulate everything in a single function. Maybe something like this that also classic themes could use:

$html = do_interactivity( $html );

To do so, we need to get rid of all the things that depend on knowing which part of the HTML belongs to which block during the processing (like private stores), but I think it's doable and it will simplify things.

What do you think?

Answer 4 · 2024-01-05T18:47:19.000Z

Thanks @luisherranz, that sounds like a good plan to me. I have to admit, my understanding of private stores is quite limited still. But what you're saying sounds solid as far as I can assess.

Regarding a function name, I'd prefer to do away with the "do" prefix. While it's sort of common for some WP processing functions, I think it's also somewhat legacy. I would find something like process_interactivity or parse_interactivity or parse_interactivity_directives more suitable. But a function name is probably the last challenge in this 😆

Answer 5 · 2024-01-05T19:23:12.000Z

Haha, sure. That's because I was thinking about do_blocks, but those names sound good to me. Let's see if we can condense everything into a single function 🙂

Answer 6 · 2024-01-12T15:52:25.000Z

Added a PR to render the root interactive blocks in Server Directives Processing. Ready to review!

#57729

Answer 7 · 2024-01-12T16:43:45.000Z

I created a PR to implement the data-wp-run directive. I saw it convenient to include also the hooks useWatch and useInit in the same PR. Ready for review.

#57805

Answer 8 · 2024-01-12T17:39:30.000Z

The PR with wp_initial_state was merged:

#57556

Answer 9 · 2024-01-15T17:31:42.000Z

Created two PRs that remove directives that are not being used:

I labeled them as breaking changes, in case some external developers have been using them.

Answer 10 · 2024-01-15T18:08:57.000Z

The wp-run directive implementation, the new useWatch and useInit hooks, and the scoped version of all callback-based hooks have been recently merged.

#57805

Answer 11 · 2024-01-16T11:54:52.000Z

Prevent using components in data-wp-text is ready for review:

#57879

Answer 12 · 2024-01-16T13:17:32.000Z

I'm currently working on the data-wp-each directive. Only the documentation needs to be included at this point.

#57859

I'll set the PR ready for review shortly.

Answer 13 · 2024-01-16T16:18:15.000Z

I'm currently working on the upgrade of the dependencies. ~~Is still draft, as needs some testing and I found the role in navigation is only appearing at the second click on the open button.~~ Working and merged.

#57891

Answer 14 · 2024-01-17T14:52:48.000Z

Added a bugfix that @luisherranz spotted while discussing wp-on-window and wp-on-document.

#57925

Answer 15 · 2024-01-18T13:00:20.000Z

New directives wp-on-window and wp-on-document are ready for review:

#57931

Answer 16 · 2024-01-18T13:44:08.000Z

👋 Hello team. Whats the update on this feature for WP 6.5? Is it likely to land and if so which features (as originally outlined in the roadmap) will make it. Thanks in advance 🙏

Answer 17 · 2024-01-18T15:29:27.000Z

Added a PR to rename props to attributes and remove state from getElement():

#57974

Answer 18 · 2024-01-18T16:28:39.000Z

Whats the update on this feature for WP 6.5? Is it likely to land and if so which features (as originally outlined in the roadmap) will make it.

Hey Dave 👋

The main addition is the server directive processing. I'm currently working on the backport. I'll open a couple of PRs tomorrow, one here in Gutenberg in the /compat/wordpress-6.5 folder and another one in WordPress Core.

The rest of the features that require backports are optional, and it's not clear which ones we will finally include. We'll evaluate them next week and we'll let you know.

Answer 19 · 2024-01-19T16:10:57.000Z

Made a PR for "Expose withScope and add support for async functions (generators)"

#58013

Answer 20 · 2024-01-22T11:36:01.000Z

I did a refactor of the server directive processing logic that covers most of the remaining SDP tasks and is prepared to be backported into WordPress 6.5:

#58066

EDIT: @getdave, I'll open another PR in WordPress Core with these changes.

Answer 21 · 2024-01-22T12:55:14.000Z

Thank you. If you're able to keep #57959 updated that would be much appreciated 🙇

Answer 22 · 2024-01-22T15:08:01.000Z

Small update here.

This is in really good shape now. We'll try to merge the new server directive processing refactor in time for GB 17.6. Apart from that:

wp-each:
- The client runtime is ready. The PR is not merged yet due to failing tests in trunk, but it should be available for GB 17.6.
- I'll start working on the wp-each server processor.
@wordpress/interactivity/router store
- @DAreRodz is working on it, making good progress.
Query block
- We'll work on adding the top-loading bar animation and screen announcement to the navigate action.
- We'll also move the data-wp-navigation-disabled directive to a global core/router config using the new wp_interactivity_config API.
- We'll add supports.clientNavigation to the block.json schema and we'll update the Query block to check for supports.clientNavigation.
We'll add supports.interactivity to the block.json schema.

The rest of the tasks are smaller details or optional items. We will keep working on them and reporting here.

Answer 23 · 2024-01-23T18:16:11.000Z

We'll add supports.interactivity to the block.json schema.

Once tests passed it will be ready to review.

#58132

Answer 24 · 2024-01-24T19:08:16.000Z

I created a PR to move all the router-related code to its own module and package. Awaiting tests to be merged.

#57924

Answer 25 · 2024-01-24T19:09:42.000Z

I've also created another one to rename the data-wp-navigate-id directive to data-wp-router-region.

#58191

Answer 26 · 2024-01-29T12:26:53.000Z

I've opened a new PR to move all the logic related to the ARIA live region and the loading bar from the Query block to the Interactivity Router. Ready for review.

#58377

Answer 27 · 2024-01-30T14:11:15.000Z

Can someone please clarify what is the name of the function for a default store in PHP?

In previous release was wp_store, then changed to wp_initial_state. Now it seems it's renamed to wp_interactivity_state.

Can we please specify this in docs as well?

#58436

Answer 28 · 2024-01-30T14:46:35.000Z

@Tropicalista: yes, we've renamed the function. I'll make a PR to update the docs once GB 17.6 is released with the final name.

Please follow the changelog and breaking changes discussion to get the latest updates on how the API evolves.

Answer 29 · 2024-01-31T11:52:41.000Z

I have opened a draft PR to fix the initial page cache in the @wordpress/interactivity-router module.

#58496

Answer 30 · 2024-01-31T12:28:32.000Z

I opened a PR that adds a server processor for data-wp-each:

#58498

Answer 31 · 2024-02-05T09:06:59.000Z

Small update.

The last two server directive processors (data-wp-each and data-wp-router-region) have been merged.
The navigate function now triggers the loading bar and screen reader announcement by default.

Remaining tasks:

Query block: switch from data-wp-navigation-disabled to config['core/router'].clientNavigation = false
Image block: see if we can remove the data-wp-body directive.
Other small tweaks.

Answer 32 · 2024-02-05T18:04:31.000Z

I added two more PRs:

Answer 33 · 2024-02-06T09:42:09.000Z

Added a PR with some small changes in comments. And refactors to TS.

#58718

Answer 34 · 2024-02-06T11:24:43.000Z

I've created a PR to make all core block stores private.

#58722

It includes a bugfix that solves a problem with the async initialization of private stores.

Answer 35 · 2024-02-06T17:12:57.000Z

I've opened a PR to support data-wp-interactive="myPlugin".

#58743

Answer 36 · 2024-02-06T18:51:36.000Z

Here, a draft PR that implements global configs in the JS runtime:

#58749

It also gets rid of the data-wp-navigation-disabled attribute we were adding to Query blocks when they contain unsupported blocks. Instead, a property clientNavigation inside the core/query config is used.

EDIT: the PR is ready for review now.

Answer 37 · 2024-02-07T18:50:28.000Z

I have updated the task list to mark "Populate state.url from the server" as complete, explaining that we decided not to implement that and keep the logic that initializes it from JS in @wordpress/interactivity-router.

Answer 38 · 2024-02-08T22:19:32.000Z

This PR limits the exposed API from @wordpress/interactivity:

#58864

Answer 39 · 2024-02-09T05:56:33.000Z

I opened a PR to remove the data-wp-body directive and refactor the Image block to add the overlay using wp_footer instead:

#58835

Answer 40 · 2024-02-09T10:09:33.000Z

Regarding one meta aspect of how we communicate this functionality more broadly, I think Interactivity API is ok as the technical aspect for developers, but when we talk broadly about what it does I think we should refer to it as Interactions. Interactions is the feature, and it's powered by this new developer API.

So similar to block API -> blocks we'll have interactivity API -> interactions. I find that clearer and easier than interactivity on its own, but curious what others think. I don't believe this has any material considerations on namespace issues at the code level, except perhaps the possibility of renaming the entry package to @wordpress/interactions.

Answer 41 · 2024-02-09T13:49:10.000Z

Regarding one meta aspect of how we communicate this functionality more broadly, I think Interactivity API is ok as the technical aspect for developers, but when we talk broadly about what it does I think we should refer to it as Interactions. Interactions is the feature, and it's powered by this new developer API.

So similar to block API -> blocks we'll have interactivity API -> interactions. I find that clearer and easier than interactivity on its own, but curious what others think. I don't believe this has any material considerations on namespace issues at the code level, except perhaps the possibility of renaming the entry package to @wordpress/interactions.

This would need careful consideration, for sure. Having 2 names for the same functionality can also make things less clear in some cases. There is currently this issue with people referring to the "WordPress Block Editor" as "The Gutenberg Editor". Maybe `interactivity API -> interactivity"? Just a thought.

Answer 42 · 2024-02-12T20:37:45.000Z

Added a PR to fix directives not being processed if the HTML contained a SVG or a MATH.

WordPress/wordpress-develop#6091

Answer 43 · 2024-02-12T22:33:21.000Z

Now that we are past the Beta 1 cut off point I'm removing this tracking issue from the 6.5 Project board. From now on the board should only contain individual bugs that we want to still fix before 6.5 gets released.

Answer 44 · 2024-02-20T11:01:47.000Z

Should we also close the issue an open separate issues for remaining tasks so those applicable can be put on the 6.5 board and tackled before 6.5 Beta 3 scheduled for Tuesday next week?

Answer 45 · 2024-02-20T19:40:39.000Z

I will miss this tracking issue 😅, but yep, I will do that.

Tasks