[MGNLUI-5215] DOC: Dialogs have 'commit' and 'cancel' actions by default Created: 29/May/19  Updated: 02/Sep/19  Resolved: 26/Aug/19

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

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

Issue Links:
documentation
documents MGNLUI-4058 Dialogs have Cancel and Save actions ... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: UI Framework 4
Story Points: 5

 Description   

User stories

If a template dialog does not supply an actions node in its definition, then the commit and cancel actions should be provided by default. If a dialog does supply an actions node, then only the actions specified should be provided.

Rationale: These same actions are used in most dialogs. It is extra effort for developers to always supply them in dialogs, it is something that they can make mistakes with, and it feels like 'boilerplate' that must always be added. Evaluators will have a better impression if these same actions are not specified in every dialog definition.

This part of the definition should be optional:

actions:
  commit:
    class: info.magnolia.ui.admincentral.dialog.action.SaveDialogActionDefinition
  cancel:
    class: info.magnolia.ui.admincentral.dialog.action.CancelDialogActionDefinition

A dev should not have to supply a specific class; this should work with the existing Dialog class.

Task

Create a new Dialog definition page for Magnolia 6 UI to reflect the recent changes. The old Dialog definition page for Magnolia 5 UI should serve as an inspiration for the new pages.



 Comments   
Comment by Ashraf Khamis [ 26/Aug/19 ]

Page created at https://documentation.magnolia-cms.com/display/DOCS61/Dialog+definition+-+6+UI. Includes both Dialog definition and Dialog action definition for Magnolia 6 UI.

Reviewed by Sasha and Roman.

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