search

canonical / maas-ui

The UI for MAAS (metal-as-a-service)
https://maas.io
Other
50 stars 49 forks source link

Update Definition component with description list tags #3751

Open Caleb-Ellis opened 2 years ago

Caleb-Ellis commented 2 years ago

I wonder whether we should use a Definition Term element in the underlying Definition component. I decided against it when I was working on the Definition component as a Definition Term has to be a part of a Description List and it felt like an overkill in a lot of cases where we use it for just a single item.

But in this case it would make for better semantics (and a11y). It looks like a classic example for when Definition List could be used? I wonder what are your thoughts on this.

Description lists are useful for displaying metadata as a list of key-value pairs. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl#metadata

_Originally posted by @petermakowski in https://github.com/canonical-web-and-design/maas-ui/pull/3748#discussion_r840297756_

petermakowski commented 2 years ago

Currently Orca doesn't even support description lists https://gitlab.gnome.org/GNOME/orca/-/issues/248