[MGNLUI-6553] DOC: Default actions for detail subapps Created: 11/Feb/21  Updated: 09/Mar/21  Resolved: 09/Mar/21

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: 6.2.7
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Ashraf Khamis Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: actions, content-app, new-UI-framework
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
documentation
documents MGNLUI-6509 Item added via detail SubApp is not s... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Epic Link: UI framework implementation
Sprint: UI FW 23
Story Points: 2

 Description   

There is no need to define default actions for detail subapps:

subApps:
  detail:
#    actions:
#      commit:
#        $type: commitAction
#      cancel:
#        $type: closeAction
    form:
      properties: !override
        - name: jcrName

The default commit action is equivalent to the following configuration:

      commit:
        class: info.magnolia.ui.contentapp.detail.action.SaveDetailSubAppActionDefinition
        browserName: browser

This action saves and closes the detail subapp and selects the edited item in the browser (useful when creating new items). The default browser name is "browser".



 Comments   
Comment by Ashraf Khamis [ 09/Mar/21 ]

Added SaveDetailSubAppActionDefinition to https://docs.magnolia-cms.com/product-docs/Apps/App-configuration/Action-definition.html and a note about the default commit action configuration for detail subapps to https://docs.magnolia-cms.com/product-docs/Apps/App-configuration/Subapp-descriptor.html. Updated the example definition for the minimal detail subapp at https://docs.magnolia-cms.com/product-docs/Upgrading-to-Magnolia/Migrating-an-app-to-Magnolia-6-UI.html.

Reviewed by Roman.

Generated at Mon Feb 12 09:37:38 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.