Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dialog definition #2054

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update dialog definition #2054

wants to merge 2 commits into from

Conversation

scottaohara
Copy link
Member

@scottaohara scottaohara commented Oct 2, 2023

Closes: #1195 adds content pertaining to aria-describedby/description and aria-modal (with linking to APG).

Closes: #1739 adds AT SHOULD to address the treatment of dialog descriptions. This could probably be worded better. Suggestions welcome.


Preview | Diff

Closes: #1195 adds content pertaining to aria-describedby/description and aria-modal (with linking to APG).

Closes: #1739 adds AT SHOULD to address the treatment of dialog descriptions. This could probably be worded better.  Suggestions welcome.
@jnurthen jnurthen changed the title Update dialog defnition Update dialog definition Oct 5, 2023
@jnurthen jnurthen self-requested a review October 5, 2023 17:25
@@ -3055,10 +3055,21 @@ <h2>Definition of Roles</h2>
<div class="role" id="dialog">
<rdef>dialog</rdef>
<div class="role-description">
<p>A dialog is a descendant window of the primary window of a web application. For HTML pages, the primary application window is the entire web document, i.e., the <code>body</code> element.</p>
<p>Dialogs are most often used to prompt the user to enter or respond to information. A dialog that is designed to interrupt workflow is usually modal. See related <rref>alertdialog</rref>.</p>
<p>A dialog is a descendant window of the primary window of a web application. For HTML pages, the primary application window is the entire web document, i.e., the content the user interacts with, within the <code>body</code> element.</p>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note for reviewers:
do we want to continue to say the body element here? it's not technically the 'entire web document' but is as far as the user likely cares about - which is what prompted my edit to this line. open to other suggestions of how this could be worded.

@mcking65
Copy link
Contributor

@scottaohara @jnurthen

I think we should have some discussion of the use cases and justification for aria-description on a dialog. I'm almost inclined to say that it should not be allowed. I think it deserves discussion though.

@mcking65
Copy link
Contributor

I agree with Carolyn's questioning of the wording around "managing focus". Managing focus is relevant for composites and does not equate to constraining the tab ring. I'm happy to propose some alternative wording.

@scottaohara How would you prefer I propose wording? It might be kind of difficult to do it with the suggestion feature? Are you OK with me pushing commits to this branch? Or, would you prefer I branch from this and use this branch as a base for a PR?

@scottaohara
Copy link
Member Author

@mcking65 yah, i think it does make sense to change the wording on 'managing focus'. happy for you to make commits to the branch. that'll be easy enough for me to review the diff.

@mcking65 just trying to get this PR wrapped up, but I added a note about aria-description and made a wording changes to 'manage focus' (though that is existing text, and not added by this PR - so kinda out of scope, but i think an easy change worth making.
@scottaohara
Copy link
Member Author

@mcking65 @jnurthen - i made updates based on matt's prior comments. pinging for review/re-review

@jnurthen
Copy link
Member

@mcking65 waiting for your review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants