[Docs]: Add version selector to VersionBadge #1308
+74
−6
There are no files selected for viewing
This file contains hidden or 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 | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -1,38 +1,103 @@ | ||||||||
| 'use client' | ||||||||
|
|
||||||||
| import { ChangeEvent } from 'react' | ||||||||
| import styled from 'styled-components' | ||||||||
| import { CARD_STYLES } from '@/utils/card' | ||||||||
| import { SPACINGS } from '@/utils/spacings' | ||||||||
| import { BORDER_RADIUSES } from '@/utils/border' | ||||||||
| import { FONT_SIZES, FONT_WEIGHTS } from '@/utils/font-sizes' | ||||||||
| import { COLORS } from '@/utils/theme' | ||||||||
| import { usePathname, useRouter } from 'next/navigation' | ||||||||
| import { getVersionFromPathname } from '@/utils/slug' | ||||||||
| import { DOCS_LATEST_VERSION, DOCS_VERSIONS } from '@/utils/global-data' | ||||||||
|
|
||||||||
| const VersionBadgeWrapper = styled.div` | ||||||||
| ${CARD_STYLES}; | ||||||||
| display: inline-flex; | ||||||||
| align-items: center; | ||||||||
| padding: 0.6rem ${SPACINGS.THREE}; | ||||||||
| border-radius: ${BORDER_RADIUSES.SOFT}; | ||||||||
| font-size: ${FONT_SIZES.COMPLEMENTARY}; | ||||||||
| color: ${COLORS.TEXT_LOW_CONTRAST}; | ||||||||
| ` | ||||||||
|
|
||||||||
| const VersionBadgeKey = styled.label` | ||||||||
| font-weight: ${FONT_WEIGHTS.SEMI_BOLD}; | ||||||||
| margin-right: 0.4rem; | ||||||||
| ` | ||||||||
|
|
||||||||
| const VersionSelect = styled.select` | ||||||||
| appearance: none; | ||||||||
| background: transparent; | ||||||||
| border: none; | ||||||||
| padding: 0; | ||||||||
| width: 100%; | ||||||||
| cursor: pointer; | ||||||||
| font-weight: ${FONT_WEIGHTS.SEMI_BOLD}; | ||||||||
| outline: none; | ||||||||
|
|
||||||||
| &::-ms-expand { | ||||||||
| display: none; | ||||||||
| } | ||||||||
| ` | ||||||||
|
|
||||||||
| type PropType = {} | ||||||||
|
|
||||||||
| const DOCS_VERSION_SEGMENT_REGEX = /^v\d+$/ | ||||||||
|
|
||||||||
| function getDocsSubPath(pathname = ''): string[] { | ||||||||
| if (!pathname.startsWith('/docs')) return [] | ||||||||
| const [, ...docsSubPath] = pathname.split('/').filter(Boolean) | ||||||||
|
|
||||||||
| return DOCS_VERSION_SEGMENT_REGEX.test(docsSubPath[0] ?? '') | ||||||||
| ? docsSubPath.slice(1) | ||||||||
| : docsSubPath | ||||||||
| } | ||||||||
|
Comment on lines
+48
to
+55
Owner
There was a problem hiding this comment. An alternative approach is to use a regex like this. There’s no need to change it, though — feel free to choose whichever option you find more readable. const DOCS_WITH_VERSION_REGEX = /^\/docs(?:\/v\d+)?/
function getDocsSubPath(pathname = ''): string[] {
if (!pathname.startsWith('/docs')) return []
return pathname
.replace(DOCS_WITH_VERSION_REGEX, '')
.split('/')
.filter(Boolean)
} |
||||||||
|
|
||||||||
| function getVersionPathname(pathname = '', major: number): string { | ||||||||
| const versionPrefix = major === DOCS_LATEST_VERSION.MAJOR ? [] : [`v${major}`] | ||||||||
| return ['docs', ...versionPrefix, ...getDocsSubPath(pathname)].join('/') | ||||||||
|
Comment on lines
+58
to
+59
Owner
There was a problem hiding this comment. We could reuse existing helpers to achieve the same result—see function getVersionPathname(pathname = '', major: number): string {
const versionPrefix = major === DOCS_LATEST_VERSION.MAJOR ? '' : `v${major}`
const versionAndSubPath = joinSlugs(versionPrefix, ...getDocsSubPath(pathname))
return prefixSlugWithDocs(versionAndSubPath)
} |
||||||||
| } | ||||||||
|
|
||||||||
| export function VersionBadge(props: PropType) { | ||||||||
| const { ...restProps } = props | ||||||||
| const router = useRouter() | ||||||||
| const pathname = usePathname() | ||||||||
| const version = getVersionFromPathname(pathname) | ||||||||
|
|
||||||||
| function onVersionChange(event: ChangeEvent<HTMLSelectElement>) { | ||||||||
| const major = Number(event.target.value) | ||||||||
| const nextPathname = `/${getVersionPathname(pathname, major)}` | ||||||||
|
|
||||||||
| if (nextPathname === pathname) return | ||||||||
|
Owner
There was a problem hiding this comment. Let’s start loading the route here to maintain the strong INP score the website currently has 🙂:
Suggested change
|
||||||||
| router.push(nextPathname) | ||||||||
| } | ||||||||
|
|
||||||||
| return ( | ||||||||
| <VersionBadgeWrapper {...restProps}> | ||||||||
| <VersionBadgeKey htmlFor="version">Version:</VersionBadgeKey> | ||||||||
|
|
||||||||
| <VersionSelect | ||||||||
| aria-label="Select documentation version" | ||||||||
| value={String(version.MAJOR)} | ||||||||
| name="version" | ||||||||
| id="version" | ||||||||
| onChange={onVersionChange} | ||||||||
| > | ||||||||
| {DOCS_VERSIONS.map((docsVersion) => { | ||||||||
| const versionLabel = `v${docsVersion.MAJOR}` | ||||||||
| const versionSuffix = docsVersion.SUFFIX | ||||||||
| ? ` (${docsVersion.SUFFIX})` | ||||||||
| : '' | ||||||||
|
|
||||||||
| return ( | ||||||||
| <option key={versionLabel} value={docsVersion.MAJOR}> | ||||||||
| {versionLabel} | ||||||||
| {versionSuffix} | ||||||||
| </option> | ||||||||
| ) | ||||||||
| })} | ||||||||
| </VersionSelect> | ||||||||
| </VersionBadgeWrapper> | ||||||||
| ) | ||||||||
| } | ||||||||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.