Skip to content

Commit d73b195

Browse files
authored
feat(ui-components): add footer slot to ThemeToggle dropdown (#9323)
* feat(ui-components): add footer slot to ThemeToggle dropdown * feat: add changeset * feat: update
1 parent ed83104 commit d73b195

5 files changed

Lines changed: 89 additions & 1 deletion

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@node-core/ui-components': minor
3+
---
4+
5+
Add an optional `footer` prop to `ThemeToggle` that renders custom content (e.g. keyboard shortcut hints) at the bottom of the dropdown, below the theme options.

‎packages/ui-components/src/Common/ThemeToggle/__tests__/index.test.jsx‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,56 @@ describe('ThemeToggle', () => {
104104

105105
assert.equal(selected, 'system');
106106
});
107+
108+
it('renders the footer slot when provided', async () => {
109+
render(
110+
<ThemeToggle
111+
ariaLabel="Select theme"
112+
currentTheme="system"
113+
themeLabels={defaultLabels}
114+
footer={<span>Use ⌘+L for Light, ⌘+D for Dark</span>}
115+
/>
116+
);
117+
118+
await userEvent.click(screen.getByRole('button', { name: 'Select theme' }));
119+
120+
assert.ok(
121+
screen.getByText('Use ⌘+L for Light, ⌘+D for Dark'),
122+
'footer content should be rendered inside the dropdown'
123+
);
124+
125+
const footerId = screen.getByRole('menu').getAttribute('aria-describedby');
126+
assert.ok(
127+
footerId,
128+
'menu content should reference the footer via aria-describedby'
129+
);
130+
assert.equal(
131+
document.getElementById(footerId)?.textContent,
132+
'Use ⌘+L for Light, ⌘+D for Dark',
133+
'aria-describedby should point to the footer element'
134+
);
135+
});
136+
137+
it('does not render a footer separator when no footer is provided', async () => {
138+
render(
139+
<ThemeToggle
140+
ariaLabel="Select theme"
141+
currentTheme="system"
142+
themeLabels={defaultLabels}
143+
/>
144+
);
145+
146+
await userEvent.click(screen.getByRole('button', { name: 'Select theme' }));
147+
148+
assert.equal(
149+
document.querySelector('[class*="dropDownFooter"]'),
150+
null,
151+
'footer element should not exist without the footer prop'
152+
);
153+
assert.equal(
154+
screen.getByRole('menu').getAttribute('aria-describedby'),
155+
null,
156+
'menu content should not reference a footer without the footer prop'
157+
);
158+
});
107159
});

‎packages/ui-components/src/Common/ThemeToggle/index.module.css‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,14 @@
4747
@apply bg-brand-600
4848
text-white;
4949
}
50+
51+
.dropDownFooter {
52+
@apply border-t
53+
border-neutral-200
54+
px-2.5
55+
py-1.5
56+
text-xs
57+
text-neutral-500
58+
dark:border-neutral-800
59+
dark:text-neutral-400;
60+
}

‎packages/ui-components/src/Common/ThemeToggle/index.stories.tsx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,14 @@ export const DarkSelected: Story = {
3434
},
3535
};
3636

37+
export const WithFooter: Story = {
38+
args: {
39+
ariaLabel: 'Select theme',
40+
currentTheme: 'system',
41+
themeLabels: defaultLabels,
42+
onChange: () => {},
43+
footer: <span>⌘+L Light · ⌘+D Dark</span>,
44+
},
45+
};
46+
3747
export default { component: ThemeToggle } as Meta;

‎packages/ui-components/src/Common/ThemeToggle/index.tsx‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ import {
55
} from '@heroicons/react/24/outline';
66
import * as DropdownMenu from '@radix-ui/react-dropdown-menu';
77
import classNames from 'classnames';
8+
import { useId } from 'react';
89

9-
import type { FC } from 'react';
10+
import type { FC, ReactNode } from 'react';
1011

1112
import styles from './index.module.css';
1213

@@ -17,6 +18,7 @@ type ThemeToggleProps = {
1718
currentTheme?: Theme;
1819
ariaLabel?: string;
1920
themeLabels?: { system: string; light: string; dark: string };
21+
footer?: ReactNode;
2022
};
2123

2224
const themeIcons: Record<Theme, typeof SunIcon> = {
@@ -32,7 +34,9 @@ const ThemeToggle: FC<ThemeToggleProps> = ({
3234
currentTheme = 'system',
3335
ariaLabel = 'Select theme',
3436
themeLabels = { system: 'System', light: 'Light', dark: 'Dark' },
37+
footer,
3538
}) => {
39+
const footerId = useId();
3640
const TriggerIcon = themeIcons[currentTheme];
3741

3842
return (
@@ -52,6 +56,7 @@ const ThemeToggle: FC<ThemeToggleProps> = ({
5256
align="end"
5357
className={styles.dropDownContent}
5458
sideOffset={5}
59+
aria-describedby={footer ? footerId : undefined}
5560
>
5661
{themes.map(theme => {
5762
const Icon = themeIcons[theme];
@@ -68,6 +73,11 @@ const ThemeToggle: FC<ThemeToggleProps> = ({
6873
</DropdownMenu.Item>
6974
);
7075
})}
76+
{footer ? (
77+
<div id={footerId} className={styles.dropDownFooter}>
78+
{footer}
79+
</div>
80+
) : null}
7181
</DropdownMenu.Content>
7282
</DropdownMenu.Portal>
7383
</DropdownMenu.Root>

0 commit comments

Comments
 (0)