Uploaded image for project: 'Magnolia pages module'
  1. Magnolia pages module
  2. PAGES-174

Client-side API to request green Editbar creation

    XMLWordPrintable

Details

    • Story
    • Resolution: Fixed
    • Major
    • 6.2
    • 5.7.1
    • None
    • None
    • Yes
    • Yes
    • SPA Editor 3, SPA Editor 4, SPA Editor 7, SPA Editor 8
    • 8

    Description

      User story:

      As a SPA developer, I can signal the page editor to run its green editbar creation, so that I can create a SPA that can be edited in the Page editor.

      Technical notes:

      • 7. Hooks for page init/update bar production
      • via JSNI, update handler upon state/routing, etc.?
        • see info.magnolia.ui.vaadin.gwt.client.editor.jsni.AbstractFrameEventHandler#reloadIFrame for an example
      • see package info.magnolia.ui.vaadin.gwt.client.editor.dom.processor
      • consider alternatives to model component bar input (e.g. data attributes instead of page comments)

      Currently the page editor automatically runs the editbar creation code as soon as the page loads, however a SPA might not have loaded yet which means that editbars will not be properly created. Furthermore a SPA might dynamically change its DOM revealing new editing components, but they cannot be edited because there is no editbars created for them.

      Acceptance criteria:

      • SPA developer can run a function or hit an endpoint to run the green editbar creation whenever it wants.
      • A re-run of the editbar creation will function properly (maybe removing any previously created editbars first.)
      • Validate two hooks:
        • explicitly plugging the bar-creation handler upon SPA init
        • provide a test SPA that has an area with one component and a "+" button (duplicating the other component), when duplicating, a state change or navigation should call the bar-creation handler

      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

                    Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Remaining Estimate - 0d
                      0d
                      Logged:
                      Time Spent - 1d 6h 43m
                      1d 6h 43m