[MGNLUI-29] Rename configuration property defining if a group is always open or not Created: 09/Oct/12  Updated: 03/Dec/13  Resolved: 03/Dec/13

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

Type: Improvement Priority: Neutral
Reporter: Andreas Weder Assignee: Mikaël Geljić
Resolution: Won't Fix Votes: 0
Labels: quickwin, ux
Remaining Estimate: Not Specified
Time Spent: Not Specified
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)
Date of First Response:

 Description   

The "App framework" section of the "How to build a Magnolia 5 app" in the draft of the Magnolia 5 book mentions a configuration option named "permanent", which defines whether a group in the upper section of the Apps screen and thus remains always open, or if it's not there and thus appears in the lower section and is closed by default.

I think that "permanent" is not such a good name for this property, since it introduces a term that is not used when we describe this feature.

I thus suggest we name that property:

  • "permanentlyOpen" or "remainsOpen" to emphasize that the group should be always opened (would be set to "false" if a user moves it down, but it actually makes a behavior of the UI, which may change, part of the name)
  • "isInUpperArea" to emphasize that a group is in the upper or lower section of the Apps screen (sounds a bit clumsy, but is less dependent on what it means to be in the upper area)
  • "isPreferredGroup" to emphasize the original intention in that a group you considered important should appears either in the upper section of the Apps screen (dito as above, but but better emphasis on semantics)

or similar. I'd probably go for option 3 with the suggested or a similar wording.

>>>>> PLEASE CHECK WITH PHILIPP wether we should change this now.



 Comments   
Comment by Mikaël Geljić [ 03/Dec/13 ]

may I suggest to use something more simple:

  • with same meaning: "expanded", or "alwaysExpanded"
  • with reversed meaning (independently of defaults): "closable", "collapsible"

all in all, we could also decide to keep the "permanent" wording since it's quite established now, and reflect it more in documentation.

Comment by Andreas Weder [ 03/Dec/13 ]

I'd still rather go with a semantic meaning such as "preferred". My thought is that we might want to rework (or what I rather anticipate: we might have to rework) the Apps screen sooner or later, e.g. in order for it to scale better with many apps. Once we do, having a more semantic name could help us as it could stay, why a term like "alwaysExpanded" could no longer apply to a differently looking Apps screen.

But I'd say, let's stick with "permanent" for now, for the reasons you stated, but also because it's impossible to anticipate what a reworked App screen would look and work like. We can rename things then. "Permanent" is not too wrong anyway - this issue really is a bit picky and dates from the time, when things were still being developed and in flux.

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