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

Create API Reference docs for the Interactivity API #52922

Closed
juanmaguitar opened this issue Jul 25, 2023 · 1 comment
Closed

Create API Reference docs for the Interactivity API #52922

juanmaguitar opened this issue Jul 25, 2023 · 1 comment
Assignees
Labels
[Feature] Interactivity API API to add frontend interactivity to blocks. [Type] Developer Documentation Documentation for developers

Comments

@juanmaguitar
Copy link
Contributor

juanmaguitar commented Jul 25, 2023

Interactivity API needs documentation for its API at https://github.com/WordPress/gutenberg/tree/trunk/packages/interactivity/docs
These are the basic concepts that need to be documented.

  • Populate store with an initial state
  • Document JS API (view.js)
    • Store
      • State, selectors, actions, effects
  • Document directives (grouped by functionality)
    • Declarative function
      • data-wp-interactive
      • data-wp-key
    • State
      • data-wp-context
    • Attributes
      • data-wp-bind
      • data-wp-class
      • data-wp-style
    • Inner content
      • data-wp-text
    • Event handlers
      • data-wp-on
    • Side effects
      • data-wp-effect
      • data-wp-init
@juanmaguitar juanmaguitar self-assigned this Jul 25, 2023
@juanmaguitar juanmaguitar added [Type] Developer Documentation Documentation for developers [Feature] Interactivity API API to add frontend interactivity to blocks. labels Jul 25, 2023
@juanmaguitar
Copy link
Contributor Author

juanmaguitar commented Aug 3, 2023

Solved by #52948
See https://github.com/WordPress/gutenberg/blob/trunk/packages/interactivity/docs/2-api-reference.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Interactivity API API to add frontend interactivity to blocks. [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

1 participant