Issue: Link missing a text alternative - mobile navigation
This article specifically pertains to an issue found in the legacy templates with the mobile navigation menu.
Issue | Conformance | Description |
---|---|---|
Link missing a text alternative | A | Links should always have a text alternative. The link text can be inserted into the HTML — it does not need to be visible to pass this check. |
Links represented by images or icons can be problematic for visitors who are blind or have low vision. The text alternative should describe the link's purpose — or what visitors can expect to find after they click it. This issue may be found on every page in your website. More than likely, it is due to the image used to activate the mobile menu in the legacy templates.
This fix requires editing HTML Code and depending on the template version, may be handled centrally.
Good News! You only need to make this change once. This change will propagate to every page on your site after you re-publish the pages.
It is recommended that you work with two browser windows open (Cascade CMS and Siteimprove) as you complete this process.
Locate the code to fix
When viewing a page report in Siteimprove, the default view shows page content. When you click on the
Show HTML button, Siteimprove will highlight the issue location in the code.
Take note of the highlighted code in your browser window. The code highlighted indicates that the NMSU logo that is linked in the mobile navigation is missing a text alternative. Updating the link text alternative might be handled centrally depending on the template version you are using.
If the text highlighted in your page report does not match the <a>
tag highlighted in the sample above, you may need to create your own alternative text depending on the image/icon that is used.
Adding a text alternative for the mobile navigation is set in the mobile-nav block in the site template.
Instructions
In Cascade CMS, go to the page identified in the page report. In the sample above, the “presentation template” page is selected.
Click the …more drop down menu and select Show Regions. The Region Assignments sidebar will appear.
The Region Assignments provide a map of each region created in a template. We have already identified the text alternative issue in the mobile-nav block. Click Mobile Nav. The block “mobile-nav” appears.
Point your mouse over the “mobile-nav” block until the hand cursor appears. Wait a few seconds until the tool tip appears beneath it. The tooltip will provide the file path to the mobile-nav asset in Cascade.
Take note of the file path.
If the file path starts with _Shared Assets, then this fix has been implemented centrally. All you need to do is re-publish your page(s) and proceed to part 3 to verify successful remediation in Siteimprove.
If the file path starts with the title of your site, then you need to implement this fix for your site. Proceed to step 6.
After you have determined that the mobile-nav block is located within your site files, click the mobile-nav block to go to the asset in your site.
Note the breadcrumb trail for the mobile-nav block above. It is located inside the _cascade folder for your site. Files in the _cascade folder control a specific region on every page in your site. Making a change to this asset will require you to re-publish your pages in your site for the changes to take effect.
Add the text alternative for the mobile-nav block
On the XML Block: mobile-nav page, click Edit. The advanced editor window will open.
Click on the Toggle Fullscreen Mode icon to expand the code view.
On or around line 7 of the code, locate the
<a>
tag highlighted in the Siteimprove page report and in the Cascade CMS advanced editor.Copy the aria-label from the code block below and add it to the <a> tag.
aria-label="Visit NMSU homepage"
The <a>
tag should now look like this:
Click Preview Draft and then Submit to save to Cascade CMS.
After you have successfully saved the XML code block, go to the page in Cascade CMS that was identified in the Siteimprove page report and publish the page.
Verify successful remediation
Return to the Siteimprove to recheck the page.
You can recheck the page from the page report window or the list of pages in the issue overview page.
When you return to the issues overview page in Siteimprove, the page you fixed will no longer be listed for this particular issue.