Skip to content

Add Description List as a feature #1383

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

Closed
wants to merge 3 commits into from
Closed

Add Description List as a feature #1383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a01b80
edit name and description
kosamari Jul 11, 2024
34c590a
move out of draft dir, rename the yml file
kosamari Jul 11, 2024
30534c5
add renamed yaml and dist files
kosamari Jul 11, 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
5 changes: 2 additions & 3 deletions features/draft/html-elements/dd.yml → features/description-list.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
draft_date: 2024-06-05
name: <dd>
description: The `<dd>` element TODO.
name: Description list
description: Elements to represent a description list.
Copy link
Contributor

@captainbrosset captainbrosset Jul 12, 2024

Choose a reason for hiding this comment

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

Suggested change
description: Elements to represent a description list.
description: The `<dl>`, `<dt>`, and `<dd>` elements create a list of terms and their associated descriptions. Use a description list to to create glossaries or other similar key-value pair lists.

Just a suggestion to make it more straightforward to understand. Not completely set on it though.

One more thing to consider: accessibility doesn't seem to be the best with DL. See https://adrianroselli.com/2022/12/brief-note-on-description-list-support.html and https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl#accessibility
In particular, it looks like keyboard navigation isn't supported everywhere.

Baseline currently doesn't cover assistive tech (see https://github.com/web-platform-dx/web-features/blob/main/docs/baseline.md#non-goals) so this is probably fine as is, but it might be good to do a bit of research for a11y best practices with DL and add a short mention of this in the description.

spec:
- https://html.spec.whatwg.org/multipage/grouping-content.html#the-dd-element
- https://html.spec.whatwg.org/multipage/grouping-content.html#the-dl-element
Expand Down
2 changes: 1 addition & 1 deletion features/draft/html-elements/dd.yml.dist → features/description-list.yml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Generated from: dd.yml
# Generated from: description-list.yml
# Do not edit this file by hand. Edit the source file instead!

status:
Expand Down