3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-06 10:20:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(theme): preserve url ?search#hash on navbar version/locale dropdowns navigations (#8059)

Browse source
This commit is contained in:
Sébastien Lorber 2022-09-07 19:36:04 +02:00 • committed by GitHub
parent 67c692326b
commit a492025cbf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

5
packages/docusaurus-theme-classic/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx
View file

@ -13,6 +13,7 @@ import {
import {useDocsPreferredVersion} from '@docusaurus/theme-common'; import {useDocsPreferredVersion} from '@docusaurus/theme-common';
import {useDocsVersionCandidates} from '@docusaurus/theme-common/internal'; import {useDocsVersionCandidates} from '@docusaurus/theme-common/internal';
import {translate} from '@docusaurus/Translate'; import {translate} from '@docusaurus/Translate';
import {useLocation} from '@docusaurus/router';
import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem'; import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem'; import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem';
import type {Props} from '@theme/NavbarItem/DocsVersionDropdownNavbarItem'; import type {Props} from '@theme/NavbarItem/DocsVersionDropdownNavbarItem';
@ -29,6 +30,7 @@ export default function DocsVersionDropdownNavbarItem({
dropdownItemsAfter, dropdownItemsAfter,
...props ...props
}: Props): JSX.Element { }: Props): JSX.Element {
const {search, hash} = useLocation();
const activeDocContext = useActiveDocContext(docsPluginId); const activeDocContext = useActiveDocContext(docsPluginId);
const versions = useVersions(docsPluginId); const versions = useVersions(docsPluginId);
const {savePreferredVersionName} = useDocsPreferredVersion(docsPluginId); const {savePreferredVersionName} = useDocsPreferredVersion(docsPluginId);
@ -40,7 +42,8 @@ export default function DocsVersionDropdownNavbarItem({
getVersionMainDoc(version); getVersionMainDoc(version);
return { return {
label: version.label, label: version.label,
to: versionDoc.path, // preserve ?search#hash suffix on version switches
to: `${versionDoc.path}${search}${hash}`,
isActive: () => version === activeDocContext.activeVersion, isActive: () => version === activeDocContext.activeVersion,
onClick: () => savePreferredVersionName(version.name), onClick: () => savePreferredVersionName(version.name),
}; };

6
packages/docusaurus-theme-classic/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx
View file

@ -9,6 +9,7 @@ import React from 'react';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import {useAlternatePageUtils} from '@docusaurus/theme-common/internal'; import {useAlternatePageUtils} from '@docusaurus/theme-common/internal';
import {translate} from '@docusaurus/Translate'; import {translate} from '@docusaurus/Translate';
import {useLocation} from '@docusaurus/router';
import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem'; import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem';
import IconLanguage from '@theme/Icon/Language'; import IconLanguage from '@theme/Icon/Language';
import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem'; import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
@ -26,12 +27,15 @@ export default function LocaleDropdownNavbarItem({
i18n: {currentLocale, locales, localeConfigs}, i18n: {currentLocale, locales, localeConfigs},
} = useDocusaurusContext(); } = useDocusaurusContext();
const alternatePageUtils = useAlternatePageUtils(); const alternatePageUtils = useAlternatePageUtils();
const {search, hash} = useLocation();
const localeItems = locales.map((locale): LinkLikeNavbarItemProps => { const localeItems = locales.map((locale): LinkLikeNavbarItemProps => {
const to = `pathname://${alternatePageUtils.createUrl({ const baseTo = `pathname://${alternatePageUtils.createUrl({
locale, locale,
fullyQualified: false, fullyQualified: false,
})}`; })}`;
// preserve ?search#hash suffix on locale switches
const to = `${baseTo}${search}${hash}`;
return { return {
label: localeConfigs[locale]!.label, label: localeConfigs[locale]!.label,
lang: localeConfigs[locale]!.htmlLang, lang: localeConfigs[locale]!.htmlLang,

8
packages/docusaurus-theme-common/src/hooks/useHideableNavbar.ts
View file

@ -62,7 +62,13 @@ export function useHideableNavbar(hideOnScroll: boolean): {
return; return;
} }
if (locationChangeEvent.location.hash) { // See https://github.com/facebook/docusaurus/pull/8059#issuecomment-1239639480
const currentHash = locationChangeEvent.location.hash;
const currentHashAnchor = currentHash
? document.getElementById(currentHash.substring(1))
: undefined;
if (currentHashAnchor) {
isFocusedAnchor.current = true; isFocusedAnchor.current = true;
setIsNavbarVisible(false); setIsNavbarVisible(false);
return; return;