refactor(v2): various dropdown improvements #3585
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
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
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 |
|---|---|---|
|
|
@@ -5,13 +5,12 @@ | |
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import React, {useState, useRef, useEffect} from 'react'; | ||
| import clsx from 'clsx'; | ||
| import Link from '@docusaurus/Link'; | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import {useLocation} from '@docusaurus/router'; | ||
| import {isSamePath} from '../../utils'; | ||
| import type { | ||
| NavLinkProps, | ||
| DesktopOrMobileNavBarItemProps, | ||
|
|
@@ -67,21 +66,28 @@ function NavItemDesktop({ | |
| className, | ||
| ...props | ||
| }: DesktopOrMobileNavBarItemProps) { | ||
| const dropdownRef = useRef<HTMLDivElement>(null); | ||
| const dropdownMenuRef = useRef<HTMLUListElement>(null); | ||
| const [showDropdown, setShowDropdown] = useState(false); | ||
|
|
||
| useEffect(() => { | ||
| const handleClickOutside = (event) => { | ||
| if (!dropdownRef.current || dropdownRef.current.contains(event.target)) { | ||
| return; | ||
| } | ||
|
|
||
| setShowDropdown(false); | ||
| }; | ||
|
|
||
| document.addEventListener('mousedown', handleClickOutside); | ||
| document.addEventListener('touchstart', handleClickOutside); | ||
|
|
||
| return () => { | ||
| document.removeEventListener('mousedown', handleClickOutside); | ||
| document.removeEventListener('touchstart', handleClickOutside); | ||
| }; | ||
| }, [dropdownRef]); | ||
|
|
||
| const navLinkClassNames = (extraClassName?: string, isDropdownItem = false) => | ||
| clsx( | ||
| { | ||
|
|
@@ -97,11 +103,11 @@ function NavItemDesktop({ | |
|
|
||
| return ( | ||
| <div | ||
| ref={dropdownRef} | ||
| className={clsx('navbar__item', 'dropdown', 'dropdown--hoverable', { | ||
| 'dropdown--left': position === 'left', | ||
| 'dropdown--right': position === 'right', | ||
| 'dropdown--show': showDropdown, | ||
| })}> | ||
| <NavLink | ||
| className={navLinkClassNames(className)} | ||
|
|
@@ -110,27 +116,27 @@ function NavItemDesktop({ | |
| onKeyDown={(e) => { | ||
| if (e.key === 'Enter') { | ||
| e.preventDefault(); | ||
| setShowDropdown(!showDropdown); | ||
| } | ||
| }}> | ||
| {props.label} | ||
| </NavLink> | ||
| <ul ref={dropdownMenuRef} className="dropdown__menu"> | ||
| {items.map(({className: childItemClassName, ...childItemProps}, i) => ( | ||
| <li key={i}> | ||
| <NavLink | ||
| onKeyDown={(e) => { | ||
| if (i === items.length - 1 && e.key === 'Tab') { | ||
| e.preventDefault(); | ||
|
|
||
| setShowDropdown(false); | ||
|
|
||
| const nextNavbarItem = (dropdownRef.current as HTMLElement) | ||
| .nextElementSibling; | ||
|
|
||
| if (nextNavbarItem) { | ||
|
There was a problem hiding this comment. Wonder if it is possible to shorten this code down to one-line? const nextNavbarItem = (dropdownRef.current as HTMLElement).nextElementSibling;
if (nextNavbarItem) {
(nextNavbarItem as HTMLElement).focus();
}I have tried using optional chaining, but I ran into the type error. There was a problem hiding this comment. Afaik it's annoying but we can't do anything about the types not being the proper ones. The shortest is probably: ((dropDownRef.current as HTMLElement)
?.nextElementSibling as HTMLElement)?.focus();Not much better |
||
| (nextNavbarItem as HTMLElement).focus(); | ||
| } | ||
| } | ||
| }} | ||
| activeClassName="dropdown__link--active" | ||
|
|
@@ -146,16 +152,15 @@ function NavItemDesktop({ | |
|
|
||
| function NavItemMobile({ | ||
| items, | ||
| className, | ||
| position: _position, // Need to destructure position from props so that it doesn't get passed on. | ||
| ...props | ||
| }: DesktopOrMobileNavBarItemProps) { | ||
| const {pathname} = useLocation(); | ||
| const [collapsed, setCollapsed] = useState( | ||
| () => !items?.some((item) => isSamePath(item.to, pathname)) ?? true, | ||
| ); | ||
|
|
||
| const navLinkClassNames = (extraClassName?: string, isSubList = false) => | ||
| clsx( | ||
| 'menu__link', | ||
|
|
||
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
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
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.
don't like much making the code a bit more complex, but as it should reduce a bit the bundle size, let's do this.