Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
HTML Wrap
alignright
classmenu

Related topics:

Magnolia front-end helpers are collections is a collection of JavaScript libraries that enable easy integration of single-page applications in the Magnolia Pages app. 

Currently, Magnolia provides the following helper libraries:

  • Angular renderer.editor
  • React renderer.editor
  • Magnolia Template Annotations.

The annotations make content from a front-end project editable in Magnolia. This is achieved by injecting annotations (HTML comments) around

...

components which the Magnolia Page

...

editor transforms into controls for web content editors.

Table of Contents

Installing and usage

You can add the libraries to your SPA JavaScript project either by installing them using the npm install command,

Mgnl mini code snippet
Styleboxed

npm install --save @magnolia/template-annotations

or by including them as project dependencies.The helpers  The libraries have the following npm package names:

For more information on how to install and use these helper libraries, click see the following linksREADME files available in our frontend-helpers repository:

...

Example SPA projects built with front-end helpers

...

You don't need to include these helpers manually if you would like to try out our example Angular and React SPA demo pages:

...

To see how these libraries can be used, check out our example projects. The projects already include the required dependencies to the helper libraries.