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.

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

Add interactivity property to block supports refecernce documentation #59152

Merged
merged 1 commit into from
Feb 18, 2024

Conversation

fabiankaegy
Copy link
Member

What?

Add interactivity property to block supports refecernce documentation

Why?

So the documentation includes all the available properties.

How?

Referencing the JSON Schema documentation:

"interactivity": {
"description": "Indicates if the block is using Interactivity API features.",
"oneOf": [
{
"type": "boolean",
"description": "Indicates whether the block is using the Interactivity API directives.",
"default": false
},
{
"type": "object",
"properties": {
"clientNavigation": {
"type": "boolean",
"description": "Indicates whether a block is compatible with the Interactivity API client-side navigation.\n\nSet it to true only if the block is not interactive or if it is interactive using the Interactivity API. Set it to false if the block is interactive but uses vanilla JS, jQuery or another JS framework/library other than the Interactivity API.",
"default": false
},
"interactive": {
"type": "boolean",
"description": "Indicates whether the block is using the Interactivity API directives.",
"default": false
}
}
}

Copy link

github-actions bot commented Feb 18, 2024

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: c4rl0sbr4v0 <cbravobernal@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Member

@Mamaduka Mamaduka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ship it 🚢

Copy link

github-actions bot commented Feb 18, 2024

Flaky tests detected in 396d6d3.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7949439098
📝 Reported issues:

@fabiankaegy fabiankaegy enabled auto-merge (squash) February 18, 2024 14:09
@fabiankaegy fabiankaegy enabled auto-merge (squash) February 18, 2024 14:10
Copy link
Contributor

@cbravobernal cbravobernal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!! 🚀

There is a list of what we should include in the docs. We can track it there.

#53296 (comment)

@Mamaduka Mamaduka merged commit a2e3291 into trunk Feb 18, 2024
67 checks passed
@Mamaduka Mamaduka deleted the docs/add-interactivity-to-block-supports-reference branch February 18, 2024 15:22
@github-actions github-actions bot added this to the Gutenberg 17.8 milestone Feb 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
3 participants