Skip to content

fix(a11y): add correct aria-label on ThemeToggle button #8045

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+47 −11
Open

fix(a11y): add correct aria-label on ThemeToggle button #8045

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
caddf8b
fix aria-label a11y
ShubhamOulkar Jul 29, 2025
73d4178
fix test
ShubhamOulkar Jul 29, 2025
d47d496
add a11y test for aria-label
ShubhamOulkar Jul 29, 2025
fe4dd3d
fix i18n aria-label text
ShubhamOulkar Jul 30, 2025
d5a3392
fix hydration
ShubhamOulkar Jul 30, 2025
821f134
refactor test
ShubhamOulkar Jul 31, 2025
07420f1
fix test
ShubhamOulkar Aug 2, 2025
61e8ea3
Exclude ThemeToggle btn from SSR
ShubhamOulkar Aug 3, 2025
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
18 changes: 16 additions & 2 deletions apps/site/components/withNavBar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

import LanguageDropdown from '@node-core/ui-components/Common/LanguageDropDown';
import Skeleton from '@node-core/ui-components/Common/Skeleton';
import ThemeToggle from '@node-core/ui-components/Common/ThemeToggle';
import NavBar from '@node-core/ui-components/Containers/NavBar';
// TODO(@AvivKeller): I don't like that we are importing styles from another module
import styles from '@node-core/ui-components/Containers/NavBar/index.module.css';
Expand All @@ -27,6 +26,16 @@ const SearchButton = dynamic(() => import('#site/components/Common/Search'), {
),
});

const ThemeToggle = dynamic(
() => import('@node-core/ui-components/Common/ThemeToggle'),
{
ssr: false,
loading: () => (
<Skeleton className={styles.themeToggleSkeleton} loading={true} />
),
}
);

const WithNavBar: FC = () => {
const { navigationItems } = useSiteNavigation();
const { resolvedTheme, setTheme } = useTheme();
Expand All @@ -39,6 +48,11 @@ const WithNavBar: FC = () => {
const toggleCurrentTheme = () =>
setTheme(resolvedTheme === 'dark' ? 'light' : 'dark');

const themeToggleAriaLabel =
resolvedTheme === 'dark'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is causing hydration mismatch. Initially resolvedTheme is undefined which is rendering wrong aria-label. I think it is better to go with doc or Is their better way to do it in Next.js?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's go with what the docs say

? t('components.common.themeToggle.light')
: t('components.common.themeToggle.dark');

const changeLanguage = (locale: SimpleLocaleConfig) =>
replace(pathname!, { locale: locale.code });

Expand All @@ -63,7 +77,7 @@ const WithNavBar: FC = () => {

<ThemeToggle
onClick={toggleCurrentTheme}
aria-label={t('components.common.themeToggle.label')}
aria-label={themeToggleAriaLabel}
/>

<LanguageDropdown
Expand Down
31 changes: 23 additions & 8 deletions apps/site/tests/e2e/general-behavior.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,25 @@ const locators = {
navLinksLocator: `[aria-label="${englishLocale.components.containers.navBar.controls.toggle}"] + div`,
// Global UI controls
languageDropdownName: englishLocale.components.common.languageDropdown.label,
themeToggleName: englishLocale.components.common.themeToggle.label,

themeToggleAriaLabels: {
light: englishLocale.components.common.themeToggle.light,
dark: englishLocale.components.common.themeToggle.dark,
},
// Search components (from Orama library)
searchButtonTag: 'orama-button',
searchInputTag: 'orama-input',
searchResultsTag: 'orama-search-results',
};

const getTheme = (page: Page) =>
page.evaluate(() => document.documentElement.dataset.theme);
page.evaluate(
() => document.documentElement.dataset.theme as 'light' | 'dark'
);

const getCurrentAriaLabel = (theme: string) =>
theme === 'dark'
? locators.themeToggleAriaLabels.light
: locators.themeToggleAriaLabels.dark;

const openLanguageMenu = async (page: Page) => {
const button = page.getByRole('button', {
Expand Down Expand Up @@ -65,21 +74,27 @@ test.describe('Node.js Website', () => {
test.describe('Theme', () => {
test('should toggle between light/dark themes', async ({ page }) => {
const themeToggle = page.getByRole('button', {
name: locators.themeToggleName,
name: /Switch to (Light|Dark) Mode/i,
});
await expect(themeToggle).toBeVisible();

const initialTheme = await getTheme(page);
const initialAriaLabel = getCurrentAriaLabel(initialTheme);
let currentAriaLabel = await themeToggle.getAttribute('aria-label');
expect(currentAriaLabel).toBe(initialAriaLabel);

await themeToggle.click();

const newTheme = await getTheme(page);
expect(newTheme).not.toEqual(initialTheme);
expect(['light', 'dark']).toContain(newTheme);
const newAriaLabel = getCurrentAriaLabel(newTheme);
currentAriaLabel = await themeToggle.getAttribute('aria-label');

expect(newTheme).not.toBe(initialTheme);
expect(currentAriaLabel).toBe(newAriaLabel);
});

test('should persist theme across page navigation', async ({ page }) => {
const themeToggle = page.getByRole('button', {
name: locators.themeToggleName,
name: /Switch to (Light|Dark) Mode/i,
});
await themeToggle.click();
const selectedTheme = await getTheme(page);
Expand Down
3 changes: 2 additions & 1 deletion packages/i18n/src/locales/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,8 @@
"label": "Choose Language"
},
"themeToggle": {
"label": "Toggle Dark Mode"
"light": "Switch to Light Mode",
"dark": "Switch to Dark Mode"
}
},
"metabar": {
Expand Down
6 changes: 6 additions & 0 deletions packages/ui-components/src/Containers/NavBar/index.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,12 @@ span.searchButtonSkeleton {
}
}

span.themeToggleSkeleton {
@apply size-9
rounded-md
py-4;
}

.ghIconWrapper {
@apply size-9
rounded-md
Expand Down