@dotcms/uve

dotCMS UVE SDK

The @dotcms/uve SDK adds live editing to your JavaScript app using the dotCMS Universal Visual Editor (UVE). It provides low-level tools that power our framework-specific SDKs, such as @dotcms/react and @dotcms/angular.

⚠️ We do not recommend using this SDK directly for most use cases, you should use a [framework SDK that handles setup](#Getting Started: Recommended Examples), rendering, and event wiring for you.

With @dotcms/uve, framework SDKs are able to:

• Make pages and contentlets editable
• Respond to editor events (content updates, mode changes)
• Trigger modal or inline editing experiences
• Sync app routing with the dotCMS editor

Table of Contents

• Before You Use @dotcms/uve
  • Getting Started: Recommended Examples
  • 🚩 Custom Setup: Manual Rendering (Not Recommended)
• Prerequisites & Setup
  • Get a dotCMS Environment
  • Create a dotCMS API Key
  • Installation
  • Using the SDK with TypeScript
• SDK Reference
  • initUVE()
  • getUVEState()
  • createUVESubscription()
  • editContentlet()
  • initInlineEditing()
  • enableBlockEditorInline()
  • updateNavigation()
  • reorderMenu()
  • sendMessageToUVE()
• Troubleshooting
  • Common Issues & Solutions
  • Debugging Tips
  • Still Having Issues?
• Support
• Contributing
• Licensing

Before You Use @dotcms/uve

Getting Started: Recommended Examples

We strongly recommend using one of our official framework SDKs, which are designed to handle UVE integration, routing, rendering, and more—out of the box. These examples are the best way to get started:

• dotCMS Angular SDK: Angular Example – Ideal for Angular apps 🅰️
• dotCMS React SDK: NextJS Example – Ideal for NextJS projects ⚛️
• dotCMS React SDK: Astro Example – Ideal for Astro projects 🌌

These examples handle UVE integration, routing, rendering, and more—out of the box. If you're building a headless dotCMS front-end, start there.

🚩 Custom Setup: Manual Rendering (Not Recommended)

💡 We recommend using one of our official framework SDKs, which are designed to handle UVE integration, routing, rendering, and more—out of the box.

You can use @dotcms/uve directly, but it’s not recommended or supported unless you’re building a highly custom integration. Here’s how the pieces fit together:

• You must use @dotcms/client to fetch content and page data.
• You must render pages based on dotCMS’s layout schema.
• You must apply the correct data-dot-* attributes to containers and contentlets.

Here's a minimal setup using @dotcms/client and @dotcms/uve:

• Initializa the Client and get the page response:

// getPage.ts
import { createDotCMSClient } from '@dotcms/client';
import { initUVE, createUVESubscription } from '@dotcms/uve';

const dotCMSClient = createDotCMSClient({
    dotcmsUrl: 'https://your-dotcms-instance.com',
    authToken: 'your-api-key',
    siteId: 'your-site-id'
});

const getPage = async () => {
    const pageResponse = await dotCMSClient.page.get('/', {
        languageId: '1'
    });

    return pageResponse;
};

• Initialize the UVE and subscribe to changes:

⚠️ The initUVE() function only works with a PageResponse returned by @dotcms/client. If you try to pass in data from another source or build your own structure, it won't initialize properly.

import { initUVE, createUVESubscription } from '@dotcms/uve';
import { getPage } from './getPage';

const pageResponse = await getPage();

initUVE(pageResponse);
createUVESubscription('changes', (newPageResponse) => {
    // Handle page updates (e.g. re-render)
});

⚠️ This only sets up the editor connection. You are responsible for rendering the page structure (rows, columns, containers, contentlets) using your own UI components.

• Create a custom render for the page:

// 🔧 Render the page layout (you must implement this component)
<MyDotCMSPage pageAsset={pageResponse.pageAsset} />

⚠️ Below is a simplified breakdown of how dotCMS layouts are structured and how you might render them manually.

🔄 How to Render a dotCMS Page

📚 For a complete guide, here is a full tutorial: 👉 dotCMS Page Rendering Architecture

dotCMS pages are structured as nested layout objects:

• A PageAsset contains a layout object
• The layout includes rows, columns, containers, and contentlets

Here’s a basic pseudocode outline:

<Page>
  {layout.body.rows.map(row => (
    <Row>
      {row.columns.map(column => (
        <Column>
          {column.containers.map(container => (
            <Container data-dot-object="container" ...>
              {container.contentlets.map(contentlet => (
                <Contentlet data-dot-object="contentlet" ...>
                  {renderContentletByType(contentlet)}
                </Contentlet>
              ))}
            </Container>
          ))}
        </Column>
      ))}
    </Row>
  ))}
</Page>

Each contentlet is rendered according to its content type:

function renderContentletByType(contentlet) {
  switch(contentlet.contentType) {
    case 'text': return <TextBlock contentlet={contentlet} />;
    case 'image': return <ImageBlock contentlet={contentlet} />;
    case 'video': return <VideoBlock contentlet={contentlet} />;
    default: return null;
  }
}

To make the layout editable, be sure to apply all required data-dot-* attributes on containers and contentlets.

Prerequisites & Setup

Get a dotCMS Environment

Version Compatibility

• Recommended: dotCMS Evergreen
• Minimum: dotCMS v25.05
• Best Experience: Latest Evergreen release

Environment Setup

For Production Use:

• ☁️ Cloud hosting options - managed solutions with SLA
• 🛠️ Self-hosted options - deploy on your infrastructure

For Testing & Development:

• 🧑🏻‍💻 dotCMS demo site - perfect for trying out the SDK
• 📘 Learn how to use the demo site
• 📝 Read-only access, ideal for building proof-of-concepts

For Local Development:

• 🐳 Docker setup guide
• 💻 Local installation guide

Configure The Universal Visual Editor App

For a step-by-step guide on setting up the Universal Visual Editor, check out our easy-to-follow instructions and get started in no time!

Installation

npm install @dotcms/uve@latest

Using the SDK with TypeScript

All interfaces and types are available through the @dotcms/types package:

npm install @dotcms/types@latest --save-dev

Common Types

The SDK uses several key types from @dotcms/types:

import {
    DotCMSContentlet,
    DotCMSPageResponse,
    DotCMSUVEConfig,
    DotCMSInlineEditingType,
    UVEEventType,
    UVEState
} from '@dotcms/types';

For a complete reference of all available types and interfaces, please refer to the @dotcms/types documentation.

SDK Reference

initUVE(config?: DotCMSUVEConfig)

initUVE is a function that initializes the Universal Visual Editor (UVE). It sets up the necessary communication between your app and the editor, enabling seamless integration and interaction.

Input	Type	Required	Description
config	DotCMSPageResponse	✅	The page Response from the @dotcms/client

Usage

const { destroyUVESubscriptions } = initUVE(pageResponse);

⚠️ If you don't provide a pageResponse, we can't assure that the UVE will be initialized correctly.

getUVEState()

getUVEState is a function that returns the UVE state if UVE is active.

Usage

import { getUVEState } from '@dotcms/uve';
import { UVE_MODE } from '@dotcms/types';

const myEditButton = () => {
    const uveState = getUVEState();

    if (uveState?.mode === UVE_MODE.EDIT) {
        return <button>Edit</button>;
    }

    return null;
};

UVE State

• dotCMSHost: The host URL of the DotCMS instance
• experimentId: The ID of the current experiment
• languageId: The language ID of the current page set on the UVE
• mode: The current editor mode ('preview', 'edit', 'live')
• persona: The persona of the current page set on the UVE
• publishDate: The publish date of the current page set on the UVE
• variantName: The name of the current variant

createUVESubscription(eventType, callback)

createUVESubscription is a function that allows your application to dynamically interact with UVE by subscribing to events such as content changes or navigation updates. This enables your app to respond in real-time to user actions and editor events, enhancing the interactive experience.

Input	Type	Required	Description
eventType	UVEEventType	✅	The event to subscribe to
callback	Function	✅	Called when the event is triggered

Usage

import { createUVESubscription } from '@dotcms/uve';
import { UVEEventType } from '@dotcms/types';

const sub = createUVESubscription(UVEEventType.CONTENT_CHANGES, (newPageResponse) => {
    // do something when the content changes
});

// Later, when you want to unsubscribe
sub.unsubscribe();

Event Types

• UVEEventType.CONTENT_CHANGES: Triggered when the content of the page changes.
• UVEEventType.PAGE_RELOAD: Triggered when the page is reloaded.
• UVEEventType.REQUEST_BOUNDS: Triggered when the editor requests the bounds of the page.
• UVEEventType.IFRAME_SCROLL: Triggered when the iframe is scrolled.
• UVEEventType.IFRAME_SCROLL_END: Triggered when the iframe has stopped scrolling.
• UVEEventType.CONTENTLET_HOVERED: Triggered when a contentlet is hovered.

editContentlet(contentlet)

editContentlet is a function that opens the dotCMS modal editor for any contentlet in or out of page area.

Input	Type	Required	Description
contentlet	Contentlet<T>	✅	The contentlet you want to edit.

Usage

import { editContentlet, getUVEState } from '@dotcms/uve';
import { UVE_MODE } from '@dotcms/types';

const myEditButton = ({ contentlet }) => {
    const uveState = getUVEState();

    if (uveState?.mode === UVE_MODE.EDIT) {
        return <button onClick={() => editContentlet(contentlet)}>Edit</button>;
    }

    return null;
};

initInlineEditing(type, data)

initInlineEditing is a function that triggers inline editing for supported field types (WYSIWYG or Block Editor).

Input	Type	Required	Description
type	DotCMSInlineEditingType	✅	'BLOCK_EDITOR' or 'WYSIWYG'
fieldData	DotCMSInlineEditingPayload	✅	Field content required to enable inline editing

Usage

import { initInlineEditing, getUVEState } from "@dotcms/uve";
import { UVE_MODE } from "@dotcms/types";

const MyBanner = ({ contentlet }) => {
  const uveState = getUVEState();

  const handleClick = () => {
    if (uveState?.mode === UVE_MODE.EDIT) {
      const { inode, contentType, title } = contentlet;
      initInlineEditing("BLOCK_EDITOR", {
        inode,
        contentType,
        content: title,
        fieldName: "title",
      });
    }
  };
  return (
    <div>
      <h1 onClick={handleClick}>{contentlet.title}</h1>
      <p>{contentlet.description}</p>
    </div>
  );
};

DotCMSInlineEditingPayload

• inode (string): The inode of the contentlet to edit.
• contentType (string): The content type of the contentlet to edit.
• fieldName (string): The name of the field to edit.
• content (string): The content of the field to edit.

enableBlockEditorInline(contentlet, fieldName)

enableBlockEditorInline is a shortcut to enable inline block editing for a field.

Input	Type	Required	Description
contentlet	DotCMSBasicContentlet	✅	The target contentlet
fieldName	string	✅	Name of the block field to edit

Usage

import { enableBlockEditorInline, getUVEState } from '@dotcms/uve';
import { UVE_MODE } from '@dotcms/types';

const MyBanner = ({ contentlet }) => {
    const uveState = getUVEState();

    const handleClick = () => {
        if (uveState?.mode === UVE_MODE.EDIT) {
            enableBlockEditorInline(contentlet, 'blockContent');
        }
    };

    return <MyBlockEditorRender onClick={handleClick} />;
};

updateNavigation(pathname)

updateNavigation is a function that notifies UVE that navigation has changed (e.g., in SPAs).

Input	Type	Required	Description
pathname	string	✅	The new pathname to update

Usage

import { updateNavigation } from '@dotcms/uve';

updateNavigation('/navigate-to-this-new-page');

reorderMenu(config?)

reorderMenu is a function that opens the UVE menu editor to reorder navigation links.

Input	Type	Required	Description
config?	DotCMSReorderMenuConfig	❌	Optional config for reordering

Usage

import { reorderMenu } from '@dotcms/uve';

reorderMenu({ startLevel: 2, depth: 3 });

DotCMSReorderMenuConfig

• startLevel (number): The level to start reordering from
• depth (number): The depth of the menu to reorder

sendMessageToUVE(message)

sendMessageToUVE is a low-level function to send custom messages to UVE.

Input	Type	Required	Description
message	DotCMSUVEMessage<T>	✅	Object with action + payload

Usage

sendMessageToUVE({
  action: DotCMSUVEAction.CUSTOM_EVENT,
  payload: { type: 'MyEvent', data: {...} }
});

DotCMSUVEMessage

| Event (DotCMSUVEAction) | Payload (T) | | ---------------------------------- | ------------------------------------------------------------- | ------- | | NAVIGATION_UPDATE | { url: string } | | SET_BOUNDS | DotCMSContainerBound[] | | SET_CONTENTLET | DotCMSBasicContentlet | | IFRAME_SCROLL | 'up' | 'down' | | IFRAME_SCROLL_END | --- | | REORDER_MENU | DotCMSReorderMenuConfig | | INIT_INLINE_EDITING | DotCMSInlineEditingPayload | | COPY_CONTENTLET_INLINE_EDITING | { dataset: { inode, language, fieldName: this.fieldName } } | | UPDATE_CONTENTLET_INLINE_EDITING | { content: string, dataset: { inode, langId, fieldName } } | | GET_PAGE_DATA | --- | | CLIENT_READY | --- | | EDIT_CONTENTLET | DotCMSBasicContentlet |

Troubleshooting

Common Issues & Solutions

Memory Management

• Memory Leaks: Application experiences memory leaks
  • Possible Causes:
    • Failing to call destroyUVESubscriptions() on unmount
  • Solutions:
    • Always call destroyUVESubscriptions() when your component unmounts to clean up subscriptions

Editor State

• Undefined State: getUVEState() returns undefined
  • Possible Causes:
    • Application not running inside the dotCMS editor
  • Solutions:
    • Ensure your application is running within the dotCMS environment when calling getUVEState()

Event Handling

• Unsubscribed Events: Events not unsubscribed leading to unexpected behavior
  • Possible Causes:
    • Not unsubscribing from events
  • Solutions:
    • Always unsubscribe from events using the unsubscribe() method to prevent memory leaks

Inline Editing

• Invalid Contentlet or Field: initInlineEditing() requires valid contentlet and field name
  • Possible Causes:
    • Incorrect contentlet or field name
  • Solutions:
    • Verify that the contentlet and field name are correct and exist in the dotCMS instance

Non-existent Page Navigation

• Navigation to a non-existent page: May break content sync in UVE and make the editor redirect to the home page
  • Possible Causes:
    • Navigation to a non-existent page
  • Solutions:
    • Ensure the page exists in the dotCMS instance

Menu Reordering

• UI Action Requirement: reorderMenu() must be called from a UI action
  • Possible Causes:
    • Attempting to auto-trigger reorderMenu()
  • Solutions:
    • Ensure reorderMenu() is triggered by a user action within the UI

Debugging Tips

• Ensure you are in the UVE Context
  • Check if you are in the UVE context by calling getUVEState()
  • If you are not in the UVE context, you will not be able to use the UVE SDK correctly
• Check Browser Console
  • Check for errors in the browser console
  • Check for errors in the browser network tab
• Network Monitoring
  • Use browser dev tools to monitor API calls
  • Check for 401/403 errors (auth issues)
  • Verify asset loading paths

Still Having Issues?

If you're still experiencing problems after trying these solutions:

• Search existing GitHub issues
• Check our community forum
• Create a new issue with:
  • Detailed reproduction steps
  • Environment information
  • Error messages
  • Code samples

Support

We offer multiple channels to get help with the dotCMS UVE SDK:

• GitHub Issues: For bug reports and feature requests, please open an issue in the GitHub repository
• Community Forum: Join our community discussions to ask questions and share solutions
• Stack Overflow: Use the tag dotcms-uve when posting questions
• Enterprise Support: Enterprise customers can access premium support through the dotCMS Support Portal

When reporting issues, please include:

• SDK version you're using
• dotCMS version
• Minimal reproduction steps
• Expected vs. actual behavior

Contributing

GitHub pull requests are the preferred method to contribute code to dotCMS. We welcome contributions to the dotCMS UVE SDK! If you'd like to contribute, please follow these steps:

• Fork the repository dotCMS/core
• Create a feature branch (git checkout -b feature/amazing-feature)
• Commit your changes (git commit -m 'Add some amazing feature')
• Push to the branch (git push origin feature/amazing-feature)
• Open a Pull Request

Please ensure your code follows the existing style and includes appropriate tests.

Licensing

dotCMS comes in multiple editions and as such is dual-licensed. The dotCMS Community Edition is licensed under the GPL 3.0 and is freely available for download, customization, and deployment for use within organizations of all stripes. dotCMS Enterprise Editions (EE) adds several enterprise features and is available via a supported, indemnified commercial license from dotCMS. For the differences between the editions, see the feature page.

This SDK is part of dotCMS's dual-licensed platform (GPL 3.0 for Community, commercial license for Enterprise).

Learn more at dotcms.com.