Headless SDK
The dotCMS's Software Development Kit (SDK) is a group of libraries — mostly JavaScript — created to facilitate the building of headless pages and the integration with popular frontend frameworks. The SDKs simplify the process of data retrieval through dotCMS REST APIs, enabling developers to concentrate on their front-end code for faster development.
The SDK includes a growing collection of libraries:
| Library | Description |
|---|---|
@dotcms/client | The Client library interacts securely with the dotCMS instance API. |
@dotcms/react | The React library supports rendering sites and applications built using ReactJS to interface with the Universal Visual Editor. |
@dotcms/angular | The Angular library supports rendering sites and applications built using the Angular framework to interface with the Universal Visual Editor. |
@dotcms/types | The Types library includes TypeScript type definitions for the dotCMS ecosystem. |
@dotcms/uve | The UVE library adds live editing to your app using the Universal Visual Editor (UVE), including low-level tools that power rendering libraries — such as @dotcms/react and @dotcms/angular. |
@dotcms/experiments | The Experiments library helps add A/B testing to your headless applications. |
@dotcms/analytics | The lightweight Analytics library assists in tracking content-aware events in dotCMS. |
dotCMS also provides example projects supporting further environments. These are not full libraries, but provide a starting point for building rich web applications in the following frameworks:
Additional rendering libraries are planned to extend support for further frameworks in future releases. It is also possible to build one's own custom library to support frameworks not yet listed here.
The dotCMS SDK is well-suited for use with the Universal Visual Editor, which allows in-context editing of remote websites or apps in dotCMS.