In-Preview-Editing Extension

This Blueprint extension enables in-preview editing in Studio.

The extension adds a new button to the preview toolbar that allows to toggle in-preview-editing mode. In this mode, the user can edit properties of the displayed content directly in the Studio preview. The changes are saved automatically and can be previewed in real-time. String properties are editable in place, while other properties are opened in a dialog.

Installation

• From the project's root folder, clone this repository as a submodule of the extensions folder.
• Make sure to use the branch name that matches your workspace version.

git submodule add https://github.com/coremedia-contributions/in-preview-editing modules/extensions/in-preview-editing

• Use the extension tool in the root folder of the project to link the modules to your workspace.

mvn -f workspace-configuration/extensions com.coremedia.maven:extensions-maven-plugin:LATEST:sync -Denable=in-preview-editing

How to enable In-Preview Editing

1. To enable in-preview editing, you need to add the InPreviewEditingStudioPlugin to your Studio plugin configuration. This can be done by following the installation steps above.
   • See In-Preview-Editing Studio Plugin for more details on how to register custom property editors for the editor overlay
2. As a second step, you need to add the in-preview-editing-support package to your frontend client. This package provides the necessary frontend functionality to support in-preview editing in Studio preview.
   • See In-Preview-Editing Support for more details on how to install and use this package.