[popup] What are the precedence rules for togglepopup, showpopup, and hidepopup

[mfreed7]

See #508 for context, but the popup now supports three content attributes:

• togglepopup=popup_id: If popup_id refers to a showing popup, hide it. If popup_id refers to a hidden popup, show it.
• showpopup=popup_id: If popup_id refers to a hidden popup, show it.
• hidepopup=popup_id: If popup_id refers to a showing popup, hide it.

The question becomes: what happens when one element has more than one of these attributes set? What if they point to different idrefs?

[mfreed7]

Posted by @jh3y:

• I like the idea of "toggle", "show", and "hide". For precedence, "show" or "hide" trump "toggle" IMO as they are more specific about what they are doing. If all three exist, it's a toggle. If "show" and "hide" exist, it's a non-issue too? Only issue is with varying IDs 🤔 If a button opens one and closes another, where does a11y come into that? Does it?

[mfreed7]

I'd like to propose this as a behavior:

When an activating element (e.g. <button>) is activated:

1. Let popup_idref be null, and let popup_action be empty.
2. If the togglepopup attribute is present on the element:
   1. Let popup_idref be the value of the togglepopup property.
   2. Let popup_action be "toggle".
3. If popup_action is empty, and the showpopup attribute is present on the element:
   1. Let popup_idref be the value of the showpopup property.
   2. Let popup_action be "show".
4. If popup_action is empty or "show", and the hidepopup attribute is present on the element:
   1. If popup_idref is null, set it to the value of the hidepopup property.
   2. If the value of the hidepopup property is not equal to popup_idref, continue.
   3. If popup_action is "show", set popup_action to "toggle". Otherwise, set it to "hide".
5. If popup_action is empty, stop this algorithm.
6. Let popup_target be the result of running getElementById() on popup_idref.
7. If popup_target does not exist, or does not have a popup attribute with a valid value, end this algorithm.
8. If popup_target is in the "showing" state, and popup_action is "toggle" or "hide", then call popup_target.hidePopup() and end this algorithm.
9. If popup_target is in the "hidden" state, and popup_action is "toggle" or "show", then call popup_target.showPopup() and end this algorithm.

And that should:

1. Make togglepopup trump the other two.
2. Make showpopup "win" in terms of idrefs, in case it differs with hidepopup.
3. If both showpopup and hidepopup are present, they need to point to the same idref, and then you'll get togglepopup behavior.
4. There's only ever one popup_target.

Thoughts? Bugs in the algorithm?

[css-meeting-bot]

The Open UI Community Group just discussed [popup] Add ::backdrop to popup to enable modal popup #519, and agreed to the following:

• RESOLVED: We accept the precedence rules from https://github.com/openui/open-ui/issues/523#issuecomment-1106686358.

The full IRC log of that discussion

<hdv> Topic: [popup] Add ::backdrop to popup to enable modal popup #519
<hdv> github: https://github.com/openui/open-ui/blob/main/meetings/telecon/2022-04-21.md
<hdv> github: https://github.com//issues/523
<jh3y> wrt #519: +1 Good to match expectation from <dialog> usage
<hdv> masonf: the idea of togglepopup is that the idref you put on a button that it toggles that, but it needs a rule for what happens when there are multiple attributes
<hdv> masonf: what we need to resolve on is what happens exactly so that developers know what to expect
<flackr> q+
<JonathanNeal> q?
<hdv> masonf: I proposed some rules on the thread, summary: if you provide togglepopup, it wins, it ignores showpopup and hidepopup. If you use showpopup and hidepopup, with different ids, showpopup wins, if they have the same idref, it behaves like togglepopup
<hdv> flackr:
<hdv> flackr: I agree high level… in the proposed algorithm, if you show ID1 and hide ID2, you get toggle behavior?
<hdv> masonf: should be show behavior?
<hdv> flackr: ok I agree, if the IDs don't match we should not modify the behavior
<JonathanNeal> q?
<JonathanNeal> ack flackr
<hdv> masonf: let's try today to discuss just what we want, then we'll fix the algorithm later
<miriam> +1 I like the intended behavior
<hdv> JonathanNeal: is there agreement on the intended behavior and the idea for this to be resolved ?
<una> SGTM
<JonathanNeal> +1
<Alexander_Futekov> +1
<hdv> flackr: I think the algorithm is correct actually
<flackr> +1
<masonf> Proposed resolution: We accept the precedence rules from https://github.com//issues/523#issuecomment-1106686358.
<JonathanNeal> +1
<masonf> RESOLVED: We accept the precedence rules from https://github.com//issues/523#issuecomment-1106686358.
<hdv> masonf: if you find a bug in the algorithm please tell me

[mfreed7]

Based on the resolution, I'm going to close this issue. If you find issues/bugs in the proposed algorithm, please report them as a new issue.