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