MCPcopy
hub / github.com/github/docs / Header

Function Header

components/page-header/Header.tsx:30–337  ·  view source on GitHub ↗
()

Source from the content-addressed store, hash-verified

28import styles from './Header.module.scss'
29
30export const Header = () => {
31 const router = useRouter()
32 const { error } = useMainContext()
33 const { isHomepageVersion, currentProduct, currentProductTree, allVersions } = useMainContext()
34 const { currentVersion } = useVersion()
35 const { t } = useTranslation(['header'])
36 const isRestPage = currentProduct && currentProduct.id === 'rest'
37 const [isSearchOpen, setIsSearchOpen] = useState(false)
38 const [scroll, setScroll] = useState(false)
39 const { hasAccount } = useHasAccount()
40 const [isMenuOpen, setIsMenuOpen] = useState(false)
41 const openMenuOverlay = useCallback(() => setIsMenuOpen(true), [setIsMenuOpen])
42 const closeMenuOverlay = useCallback(() => setIsMenuOpen(false), [setIsMenuOpen])
43 const [isSidebarOpen, setIsSidebarOpen] = useState(false)
44 const openSidebar = useCallback(() => setIsSidebarOpen(true), [isSidebarOpen])
45 const closeSidebar = useCallback(() => setIsSidebarOpen(false), [isSidebarOpen])
46 const isMounted = useRef(false)
47 const menuButtonRef = useRef<HTMLButtonElement>(null)
48 const { asPath } = useRouter()
49 const isSearchResultsPage = router.route === '/search'
50 const signupCTAVisible =
51 hasAccount === false && // don't show if `null`
52 (currentVersion === DEFAULT_VERSION || currentVersion === 'enterprise-cloud@latest')
53 const productTitle = currentProductTree?.shortTitle || currentProductTree?.title
54 const [windowSize, setWindowSize] = useState(0)
55 const handleWindowResize = useCallback(() => {
56 setWindowSize(window.innerWidth)
57 }, [])
58
59 useEffect(() => {
60 function onScroll() {
61 setScroll(window.scrollY > 10)
62 }
63 window.addEventListener('scroll', onScroll)
64 return () => {
65 window.removeEventListener('scroll', onScroll)
66 }
67 }, [])
68
69 useEffect(() => {
70 const close = (e: { key: string }) => {
71 if (e.key === 'Escape') {
72 setIsSearchOpen(false)
73 }
74 }
75 window.addEventListener('keydown', close)
76 return () => window.removeEventListener('keydown', close)
77 }, [])
78
79 // For the UI in smaller browswer widths, and focus the picker menu button when the search
80 // input is closed.
81 useEffect(() => {
82 if (!isSearchOpen && isMounted.current && menuButtonRef.current) {
83 menuButtonRef.current.focus()
84 }
85
86 if (!isMounted.current) {
87 isMounted.current = true

Callers

nothing calls this directly

Calls 4

useMainContextFunction · 0.90
useVersionFunction · 0.90
useTranslationFunction · 0.90
useHasAccountFunction · 0.90

Tested by

no test coverage detected