* testing out a rest operations sidebar * cleanup * renamed 5 files * renamed 5 files * set redirect_from on 5 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 1 files * renamed 2 files * renamed 1 files * renamed 4 files * renamed 15 files * renamed 2 files * renamed 6 files * renamed 1 files * renamed 4 files * renamed 7 files * renamed 1 files * renamed 3 files * renamed 3 files * renamed 1 files * renamed 5 files * renamed 1 files * renamed 1 files * renamed 3 files * renamed 4 files * renamed 1 files * renamed 1 files * renamed 2 files * renamed 4 files * renamed 1 files * renamed 1 files * renamed 1 files * renamed 6 files * renamed 6 files * renamed 4 files * move files * adding more * updating to add restcontext and start of removing data/reusables/rest-reference * removed data/reusables * add a RestMiniTocItem and updating the filtering to add a subcategory so all manually added H3s are in mini tocs in addition to operations * remove console log * [WIP]: REST New Proposal Sidebar (#26471) * saving * update sidebar * remove console log * update guides and overview * import Category for category level rest pages * update undefined restOperations * update restOperationData category and subcategory levels" * minor updates * update get mini toc items function * updating REST context for sidebar * updating rest data * remove console logs * WIP: mini-toc-ing the sidebar Co-authored-by: Robert Sese <rsese@github.com> * A little cleanup * Fix first subcategory link and add some comments * updating anchor links in sidebar * adding updates * remove standalone * update product and maptopic pages using article context * add conditional link wrapper * fix sidebar toggle and versions for enterprise admin * update versions per subcategory * Highlight sidebar link for current page * Update miniToc hash links and hash change tracking * fix unique key in CollapsibleSection * Fix list markup * remove title * update permissions * Hide minitocs on landing (#26594) * hide minitocs on landing page * simplify page components and remove minitoc from sidebar for guides/overview * fix carats and category fix * remove id Co-authored-by: Grace Park <gracepark@github.com> * updating content based on versions script check with the OpenAPI * update script and content files * update script and content/rest files * update to add TocLanding * update script * update index files * add codespaces repository-secrets * remove openapi schema check script * remove minitocs at the top * add h2 about the {title} api * fix tests/unit/openapi-schema.js * Fix linting tests * fix search/topics test * fix tests/unit/pages test * update rest/reference links in components * run prettier * Update components/rest/RestReferencePage.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update components/rest/RestReferencePage.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update pages/[versionId]/rest/[category]/[subcategory].tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * Update tests/unit/openapi-schema.js Co-authored-by: Rachael Sewell <rachmari@github.com> * updating comment location * remove dependabot override * remove path-utils current product update for rest * run linter * remove dependabot.md and remove h2 heading on restreference * update the correct product to rest for rest pages * adding comments for updates to path-utils * remove console log * REST sidebar: handle legacy v3 redirects (#26686) * Add script to handle legacy v3 REST redirects * Run the script * Handle a redirect to a redirect * Update REST test URLs * 'await' and test runs subcategory of checks * Update REST URLs for routing/developer-site-redirects tests * Update developer-redirects fixture with new REST URLs * Resolve merge conflicts * Update rest-redirects fixture with new REST URLs * Fix broken links with REST pages re-org * redirectTo could be undefined * Fix script for posterity, can't redirect paths with hashes * Remove invalid hash redirects * Typically don't need to save one-off scripts * Undo redirect changes (not necessary for handling v3 redirects) * Remove script-added redirects * Update old v3 redirects with new REST URLs * No more GHES search indexing page * 'org' not 'organization' * Update fixture data for new REST URLs * revert any content directory changes Co-authored-by: Grace Park <gracepark@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> * Adding test rest (#26750) * add test to check openapi schema versions and content rest frontmatter versions * update lib/redirects * fix test and add error messages * adding repository secrets * adding repository-secrets.md * Revert "update lib/redirects" This reverts commit 3aafe28265764d5bc09c0c478c8e0ca099c8fbcf. * remove lib/redirects changes and console logs * Update lib/rest/index.js Co-authored-by: Rachael Sewell <rachmari@github.com> * update unique key * Rest client side redirects (#26754) * adding tags subcategory for the rest content repos category * run prettier * bug fix for anchor scrolls" (#26892) * updating width size for rest reference page * Rest sidebar consolidation (#26862) * refactor sidebar * fix articlecontext provider issue on rest product landing page for all versions * fix a bug, create new component * revert change to create new component and fix bug Co-authored-by: Rachael Sewell <rachmari@github.com> * Set currentAnchor with a hashchange handler (#26923) * Rest sidebar design tweaks (#26807) * Rest sidebar design tweaks * tweak color to subtle * use muted color and margin for line * update to design feedback Co-authored-by: Grace Park <gracepark@github.com> * Remove cheerio from rest-collapsible (#26948) * remove cheerio from rest-collapsible * update type * adding endswith instead * use productId instead * one off edge case for secret-scanning * Reorganize subcategory and category, Update pre -> div, Add RestContext (#26950) * reorganize subcategory and category * add RestContext * update comment * update for endpoints page * add comment * move object to restcontext * remove effectiveDate in restcontext * remove width calculation for rest reference page * fix adding manual writer's minitocs to sidebar * update with feedback * update comment * update isRestReferencePage * remove page component and fix bug * adding back rest/index.tsx Co-authored-by: Rachael Sewell <rachmari@github.com> * update content/rest" * add back design tweak * update to div * update margins on rest api reference * remove page component * adding tests * separate product from rest sidebar (#27065) * separate product from rest sidebar * Use ProductCollapsibleSections for product pages * fix tests Co-authored-by: Robert Sese <rsese@github.com> Co-authored-by: Grace Park <gracepark@github.com> * Rest sidebar translations (#27052) * update translations * remove general test Co-authored-by: Robert Sese <rsese@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com>
175 lines
6.0 KiB
TypeScript
175 lines
6.0 KiB
TypeScript
import { useEffect, useState } from 'react'
|
|
import cx from 'classnames'
|
|
import { useRouter } from 'next/router'
|
|
import { MarkGithubIcon, ThreeBarsIcon, XIcon } from '@primer/octicons-react'
|
|
import { useVersion } from 'components/hooks/useVersion'
|
|
|
|
import { Link } from 'components/Link'
|
|
import { useMainContext } from 'components/context/MainContext'
|
|
import { LanguagePicker } from './LanguagePicker'
|
|
import { HeaderNotifications } from 'components/page-header/HeaderNotifications'
|
|
import { ProductPicker } from 'components/page-header/ProductPicker'
|
|
import { useTranslation } from 'components/hooks/useTranslation'
|
|
import { Search } from 'components/Search'
|
|
import { VersionPicker } from 'components/page-header/VersionPicker'
|
|
import { Breadcrumbs } from './Breadcrumbs'
|
|
import styles from './Header.module.scss'
|
|
|
|
export const Header = () => {
|
|
const router = useRouter()
|
|
const { isDotComAuthenticated, relativePath, error } = useMainContext()
|
|
const { currentVersion } = useVersion()
|
|
const { t } = useTranslation(['header', 'homepage'])
|
|
const [isMenuOpen, setIsMenuOpen] = useState(
|
|
router.pathname !== '/' && router.query.query && true
|
|
)
|
|
const [scroll, setScroll] = useState(false)
|
|
|
|
const signupCTAVisible =
|
|
!isDotComAuthenticated &&
|
|
(currentVersion === 'free-pro-team@latest' || currentVersion === 'enterprise-cloud@latest')
|
|
|
|
useEffect(() => {
|
|
function onScroll() {
|
|
setScroll(window.scrollY > 10)
|
|
}
|
|
window.addEventListener('scroll', onScroll)
|
|
return () => {
|
|
window.removeEventListener('scroll', onScroll)
|
|
}
|
|
}, [])
|
|
|
|
useEffect(() => {
|
|
const close = (e: { key: string }) => {
|
|
if (e.key === 'Escape') {
|
|
setIsMenuOpen(false)
|
|
}
|
|
}
|
|
window.addEventListener('keydown', close)
|
|
return () => window.removeEventListener('keydown', close)
|
|
}, [])
|
|
|
|
return (
|
|
<div
|
|
className={cx(
|
|
'border-bottom d-unset color-border-muted no-print z-3 color-bg-default position-sticky top-0',
|
|
styles.header
|
|
)}
|
|
>
|
|
{error !== '404' && <HeaderNotifications />}
|
|
<header
|
|
className={cx(
|
|
'color-bg-default px-3 px-md-6 pt-3 pb-3 position-sticky top-0 z-3 border-bottom',
|
|
scroll && 'color-shadow-small'
|
|
)}
|
|
>
|
|
{/* desktop header */}
|
|
<div
|
|
className="d-none d-lg-flex flex-justify-end flex-items-center flex-wrap flex-xl-nowrap"
|
|
data-testid="desktop-header"
|
|
>
|
|
<div
|
|
className={cx('mr-auto width-full width-xl-auto', scroll && styles.breadcrumbs)}
|
|
data-search="breadcrumbs"
|
|
>
|
|
<Breadcrumbs />
|
|
</div>
|
|
<div className="d-flex flex-items-center">
|
|
<div className="mr-2">
|
|
<VersionPicker />
|
|
</div>
|
|
|
|
<LanguagePicker />
|
|
|
|
{signupCTAVisible && (
|
|
<a
|
|
href="https://github.com/signup?ref_cta=Sign+up&ref_loc=docs+header&ref_page=docs"
|
|
target="_blank"
|
|
rel="noopener"
|
|
className="ml-3 btn color-fg-muted"
|
|
>
|
|
{t`sign_up_cta`}
|
|
</a>
|
|
)}
|
|
|
|
{/* <!-- GitHub.com homepage and 404 page has a stylized search; Enterprise homepages do not --> */}
|
|
{relativePath !== 'index.md' && error !== '404' && (
|
|
<div className="d-inline-block ml-3">
|
|
<Search iconSize={16} isHeaderSearch={true} />
|
|
</div>
|
|
)}
|
|
</div>
|
|
</div>
|
|
|
|
{/* mobile header */}
|
|
<div className="d-lg-none" data-testid="mobile-header">
|
|
<div className="d-flex flex-justify-between">
|
|
<div className="d-flex flex-items-center" id="github-logo-mobile">
|
|
<Link aria-hidden="true" tabIndex={-1} href={`/${router.locale}`}>
|
|
<MarkGithubIcon size={32} className="color-fg-default" />
|
|
</Link>
|
|
|
|
<Link
|
|
href={`/${router.locale}`}
|
|
className="f4 text-semibold color-fg-default no-underline no-wrap pl-2"
|
|
>
|
|
{t('github_docs')}
|
|
</Link>
|
|
</div>
|
|
|
|
<nav>
|
|
<button
|
|
className="btn"
|
|
data-testid="mobile-menu-button"
|
|
onClick={() => setIsMenuOpen(!isMenuOpen)}
|
|
aria-label="Navigation Menu"
|
|
aria-expanded={isMenuOpen ? 'true' : 'false'}
|
|
>
|
|
{isMenuOpen ? <XIcon size="small" /> : <ThreeBarsIcon size="small" />}
|
|
</button>
|
|
</nav>
|
|
</div>
|
|
|
|
{/* mobile menu contents */}
|
|
<div className="relative">
|
|
<div
|
|
className={cx('width-full position-sticky top-0', isMenuOpen ? 'd-block' : 'd-none')}
|
|
>
|
|
<div className="my-4">
|
|
<Breadcrumbs />
|
|
</div>
|
|
|
|
<ProductPicker />
|
|
|
|
<div className="border-top my-2" />
|
|
<VersionPicker variant="inline" />
|
|
|
|
<div className="border-top my-2" />
|
|
<LanguagePicker variant="inline" />
|
|
{signupCTAVisible && (
|
|
<a
|
|
href="https://github.com/signup?ref_cta=Sign+up&ref_loc=docs+header&ref_page=docs"
|
|
target="_blank"
|
|
rel="noopener"
|
|
className="mt-3 py-2 btn color-fg-muted d-block"
|
|
>
|
|
{t`sign_up_cta`}
|
|
</a>
|
|
)}
|
|
|
|
{/* <!-- GitHub.com homepage and 404 page has a stylized search; Enterprise homepages do not --> */}
|
|
{relativePath !== 'index.md' && error !== '404' && (
|
|
<div className="my-2 pt-2">
|
|
<Search iconSize={16} isMobileSearch={true} />
|
|
</div>
|
|
)}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
{/* Adding Portal Root here for DropdownMenu and ActionList Search Results */}
|
|
<div id="__primerPortalRoot__" className={cx(styles.portalRoot)} />
|
|
</div>
|
|
)
|
|
}
|