Too many clicks to get to descriptions of fields (MGNLUI-2661)

[MGNLUI-2720] Show and hide all help texts at once, when clicking on the "?" icon in the dialog header Created: 28/Feb/14  Updated: 06/May/14  Resolved: 21/Apr/14

Status: Closed
Project: Magnolia UI
Component/s: forms
Affects Version/s: 5.0, 5.1, 5.2, 5.2.2
Fix Version/s: 5.2.4

Type: Sub-task Priority: Neutral
Reporter: Andreas Weder Assignee: Peili Liang
Resolution: Fixed Votes: 0
Labels: next, usability, ux
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
dependency
depends upon MGNLUI-2719 Show unobtrusive question mark next t... Closed
is depended upon by MGNLUI-2721 Show field descriptions and dialog he... Closed
relation
is related to MGNLUI-2811 Help texts are not displayed consiste... Closed
Template:
Date of First Response:

 Description   

As the title says, the dialog help text and all field descriptions in all tabs of a form should become visible, when the user clicks on the "?" icon in the header. Likewise, when she clicks again, all help goes away again.

The latter should also hold if only some field descriptions have been "manually" opened: if I open description of field A and D, then click on "?" in the header, the description of field A and D is closed first. Another click on the "?" in the header then opens all descriptions again.



 Comments   
Comment by Christoph Meier [ 15/Apr/14 ]

In agreement with Andreas, clicking of the "root-help-icon" (the one in the dialog-header) has the following effect:

  • if the root-help-text was hidden, the dialog displays all (available) help-texts of the fields and of the header.
  • if the root-help-text was shown, the dialog hides then all help-texts of the fields and of the header.
    These rules can be applied easy without holding the state of the fields somewhere.
    If more rules are required and if we must keep the state, we should keep the state on a vaadin-server-comp.
    Currently everything can be done just on client-widgets.
Comment by Christoph Meier [ 15/Apr/14 ]

commit: https://git.magnolia-cms.com/gitweb/?p=magnolia_ui.git;a=commit;h=df688ee7904e07716cc088a6769f0de80e162381

Comment by Milan Divilek [ 17/Apr/14 ]

Reopen:

if the root-help-text was shown, the dialog hides then all help-texts of the fields and of the header.

This doesn't work correctly. When "root-help-text" is shown and some of the fields have hidden description then click on "root-help-icon" leeds to hide "root-help-text" and all shown descriptions, but it shows descriptions which was hidden. For reproduce use "Asset" app - "Upload asset" action dialog

The latter should also hold if only some field descriptions have been "manually" opened: if I open description of field A and D, then click on "?" in the header, the description of field A and D is closed first. Another click on the "?" in the header then opens all descriptions again.

When "root-help-text" is not presented in dialog then behavior is also not correct. "If I open description of field A and D, then click on "?" in the header" then behavior depends on status of "?" in the header.
Let's have dialog with 3 fields A,B,C
1. if variable for "?" in the header = false and description of field A and B is open then click on "?" in the header leads to open descriptions for all fields
2. if variable for "?" in the header = true then we have same behavior as described in case when "root-help-text" is presented.

Comment by Peili Liang [ 18/Apr/14 ]

I have fixed the first issue: if the root-help-text was shown, the dialog hides then all help-texts of the fields and of the header.
About final function description of the ticket, please see: http://jira.magnolia-cms.com/browse/MGNLUI-2720?focusedCommentId=83385&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-83385

Comment by Milan Divilek [ 18/Apr/14 ]

About final function description of the ticket, please see: http://jira.magnolia-cms.com/browse/MGNLUI-2720?focusedCommentId=83385&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-83385

This "final function description" covers behavior only when dialog has "root-help-text". But if dialog does not have "root-help-text" then this rule should be applied

The latter should also hold if only some field descriptions have been "manually" opened: if I open description of field A and D, then click on "?" in the header, the description of field A and D is closed first. Another click on the "?" in the header then opens all descriptions again.

For example you can test this behavior in stkEventsOverview on this page http://localhost:8080/magnoliaAuthor/.magnolia/admincentral#app:pages:detail;/demo-project/news-and-events/events-overview:edit

Comment by Christoph Meier [ 22/Apr/14 ]

The ticket sit still not 100% following the pattern which was required.
But beside cases where there is more than one tab. it works fine, and for the release, we will close it now.
But there will be a follow-up ticket which has to take care again; See MGNLUI-2811.

Generated at Mon Feb 12 08:59:29 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.