@wordpress/interactivity

In this article

The package @wordpress/interactivity contains the logic that enables the Interactivity API which was introduced in WordPress Core in v6.5. This means this package is already bundled in Core in any version of WordPress higher than v6.5.

Check the Interactivity API Reference docs in the Block Editor handbook to learn more about the Interactivity API.

Installation

Install the Interactivity API using the command:

npm install @wordpress/interactivity --save

This step is only required if you use the Interactivity API outside WordPress.

Within WordPress, the package is already bundled in Core. To ensure it’s loaded, add @wordpress/interactivity to the dependency array of the script module. This process is often done automatically with tools like wp-scripts.

Furthermore, this package assumes your code will run in an ES2015+ environment. If you’re using an environment with limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

License

Interactivity API proposal, as part of Gutenberg and the WordPress project is free software, and is released under the terms of the GNU General Public License version 2 or (at your option) any later version. See LICENSE.md for complete license.