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

Docs: Core Concepts of Interactivity API - "Interactivity vs. Reactivity explanation" page #63526

Open
WPLake opened this issue Jul 13, 2024 · 0 comments
Labels
[Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.

Comments

@WPLake
Copy link

WPLake commented Jul 13, 2024

We suggest including an "Interactivity vs. Reactivity explanation" page in the Core Concepts section for the iAPI.

The idea is to clarify why the API is called 'Interactivity', its relation to reactivity, and whether the iAPI can be officially considered as a 'native WordPress' alternative to Vue/React.

Reason: React and Vue are industry standards, and devs using these frameworks are familiar with the term "reactivity." However, when they hear "interactivity" for the first time, they may not immediately understand the analogy. It is important to convey that it is a native declarative way to create front-end experiences, akin to "React in WordPress".

In our view, the content should say something like:

Reactivity is a term that is widely used and describes a key characteristic of the declarative approach, allowing the layout to change as soon as the variables used in it change. The Interactivity API's front end is built on top of Preact, which is a reactive framework.

So, when you're using the WP Interactivity API, you can say that it's a reactive tool as well. But, keep in mind that reactivity is a feature, even if it's a key feature of the Interactivity API. Besides that, the API includes more, such as Server Side Rendering, which has its own implementation. So, the Interactivity API encompasses all the features related to it, while reactivity is an important part of it.

P.S. Check out this section in our WPLake blog article, which can be used as a base and amended to match the wp.org writing style guides.

@WPLake WPLake added the [Type] Enhancement A suggestion for improvement. label Jul 13, 2024
@skorasaurus skorasaurus added the [Type] Developer Documentation Documentation for developers label Nov 12, 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 [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

2 participants