Skip to content

Docs: Interactivity API - Split "API Reference" page in 5 subsections: Directives, Store, Server API, Client APIs and Router #62920

@juanmaguitar

Description

@juanmaguitar

The current API Reference could be reorganized to distribute its content among specific sections, each dedicated to one of its major topics, as follows:

  • Directives
  • Store
  • Server API
  • Client API
  • Router (this one is still not part of this page but it would fit great in this new suggested structure)

The suggested final structure would be something like this:

  • Directives
    • What are directives?
    • List of directives
    • Values of directives are references to store properties
  • Store
    • Elements of the store
      • State
      • Actions
        • Async actions
      • Side Effects
      • Derived state 
        • How to define it but what is this is explained in more detail on Fundamentals of the Interactivity API (Core Concepts) > State, context, and derived state
    • Accessing data in callbacks
    • Setting the store
      • On the client side
      • On the server side
    • Private stores
  • Server APIs
    • wp_interactivity_state
    • wp_interactivity_config
    • wp_interactivity_process_directives
    • wp_interactivity_data_wp_context
  • Client APIs
    • getContext()
    • getElement()
    • withScope()
  • Router
    • Description of a specific Store already created for router purposes

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions