search

sul-dlss / libapps

Custom styling and configuration for Springshare apps
1 stars 0 forks source link

Is it possible to change ARIA label tags and to add them? #16

Open astridu opened 1 month ago

astridu commented 1 month ago

Before I submit a bunch of tickets to fix ARIA labels, is it even possible for us to change them and/or add them. Some pages are missing the Main tag, and some need a tag either modified or a value placed in the tag. Also, is this something the content creators can do or is it something we have to fix (or possibly something for the vendor to remediate)?

corylown commented 1 month ago

There are at least two different issues with ARIA labels.

The first issue, reported as ARIA attribute unsupported or prohibited appears to be a problem with the "gallery" widget that guide creators can add to their pages. It produces markup with invalid aria-label attributes/values. https://guides.library.stanford.edu/ee is an example of a guide that uses the gallery widget. This would need to be reported to Springshare. I don't think we have any control over this widget.

The second issue is reported as Text not included in an ARIA landmark in siteimprove. It's complaining that the h1 with the guide title is not included in an aria-landmark. I think we can fix this because we control the overall guide template here: https://github.com/sul-dlss/libapps/blob/0dc63be8b197faceaea2391b5d2cf2f678c2717a/libguides/guide-template.html#L19

corylown commented 1 month ago

I fixed the second part of Text not included in an ARIA landmark this by wrapping the main part of the guide template in a <main> tag. This should address the complaint from SiteImprove. I think a more holistic review and refactoring of the templates is warranted, but that's more than a maintenance week's worth of work.