[MGNLFE-1] JS library to create page-editor hints Created: 22/Oct/19  Updated: 27/Apr/20  Resolved: 18/Nov/19

Status: Closed
Project: Magnolia Frontend Helpers
Component/s: Template Annotations
Affects Version/s: None
Fix Version/s: 1.0.0

Type: Story Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Canh Nguyen
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 9d 6.5h
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Release notes required:
Yes
Documentation update required:
Yes
Date of First Response:
Epic Link: SPA Editor
Sprint: SPA Editor 9, SPA Editor 10
Story Points: 5

 Description   

Create a javascript library which creates the string of the HTML comment that the page-editor analyzes in order to create the component and area "green bars".

 

Acceptance criteria:

  • It gets the information it needs from the new Magnolia REST endpoint. Developer should be in control of when the request is made.
  • Given a component it returns the string of the html comment.
  • It has minimal or no external dependencies. (ie js 'fetch' is preferred to 'axios', or make the case why to use an external dependency.)

 

Context:

Some functionality will be shared by all SPA client libraries, regardless of which frontend framework they leverage. This functionality should be consolidated in one library - which will eventually (most likely) be published as its own npm package. 

In this ticket we start the basis for this library, it may contain additional functionality in the future.


Generated at Mon Feb 12 05:43:15 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.