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

Accessibility issue in ExDoc headers #1987

Closed
josevalim opened this issue Dec 21, 2024 · 5 comments
Closed

Accessibility issue in ExDoc headers #1987

josevalim opened this issue Dec 21, 2024 · 5 comments

Comments

@josevalim
Copy link
Member

The experience could be improved further if those links to "view source" and "link to this function" were semantically outside of the heading. Currently if you navigate to e.g. "API Reference", the announcement says "Navigated to view source API reference". It would require a bit of a CSS rewrite.

SCR-20241221-qasn

Originally posted by @angelikatyborska in #1986 (comment)

@josevalim
Copy link
Member Author

@DavidOliver, if you have some availability, could you take a look? I think you have experience changing this part of the app and would probably be 10x more productive than me. If you cannot look at it, I understand. :) Thank you! ❤️

@josevalim
Copy link
Member Author

I think we should have something like this or similar:

<div id="modules" class="section-heading">
  <a href="#modules" class="hover-link">
    <i class="ri-link-m" aria-hidden="true"></i>
  </a>
  <h2 class="text">Modules</h2>
</div>

@DavidOliver
Copy link
Contributor

@josevalim, sure, I'll take a look.

@DavidOliver
Copy link
Contributor

Now in progress.

DavidOliver added a commit to DavidOliver/ex_doc that referenced this issue Jan 1, 2025
DavidOliver added a commit to DavidOliver/ex_doc that referenced this issue Jan 1, 2025
Avoids action link text being read out as part of "navigated to..."
announcements.

elixir-lang#1987
DavidOliver added a commit to DavidOliver/ex_doc that referenced this issue Jan 1, 2025
Avoids action link text being read out as part of "navigated to..."
announcements.

elixir-lang#1987
@josevalim
Copy link
Member Author

Closing in favor of the PR :)

DavidOliver added a commit to DavidOliver/ex_doc that referenced this issue Jan 2, 2025
Avoids action link text being read out as part of "navigated to..."
announcements.

elixir-lang#1987
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants