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

fix: close hamburger menu when click on item on mobile #1712

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions e2e/fixtures/nav-link-item-with-hash/doc/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ pageType: custom
<div id="pageA">contentA</div>

<div id="pageB">contentB</div>
<div id="pageC">contentC</div>
5 changes: 5 additions & 0 deletions e2e/fixtures/nav-link-item-with-hash/rspress.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ export default defineConfig({
link: '#pageB',
position: 'right',
},
{
text: 'PageC',
link: '#pageC',
position: 'right',
},
],
},
});
14 changes: 14 additions & 0 deletions e2e/tests/nav-link-item-with-hash.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,18 @@ test.describe('basic test', async () => {
await page.locator('.rspress-nav-menu a').nth(1).click();
expect(page.url()).toContain('index#pageB');
});

test('Close the hamburger menu when clicking on an item in mobile view', async ({
page,
}) => {
await page.setViewportSize({ width: 375, height: 812 });

await page.goto(`http://localhost:${appPort}/`);

await page.locator('.rspress-mobile-hamburger').click();
await expect(page.locator('.rspress-nav-screen')).toBeVisible();

await page.getByRole('link', { name: 'PageC' }).click();
await expect(page.locator('.rspress-nav-screen')).not.toBeVisible();
});
});
5 changes: 4 additions & 1 deletion packages/theme-default/src/components/Link/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,10 @@ export function Link(props: LinkProps) {
className={`${styles.link} ${className} cursor-pointer`}
rel={rel}
target={target}
onClick={handleNavigate}
onClick={event => {
rest.onClick?.(event);
handleNavigate(event);
}}
href={withBaseUrl}
>
{children}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ interface Props {
base: string;
rightIcon?: React.ReactNode;
compact?: boolean;
onClick?: () => void;
}

export function NavMenuSingleItem(
Expand All @@ -24,7 +25,7 @@ export function NavMenuSingleItem(
);

return (
<Link href={normalizeHref(item.link)}>
<Link href={normalizeHref(item.link)} onClick={item.onClick}>
<div
key={item.text}
className={`rspress-nav-menu-item ${styles.singleItem} ${
Expand Down
4 changes: 2 additions & 2 deletions packages/theme-default/src/components/Nav/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface NavProps {
afterNavMenu?: React.ReactNode;
}

const DEFAULT_NAV_POSTION = 'right';
const DEFAULT_NAV_POSITION = 'right';

export function Nav(props: NavProps) {
const { beforeNavTitle, afterNavTitle, beforeNav, afterNavMenu, navTitle } =
Expand Down Expand Up @@ -83,7 +83,7 @@ export function Nav(props: NavProps) {
const menuItems = useNavData();

const getPosition = (menuItem: NavItem) =>
menuItem.position ?? DEFAULT_NAV_POSTION;
menuItem.position ?? DEFAULT_NAV_POSITION;
// eslint-disable-next-line react/prop-types
const leftMenuItems = menuItems.filter(item => getPosition(item) === 'left');
// eslint-disable-next-line react/prop-types
Expand Down
3 changes: 2 additions & 1 deletion packages/theme-default/src/components/NavHambmger/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,14 @@ export function NavHamburger(props: Props) {
<Fragment>
<NavScreen
isScreenOpen={isScreenOpen}
toggleScreen={toggleScreen}
siteData={siteData}
pathname={pathname}
/>
<button
onClick={toggleScreen}
aria-label="mobile hamburger"
className={`${isScreenOpen ? styles.active : ''} ${
className={`${isScreenOpen ? styles.active : ''} rspress-mobile-hamburger ${
styles.navHamburger
} text-gray-500`}
>
Expand Down
6 changes: 4 additions & 2 deletions packages/theme-default/src/components/NavScreen/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { useNavData } from '../../logic/useNav';

interface Props {
isScreenOpen: boolean;
toggleScreen: () => void;
siteData: SiteData<DefaultThemeConfig>;
pathname: string;
}
Expand Down Expand Up @@ -45,7 +46,7 @@ const NavScreenVersions = () => {
};

export function NavScreen(props: Props) {
const { isScreenOpen, siteData, pathname } = props;
const { isScreenOpen, toggleScreen, siteData, pathname } = props;
const screen = useRef<HTMLDivElement | null>(null);
const localesData = siteData.themeConfig.locales || [];
const hasMultiLanguage = localesData.length > 1;
Expand Down Expand Up @@ -77,6 +78,7 @@ export function NavScreen(props: Props) {
key={item.text}
base={base}
langs={langs}
onClick={toggleScreen}
{...item}
/>
) : (
Expand All @@ -103,7 +105,7 @@ export function NavScreen(props: Props) {
}, [isScreenOpen]);
return (
<div
className={`${styles.navScreen} ${isScreenOpen ? styles.active : ''}`}
className={`${styles.navScreen} ${isScreenOpen ? styles.active : ''} rspress-nav-screen`}
ref={screen}
id="navScreen"
>
Expand Down
Loading