Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Interactivity API Docs: Update image with WordPress Make Core source #59281

Merged
merged 4 commits into from
Feb 22, 2024
Merged

Interactivity API Docs: Update image with WordPress Make Core source #59281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6f93ba5
Update image with github source
cbravobernal Feb 22, 2024
0d81c8f
Fix typo
cbravobernal Feb 22, 2024
3e0972b
Add note to indicate that API works only in 6.5 and above.
cbravobernal Feb 22, 2024
8cb2396
Use make core filesystem
cbravobernal Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/interactivity/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
> **Note**
> This package enables the API shared at [Proposal: The Interactivity API – A better developer experience in building interactive blocks](https://make.wordpress.org/core/2023/03/30/proposal-the-interactivity-api-a-better-developer-experience-in-building-interactive-blocks/). As part of an [Open Source project](https://developer.wordpress.org/block-editor/getting-started/faq/#the-gutenberg-project), participation is encouraged in testing this API providing feedback at the [discussions in GitHub](https://github.com/WordPress/gutenberg/discussions/categories/interactivity-api).

The Interactivity API is available at WordPress Core from version 6.5 [Merge announcement](https://make.wordpress.org/core/2024/02/19/merge-announcement-interactivity-api/)
The Interactivity API is available at WordPress Core from version 6.5: [Merge announcement](https://make.wordpress.org/core/2024/02/19/merge-announcement-interactivity-api/)

These Core blocks are already powered by thi API:
These Core blocks are already powered by the API:

- Search
- Query
Expand Down
5 changes: 4 additions & 1 deletion packages/interactivity/docs/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# API Reference

> **Note**
> Interactivity API is only available for WordPress 6.5 and above.

To add interactivity to blocks using the Interactivity API, developers can use:

- **Directives** - added to the markup to add specific behavior to the DOM elements of the block.
- **Store** - that contains the logic and data (state, actions, or side effects, among others) needed for the behavior.

DOM elements are connected to data stored in the state and context through directives. If data in the state or context change directives will react to those changes, updating the DOM accordingly (see [diagram](https://excalidraw.com/#json=T4meh6lltJh6TCX51NTIu,DmIhxYSGFTL_ywZFbsmuSw)).

![State & Directives](./assets/interactivity-state-directives.png)
![State & Directives](https://make.wordpress.org/core/files/2024/02/interactivity-state-directives.png)

## Table of Contents

Expand Down
Binary file removed packages/interactivity/docs/assets/interactivity-state-directives.png
View file
Open in desktop
Binary file not shown.
Loading