Dev GuideAPI ReferenceUser Guide
HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideLegal TermsGitHubNuGetDev CommunitySubmit a ticketLog In
Legal TermsGitHubNuGetDev CommunitySubmit a ticket

On-page editing with client-side rendering

Describes how to make client-side rendering easier with on-page editing. Applies to Optimizely Content Management System (CMS) version 11.24.0 and higher.

Suggest Edits

Optimizely Content Management System (CMS) offers some features to make client-side rendering easier. These features are framework agnostic so that you can use them with any JavaScript framework, such as Angular, React, or Vue.

Edit HTML attributes

CMS UI provides the attribute data-epi-edit that you can add to editable DOM elements:

<span data-epi-edit="YourProperty">
  {your JS framework decides how the value is actually rendered}
</span>

Using data-epi-edit="YourProperty" is equivalent to adding three other HTML attributes as below:

<span data-epi-property-name="YourProperty" 
      data-epi-property-render="none" 
      data-epi-property-edittype="floating">
  {your JS framework decides how the value is actually rendered}
</span>
  • data-epi-property-name="YourProperty"
    This attribute marks an element for editing.
  • data-epi-property-render="none"
    This attribute prevents the DOM from being directly modified when editing. Using data-epi-property-edittype="inline" overrides this and will modify the DOM ("inline" is the default for string properties).
  • data-epi-property-edittype="floating"
    Use this attribute to create a dialog box for editing and string types.

Edit HTML attributes for blocks

Editable blocks rendered in a content area should have this HTML attribute on each block element:

  • data-epi-block-id="ContentLinkID"
    This attribute marks a block element for editing.

Re-rendering

To know when to re-render, subscribe to the topic contentSaved. The controller must contain the attribute [RequireClientResources] unless it inherits from PageController or ContentController, as these include the attribute by default. The resources then need to be required in a razor view with other scripts for the site using @Html.RequiredClientResources("Footer").

Handle context modes

To properly apply edit overlays and turn client-side routing on or off as needed, the client requires some indicator of the current context mode. For this purpose, Optimizely provides the following properties in the epi object :

  • inEditMode
    True in edit mode and preview mode
  • isEditable
    True in edit mode and false in preview mode
  • ready
    True if the property isEditable was initialized. Otherwise, subscribe to epiReady to get those properties when they are available

Navigate in on-page edit

There are two requirements to update the editing context (page tree, for this page folders, and so on) when navigating the site by clicking links in the preview iframe. You must hyperlink the links with an <a> tag and the href attribute must be an "edit mode" URL. Details are in the blog post Routing in an SPA with a working On-Page Editing experience by Nicklas Israelsson.

Content delivery API

CMS has released a content delivery API to simplify headless implementation. See Content Delivery API.

SPA template site

To demonstrate some useful concepts when creating a Single Page Application (SPA) while working on-page editing, see the MusicFestical SPA template site on Github. For descriptions of the template site, see the blog post Introducing a new SPA template site: MusicFestival.

Recommended blog series

  1. Introducing a new SPA template site: MusicFestival
  2. Routing in a SPA with a working On-Page Editing experience (CMS UI 11.11.0)
  3. Tips and tricks for a great On-Page Editing experience in SPAs and other client side rendered sites
  4. Represent the concept of "pages" and "blocks" with client-side components in a SPA

Blog posts

Updated 2 months ago