JSPM

@wordpress/interactivity

6.12.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 38073
  • Score
    100M100P100Q155950F
  • License GPL-2.0-or-later

Package that provides a standard and simple way to handle the frontend interactivity of Gutenberg blocks.

Package Exports

  • @wordpress/interactivity
  • @wordpress/interactivity/build-module/index.js
  • @wordpress/interactivity/build/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wordpress/interactivity) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@wordpress/interactivity

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.



Code is Poetry.