Plone REST API JavaScript client

This is the documentation for the Plone REST API JavaScript client

Overview

• Quick Start
  • Installation​
  • ploneClient entry point
  • Query (or mutation) options factories
  • Plone Client React Hooks
• Endpoint actions
  • Actions
  • Add-ons
  • Aliases
  • Breadcrumbs
  • Comments
  • Content
  • Context Navigation
  • Control Panels
  • Copy and Move
  • Database
  • Email Notification
  • Email Send
  • Groups
  • History
  • Link Integrity
  • Locking
  • Login
  • Navigation
  • Navigation root
  • Principals
  • Querysources
  • Querystring
  • Querystring Search
  • Registry
  • Relations
  • Roles
  • Search
  • Site
  • Sources
  • System
  • Transactions
  • Translations
  • Types
  • Upgrade
  • Users
  • User schema
  • Vocabularies
  • Workflow
  • Working Copy
• Miscelaneous considerations
  • queryWithConfig and mutationWithConfig functions
  • queryHookFromQuery and mutationHookFromMutation functions
• Future improvements
  • Separate out the react-query part from @plone/client into a separate package
  • Put @tanstack/react-query and axios as peer-dependencies in @plone/client
  • SSR support in @plone/client