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.

Sign up for GitHub

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

Add authoring should referring to tradeoffs for authors of exclusive accordions. #10003

Merged
merged 2 commits into from
Jan 10, 2024
Merged

Add authoring should referring to tradeoffs for authors of exclusive accordions. #10003

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb4dbeb
Add note about tradeoffs for authors of exclusive accordions.
dbaron Dec 18, 2023
ce6684f
Make change normative rather than a note.
dbaron Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions source
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60180,6 +60180,12 @@ interface <dfn interface>HTMLDetailsElement</dfn> : <span>HTMLElement</span> {
a member of. Opening one member of this group causes other members of the group to close. If the
attribute is specified, its value must not be the empty string.</p>

<p>Before using this feature, authors should consider whether this grouping of related
Copy link
Member

Choose a reason for hiding this comment

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

This needs to either be an authoritative "should" in a non-note, or it needs to be rephrased as not using the magic "should" keyword. I'm unsure which you are going for, but disabling the linter is not the right way to go.

Copy link
Member Author

Choose a reason for hiding this comment

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

OK, I've revised it to be a normative author-facing should. (That wasn't what I was initially planning, but I guess the fact that I really do want to use the word "should" suggests that that's probably what I meant.)

<code>details</code> elements into an exclusive accordion is helpful or harmful to to users.
While using an exclusive accordion can reduce the maximum amount of space that a set of content
can occupy, it can also frustrate users who have to open many items to find what they want or
users who want to look at the contents of multiple items at the same time.</p>

<p>A document must not contain more than one <code>details</code> element in the same
<span>details name group</span> that has the <code data-x="attr-details-open">open</code>
attribute present. Authors must not use script to add <code>details</code> elements to a document
Expand Down