Interactivity API is a proposal for a new standard to create interactive blocks. It's still in an experimental phase and is available with Gutenberg 16.2 or later

This tracking issue compiles all issues related to the documentation of the Interactivity API to keep track of the pending tasks and to ease the coordination of this work.

Interactivity API Docs are currently being created as Markdown files in the /docs folder of the interactivity package . When the Interactivity API is no longer in an experimental phase or is integrated into WordPress Core, the plan is to move this documentation to the Block Editor HandBook

If you are willing to help with the documentation, please add a comment to #51928, and we'll coordinate everyone's efforts.

Tasks

Tasks related to Interactivity API Docs are labelled with [Feature] Interactivity API] & [Type] Developer Documentation]

• Docs: Interactivity API - document wp_interactivity_state in the API reference #63672
• Docs: Interactivity API - Add additional info on Preact's selection over Alpine #63570
• Docs: Interactivity API - Create and "Interactivity API" section under "How to Guides" section and include some initial guides #62922
• Docs: Interactivity API - Create a Core Concepts section for the iAPI #62921
• Docs: Interactivity API - Split "API Reference" page in 5 subsections: Directives, Store, Server API, Client APIs and Router #62920
• Docs: Interactivity API - Create a new page on "Getting Started > Fundamentals of Block Development" to introduce Interactive Blocks using iAPI #62872
• Docs: Interactivity API - "@wordpress/interactivity-router" README needs to be updated to reflect is not experimental anymore #62055
• Docs: Interactivity API - Shape a section in the docs providing a full response to the question "Why it's not possible to just use React?" #60783
• Docs: Interactivity API - Move docs from "Reference Guides > Package Reference > @wordpress/interactivity" to "Reference Guides > Interactivity API Reference" #60781
• Docs: Interactivity API - Region-based client-side navigation router #56638
• Docs: Interactivity API - Rename wp-effect to wp-watch #56641
• Docs: Interactivity API - New store() API #56640
• Create API Reference docs for the Interactivity API #52922
• Add code requirements for using the Interactivity API on any block #52929
• Update README.md of docs folder to include a reference to the API Reference #53384
• Update README.md of interactivity package to include a reference to the docs at docs folder #53386