indiana-university / rivet-docs

Website and documentation for Rivet, Indiana University’s design system for web application development
https://rivet.iu.edu/
BSD 3-Clause "New" or "Revised" License
7 stars 3 forks source link

Link to "Hidden content" doc #84

Closed basham closed 5 years ago

basham commented 5 years ago

Devs are referencing the Rivet components and using them as patterns for their own work. They are noticing how Rivet uses the aria-hidden attribute and .rvt-sr-only class utility, but those aren't the only methods that we should use. We should provide additional documentation outlining these methods and use cases.

Recommendations:

  1. Reference the Hidden content doc on the UX site in the "Screen reader only" and "Visually hidden labels example" sections of the Display doc page.
  2. Move the "Screen reader only" and "Visually hidden labels example" sections to the Visibility doc page. This seems to be a more logical place to keep the content.
levimcg commented 5 years ago

Good call. I made the decision early on to use aria-hidden as the method to show/hide content (both visually and from screen readers) with JavaScript. Moving forward we'll definitely default to using the hidden attribute for showing and hiding things.

I'll pull this on into the backlog so we can get it prioritized.

illusivesunrae commented 5 years ago

Pulled into master in PR #106.