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.

Sign up for GitHub

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

A11Y: Add title attribute to theme switcher #1924

Merged
merged 2 commits into from
Sep 11, 2024
Merged

A11Y: Add title attribute to theme switcher #1924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c133db0
A11Y: Add title attribute to theme switcher
Carreau Aug 20, 2024
24ff988
Merge branch 'main' into acc-tree
trallard Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/theme-switcher.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{# Displays an icon to switch between light mode, dark mode, and auto (use browser's setting). #}
{# As the theme switcher will only work when JavaScript is enabled, we hide it with `pst-js-only`. #}
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" title="{{ _('light/dark') }}" aria-label="{{ _('light/dark') }}" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="{{ _('Color mode') }}" data-bs-title="{{ _('Color mode') }}" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="{{ _('Light') }}"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="{{ _('Dark') }}"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="{{ _('System Settings') }}"></i>
</button>
10 changes: 9 additions & 1 deletion tests/test_build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -997,7 +997,15 @@ def test_translations(sphinx_build_factory) -> None:
assert "Modifier sur GitHub" in str(sidebar_secondary)

header = index.select(".bd-header")[0]
assert "clair/sombre" in str(header)
## TODO: update once translataion up to date
# assert "clair/sombre" in str(header)
# Text of theme switcher button have been changed,
# "light/dark" has been updated to "Color mode" and does not have a translation yet.
if "Color mode" not in str(header):
pytest.xfail(
"Please update test_build.py::test_translations now that new translation are available."
)
# End TODO

footer = index.select(".bd-footer")[0]
assert "Copyright" in str(footer)
Expand Down
8 changes: 4 additions & 4 deletions tests/test_build/navbar_theme.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<button aria-label="light/dark" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="light/dark">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light">
<button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light">
</i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark">
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark">
</i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto">
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings">
</i>
</button>
8 changes: 4 additions & 4 deletions tests/test_build/sidebar_subpage.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button aria-label="light/dark" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-toggle="tooltip" title="light/dark">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light">
<button aria-label="Color mode" class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" data-bs-placement="bottom" data-bs-title="Color mode" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light">
</i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark">
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark">
</i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto">
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings">
</i>
</button>
</div>
Expand Down
Loading