-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Version dropdown benchmarks and spec
To prepare for versioned benchmarks and specs, we set a dropdown for both secions. This is close to being a dirty hack :( We do not display the dropdown we the path does not match the plugin Id. Inspired by facebook/docusaurus#7227
- Loading branch information
Showing
3 changed files
with
121 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
docs/src/components/NavbarItems/LocalDocsVersionDropdown.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
import React from 'react'; | ||
import { | ||
useVersions, | ||
useActiveDocContext, | ||
} from '@docusaurus/plugin-content-docs/client'; | ||
import { useDocsPreferredVersion } from '@docusaurus/theme-common'; | ||
import { useDocsVersionCandidates } from '@docusaurus/theme-common/internal'; | ||
import { translate } from '@docusaurus/Translate'; | ||
import { useLocation } from '@docusaurus/router'; | ||
import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem'; | ||
import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem'; | ||
import type { Props } from '@theme/NavbarItem/DocsVersionDropdownNavbarItem'; | ||
import type { GlobalVersion } from '@docusaurus/plugin-content-docs/client'; | ||
|
||
|
||
const getVersionMainDoc = (version: GlobalVersion) => | ||
version.docs.find((doc) => doc.id === version.mainDocId)!; | ||
|
||
export default function localDocsVersionDropdown({ | ||
mobile, | ||
docsPluginId, | ||
dropdownActiveClassDisabled, | ||
...props | ||
}: Props): JSX.Element | null { | ||
|
||
const { search, hash, pathname } = useLocation(); | ||
const activeDocContext = useActiveDocContext(docsPluginId); | ||
const versions = useVersions(docsPluginId); | ||
const { savePreferredVersionName } = useDocsPreferredVersion(docsPluginId); | ||
|
||
if (!pathname.includes(`/${docsPluginId}`)) { | ||
// We only render the version if the path matches the docsPluginId | ||
// Yes, this is a very dirty hack :( | ||
return null; | ||
} | ||
|
||
const versionLinks = versions.map((version) => { | ||
// We try to link to the same doc, in another version | ||
// When not possible, fallback to the "main doc" of the version | ||
const versionDoc = | ||
activeDocContext.alternateDocVersions[version.name] ?? | ||
getVersionMainDoc(version); | ||
return { | ||
label: version.label, | ||
// preserve ?search#hash suffix on version switches | ||
to: `${versionDoc.path}${search}${hash}`, | ||
isActive: () => version === activeDocContext.activeVersion, | ||
onClick: () => savePreferredVersionName(version.name), | ||
}; | ||
}); | ||
const items = [ | ||
...versionLinks, | ||
]; | ||
|
||
const dropdownVersion = useDocsVersionCandidates(docsPluginId)[0]; | ||
|
||
// Mobile dropdown is handled a bit differently | ||
const dropdownLabel = | ||
mobile && items.length > 1 | ||
? translate({ | ||
id: 'theme.navbar.mobileVersionsDropdown.label', | ||
message: 'Versions', | ||
description: | ||
'The label for the navbar versions dropdown on mobile view', | ||
}) | ||
: dropdownVersion.label; | ||
const dropdownTo = | ||
mobile && items.length > 1 | ||
? undefined | ||
: getVersionMainDoc(dropdownVersion).path; | ||
|
||
// We don't want to render a version dropdown with 0 or 1 item. If we build | ||
// the site with a single docs version (onlyIncludeVersions: ['1.0.0']), | ||
// We'd rather render a button instead of a dropdown | ||
if (items.length <= 1) { | ||
return ( | ||
<DefaultNavbarItem | ||
{...props} | ||
mobile={mobile} | ||
label={dropdownLabel} | ||
to={dropdownTo} | ||
isActive={dropdownActiveClassDisabled ? () => false : undefined} | ||
/> | ||
); | ||
} | ||
|
||
return ( | ||
<DropdownNavbarItem | ||
{...props} | ||
mobile={mobile} | ||
label={dropdownLabel} | ||
to={dropdownTo} | ||
items={items} | ||
isActive={dropdownActiveClassDisabled ? () => false : undefined} | ||
/> | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import ComponentTypes from '@theme-original/NavbarItem/ComponentTypes'; | ||
import LocalDocsVersionDropdown from '@site/src/components/NavbarItems/LocalDocsVersionDropdown'; | ||
|
||
export default { | ||
...ComponentTypes, | ||
'custom-localDocsVersionDropdown': LocalDocsVersionDropdown, | ||
}; |