[PAGES-1162] DOC: Component autogeneration and inheritance for SPA rendering Created: 16/May/23  Updated: 23/Oct/23  Resolved: 25/May/23

Status: Closed
Project: Magnolia pages module
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Oanh Thai Hoang Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Attachments: PNG File response-child.png    
Issue Links:
Relates
relates to PAGES-1128 Component Autogeneration should work ... Closed
relates to PAGES-1153 Component Inheritance with Visual SPA... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
PAGES-1180 DOCSub: Component autogeneration and ... Sub-task Completed Martin Drápela  
PAGES-1181 DOCSub: Component autogeneration and ... Sub-task Closed Oanh Thai Hoang  
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Epic Link: SPA Maintenance
Sprint: DevX 38
Story Points: 2
Team: DeveloperX
Work Started:
Approved:
Yes

 Description   

Description

This is sample of rest endpoint:

$type: jcrPagesDeliveryEndpoint_v2

 

This is sample of template for autogeneration component: https://git.magnolia-cms.com/projects/DEMOS/repos/minimal-headless-spa-demos/pull-requests/34/diff#magnolia/light-modules/react-minimal-lm/templates/pages/basic-autogeneration.yaml

This is sample of template for inheritance component: https://git.magnolia-cms.com/projects/DEMOS/repos/minimal-headless-spa-demos/pull-requests/34/diff#magnolia/light-modules/react-minimal-lm/templates/pages/contact-inheritance.yaml

 

Require to run "@magnolia/react-editor": "1.3.1" at least for component inheritance feature. Due to a fix bug of https://jira.magnolia-cms.com/browse/MGNLFE-333

Note:

  • component autogeneration currently just support for #read_node and #get_children API only
    • Create a real component node in JCR when open editing page or call rest API directly
  • component inheritance currently just support for #read_node only.
    • Does not create real inheritance component node in JCR. So only when calling rest API or open editing page, user can see inheritance component nodes
    • Sample json response: . Name of inheritance component will be decorated. Like above img. Real name is "headline". But in json response, our rest endpoint will generate a unique name for inheritance component. User can use @path or @id to access the real node

 


Generated at Mon Feb 12 06:25:41 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.