JavaScript components

Wagtail’s JavaScript components are documented using TypeDoc. This documentation is automatically generated from the source code and provides detailed information about the available components, their methods, and properties. At this stage, the documentation is not exhaustive and may include internal APIs that are not accessible by external code. We are working on improving the code and documentation to make it more comprehensive and user-friendly in the future.

For a how-to guide on using Wagtail’s JavaScript components, see Extending client-side behavior.

Proceed to the JavaScript components reference documentation.