UI components¶

Wagtail includes a wide range of user interface (UI) components that are used to build the features within the CMS. These components are built using a combination of Django templates, template components, custom Python classes, and JavaScript. They start out as internal components, but they are designed with extensibility and reusability in mind.

We acknowledge the usefulness of reusable components and their documentation for developers building custom features or third-party packages. While we strive to maintain a stable API for these components, we also need them to evolve rapidly to allow for continuous improvements to Wagtail’s user interface.

We provide documentation for these components without making them subject to the same stability guarantees outlined in our deprecation policy. This means a component’s API may change in a minor release without going through the deprecation process. If you use these components in your own code, please ensure that you have a testing process in place to catch any breaking changes with each Wagtail upgrade.

For more details, see our Deprecation policy.