Uploaded image for project: 'Magnolia REST Framework'
  1. Magnolia REST Framework
  2. MGNLREST-211

Produce page-editor-hints

    XMLWordPrintable

Details

    • Story
    • Resolution: Obsolete
    • Neutral
    • None
    • None
    • None
    • None
    • Yes
    • Yes
    • SPA Editor 7, SPA Editor 8, SPA Editor 9
    • 5

    Description

      User story:
      As a frontend developer, I want to get page-editor-hints (html comments) from Magnolia, so that I can render them in my React app so that the page editor will create the green edit bars with the correct behaviour.

      Notes:
      Creating the editor hints in the code of a SPA is difficult, and could result in bugs if Magnolia changes the format of them in a future version. For example, activationStatus is calculated. If developers can get the editor-hints via a official supported API it will make SPA integrations easier and less error-prone.
      Requested from Argos and Car Glass.

      Acceptance criteria:

      • REST API to get page-editor-hints for a page (and its area and components), or for an entire subtree of the website workspace.
      • API could deliver either complete HTML comment, or a JSON map of its properties.

      Suggestion:
      It could be convenient to add this as a feature to the existing Delivery API, so that each returned area and component would have a subnode with the page-editor-hint.

      Example page-editor-comment for an area:

      <!-- cms:area 
      content="website:/travel/about" 
      name="navigation" 
      availableComponents="" 
      type="noComponent" 
      label="Navigation" 
      inherit="false" 
      optional="false" 
      created="false" 
      createdAreaNode="false" 
      showAddButton="false" 
      showNewComponentArea="false" 
      activationStatus="2" 
      -->
      

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                rsiska Robert Šiška
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD