Skip to content

Interactivity API iteration for WordPress 6.7 #63232

Closed

Description

@luisherranz

In WordPress 6.6, work was done to improve warnings integration with Preact DevTools, as well as adding directives for asynchronous event handlers and support for derived state on the server.

In WordPress 6.7, we will continue working on internal improvements to ensure that the Interactivity API's code is as simple and stable as possible and to make the Interactivity API resilient when used asynchronously (e.g., adding directives or stores after initialization). This will pave the way for performance improvements such as directive code splitting or lazy loading of interactive blocks.

In Core blocks, work will begin on the Gallery block lightbox and the Query block's Instant Search.

Apart from the work for WordPress 6.7, investigations will continue, with the most important being the exploration of how to improve assets management in region-based client-side navigation and experimenting with full-page client-side navigation. However, those will be tracked in its own Tracking Issue.

Work is also continuing to improve the documentation with enhancements in the API Reference and new explanatory guides tracked in the Interactivity API documentation's Tracking Issue.


This is the list of initial tasks, although we will edit this post as we progress and discover other things that we need to do.

Enhancements

Core blocks (optional)

Bug fixes

Optional

Activity

  1. added
    [Type] Tracking IssueTactical breakdown of efforts across the codebase and/or tied to Overview issues.
    on Jul 8, 2024
  2. added
    [Type] IterationScoped iteration of an effort from a tracking issue or overview issue ideally for a major release.
    and removed
    [Type] Tracking IssueTactical breakdown of efforts across the codebase and/or tied to Overview issues.
    on Jul 8, 2024
  3. changed the title [-]Tracking Issue: Interactivity API in WP 6.7[/-] [+]Interactivity API iteration for WordPress 6.7[/+] on Jul 8, 2024
  4. adamsilverstein commented on Jul 8, 2024

    @adamsilverstein
    Member

    Can you also consider #60522?

  5. luisherranz commented on Jul 9, 2024

    @luisherranz
    MemberAuthor

    Can you also consider #60522?

    I thought that work was still experimental since it requires using Chrome Canary. But if you think it should be included in WordPress 6.7, sure, we can include it 🙂

  6. adamsilverstein commented on Jul 9, 2024

    @adamsilverstein
    Member

    I thought that work was still experimental since it requires using Chrome Canary. But if you think it should be included in WordPress 6.7, sure, we can include it 🙂

    true, it is still experimental and thus maybe not ready for 6.7!

    I'm hoping it lands in stable soon and this is a purely debugging related feature. Mostly I don't want the work to fall off the radar and I thought to some degree experimental features where acceptable in Gutenberg since we can always pull them before merging into core.

  7. luisherranz commented on Jul 9, 2024

    @luisherranz
    MemberAuthor

    Ok, then let's leave it out of the list of things for WordPress 6.7 but let's keep an eye on including it in future versions once the APIs are stable 🙂

    experimental features where acceptable in Gutenberg since we can always pull them before merging into core

    Sure, if you want to merge it in Gutenberg to test it out, that's totally fine.

  8. adamsilverstein commented on Jul 9, 2024

    @adamsilverstein
    Member

    Sure, if you want to merge it in Gutenberg to test it out, that's totally fine.

    That is indeed exactly what I want to do - in part the goal here is to give the team building the feature (DevTools performance panel extensibility API or "User Timings") feedback about what is useful and what is missing. By testing the feature out in Gutenberg, we can influence how it being built before it lands in stable.

  9. moved this to Definition ✏️ in WP Performance Ongoingon Jul 16, 2024
  10. ajgagnon commented on Jul 22, 2024

    @ajgagnon

    Any chance of getting a data-wp-if directive included? It would be immensely helpful. Happy to attempt a PR if this is in the scope.

    <template data-wp-if="context.open">
        <div>Contents...</div>
    </template>
    
  11. luisherranz commented on Jul 22, 2024

    @luisherranz
    MemberAuthor

    Yeah, a data-wp-show directive is on the roadmap indeed.

    If you're willing to work on it we'd love to help you out. As far as I remember, the work not only requires the client-side directive implementation, but also an extra function similar to this one for the server-side rendering.

    But we can discuss the details in a proper issue or in Slack 🙂

  12. ajgagnon commented on Jul 22, 2024

    @ajgagnon

    Sure! I had left a comment there on the original issue here:

    #53058 (comment)

    It looks like the scope has not been decided yet, so that seems like the first item needed.

  13. 6 remaining items

  14. sethrubenstein commented on Aug 30, 2024

    @sethrubenstein
    Contributor

    @luisherranz Can you share a little bit about what getServerState and what getServerContext will do?

  15. luisherranz commented on Aug 30, 2024

    @luisherranz
    MemberAuthor

    Sure! Since it's not possible for the initial server state to overwrite the client state because that approach is not compatible with region-based client-side navigation, we need an API for use cases where, after navigating, you want to inspect the initial state or context of the new page.

    So those two functions will return the initial state or context that came from the server and they are reactive, so that initial state or context updates every time there is a client-side navigation. People would normally use them in a data-wp-watch. For example:

    <div data-wp-watch="callbacks.updateServerContext">...</div>
    store('...', {
      callbacks: {
        updateServerContext() {
          const context = getContext();
          const serverContext = getServerContext();
    
          // Override some property with the new value that came from the server.
          context.overridableProp = serverContext.overridableProp;
        },
      },
    });

    That's it! The same for state using getServerState.

    @DAreRodz will open a pull request next week, and we appreciate any feedback and assistance testing this new API, that if everything goes well, would make it into WP 6.7 😄

  16. madhusudhand commented on Sep 2, 2024

    @madhusudhand
    Member

    @mikachan @madhusudhand, could you give us your estimate on the Gallery, Accordion and Tabs blocks?

    Gallery block is close to getting merged. It is pending with following feedback

    • And moving gallery_id to a shared space - related feedback ✅
    • Accessibility concerns with inert pointed here 🚧

    I am looking into the second feedback item. Hopefully it will be resolved this week.

  17. annezazu commented on Sep 3, 2024

    @annezazu
    Contributor

    Sweet! I'll add the Gallery block back onto the 6.7 roadmap.

  18. DAreRodz commented on Sep 9, 2024

    @DAreRodz
    Contributor

    Updates

    I've added the following bug fixes to the tracking issue:

    The first bug was a regression introduced in #62734, and it's merged and ready for the next Gutenberg RC. The second one is a missing piece of logic we forgot to include in #64879. It's ready for review.

    The following PR is also ready for review. I've introduced a change that depends on #65135 being merged; the failing test should pass after that.

    As the next step, I have to open a PR for getServerContext() and getServerState(), which is currently WIP.

  19. DAreRodz commented on Sep 9, 2024

    @DAreRodz
    Contributor

    I've just created a draft for the getServerContext() and getServerState() functions.

  20. michalczaplinski commented on Sep 11, 2024

    @michalczaplinski
    Contributor

    I've created a new issue to discuss the getServerState() & getServerContext() APIs: #65243

  21. madhusudhand commented on Sep 17, 2024

    @madhusudhand
    Member

    @annezazu The current approach we took for gallery block is rendering translations on server (because i18n isn't available as script module), which is observed to be complex and is not a good example/practice for the community.
    I think we should punt it to 6.8

  22. annezazu commented on Sep 17, 2024

    @annezazu
    Contributor

    Thanks for the update! Agreed. Let’s punt.

  23. gziolo commented on Sep 20, 2024

    @gziolo
    Member

    #65151 landed this week and contains a new public API 🎉As it's going to be included in WordPress 6.7, it will need an accompanying dev note (added label) and documentation in the Interactivity API reference.

  24. gziolo commented on Nov 19, 2024

    @gziolo
    Member

    WordPress 6.7 “Rollins”, which contains all the finished work, was released last week. The work for unfinished but still applicable tasks will continue in the new iteration issue created in the following days.

  25. moved this from Definition ✏️ to Done 😃 in WP Performance Ongoingon Nov 19, 2024
  26. moved this from 📋 Iteration/Tracking Issues to ✅ Done in WordPress 6.7 Editor Taskson Nov 19, 2024
  27. luisherranz commented on Nov 25, 2024

    @luisherranz
    MemberAuthor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    [Feature] Interactivity APIAPI to add frontend interactivity to blocks.[Type] IterationScoped iteration of an effort from a tracking issue or overview issue ideally for a major release.

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions