Skip to content
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.

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

📚 Documentation: multiple <nav> elements should be labelled [a11y][TheA11y100] #294

Closed
2 tasks done
GrahamTheDevRel opened this issue Oct 26, 2023 · 7 comments · Fixed by #358
Closed
2 tasks done
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@GrahamTheDevRel
Copy link

GrahamTheDevRel commented Oct 26, 2023

Issue

There are multiple <nav> elements on each page. When you have more than one <nav> you should add a label to each.

Why it matters

When you have more than one <nav> element you should add a label to each to aid navigation with assistive tech and to differentiate them, otherwise when navigate via landmarks it can be confusing which navigation a user is targetting.

Suggested fix

Add aria-labels to each of the <nav> elements to identify their purposes.

For example:
Nav at the top could be <nav aria-label="main"> and the nav at the side could be <nav aria-label="docs"> (these could be better, if someone can think of more descriptive names for each navigation element. You do not need to say "navigation" as part of the text.)

Relevant Guidance

multiple navigation landmarks

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@GrahamTheDevRel GrahamTheDevRel added the documentation Improvements or additions to documentation label Oct 26, 2023
@divyanshkul
Copy link

Would love to work on this!
Also, could this be added to Appwrite's Hacktoberfest program?

@TGlide
Copy link
Contributor

TGlide commented Oct 30, 2023

@divyanshkul Assigned it to you. We can add the hacktoberfest-accepted label to a merged PR 😄

@CBID2
Copy link
Contributor

CBID2 commented Nov 15, 2023

Hi @TGlide. Hacktoberfest is over, and it seems that the assignee has not worked on this issue. If you're open, I'd love to work on this.

@TGlide
Copy link
Contributor

TGlide commented Nov 16, 2023

Hi @TGlide. Hacktoberfest is over, and it seems that the assignee has not worked on this issue. If you're open, I'd love to work on this.

Go ahead!

@TGlide TGlide assigned CBID2 and unassigned divyanshkul Nov 16, 2023
@guptadeepak8
Copy link
Contributor

@CBID2 are you working on this issue?

@CBID2
Copy link
Contributor

CBID2 commented Nov 17, 2023

@CBID2 are you working on this issue?

Yes

@CBID2
Copy link
Contributor

CBID2 commented Nov 17, 2023

Hi @TGlide! :) I made the PR for this. It's #358

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants