John-Philip Johansson
Optimizely
Jan 29, 2019
visibility 9078
star star star star star star
(6 votes)

One OPE attribute to rule them all: data-epi-edit (CMS UI 11.16.0)

In CMS UI 11.16.0, we're making it easier for everyone doing client-side rendered websites to mark up their HTML.

Before 11.16.0

In a previous post, I explained how to make an element editable in On-Page Edit when rendered by a client-side framework (e.g. React, Angular, Vue, etc). It was necessary to add three attributes:

<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>

This is slightly verbose. Although you could wrap it in some helper method in your JavaScript framework of choice (like we did in the MusicFestival sample site), it would require less "magic" or less reading of our documentation if there was only one attribute for frontend developers to remember. That's why we're introducing data-epi-edit. It does not have any specific behavior to learn about. It's equivalent to setting the properties above, and setting any of those properties as well will simply be ignored.

With 11.16.0

It's now enough with one simple attribute:

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

One note

We recommend that you don't render any data-epi-* attributes in View mode, as to not give too many details about the internal workings of your site. That's what @Html.PropertyFor() and @Html.EditAttributes() do when using Razor views. When taking over the rendering on the client-side, this responsibility moves over as well. One way is to use the global epi.beta.isEditable property (CMS UI 11.11.0, see blog or documentation) to toggle the rendering off and on, as we've done in MusicFestival (see here and here).

Learn more

Documentation: https://world.episerver.com/documentation/developer-guides/CMS/editing/on-page-editing-with-client-side-rendering/

MusicFestival has been updated to use this in the Vue directive v-epi-edit: https://github.com/episerver/musicfestival-vue-template/blob/129be15ae4a/src/MusicFestival.Vue.Template/Assets/Scripts/directives/epiEdit.js

Jan 29, 2019

Comments

Valina Eckley
Valina Eckley Jan 29, 2019 07:59 PM

Nice!  Great work JP!

Jake Jones
Jake Jones Mar 6, 2019 04:16 PM

Finally had a chance to check this out and it worked flawlessly. Nice job!

error Please login to comment.
Latest blogs
A note on using async computed fields with Optimizely Graph

Computed fields can be async, but do they work smoothly with the Graph C# SDK?

Johan Kronberg | Nov 9, 2026 |

Visual Builder without Next.js, Part 2: The Routing Decision Travels, the Engine Contract Doubles

One content tree, two engines, one edge: a strangler for Astro and Next.js on CMS 13. The same routing decision in a Next.js proxy and in a...

Piotr | Nov 8, 2026 |

Stride on SaaS CMS and Frontend Hosting, with Claude Code

This post shows how I set up the Optimizely Stride sample site on a new Optimizely CMS (SaaS) instance. The front end is on Optimizely Frontend...

Minesh Shah (Netcel) | Nov 7, 2026

What changed in Optimizely LanguageManager 5.5.4

LanguageManager 5.5.4 for Optimizely CMS 12 has no public release notes. I compared it to 5.5.3 and found no new features, but an axios upgrade tha...

Tomas Hensrud Gulla | Nov 7, 2026 |