Skip to content

Extract the filter menu submenu into a shared component #6716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zoldar merged 3 commits into from
Oct 7, 2026
Merged

Extract the filter menu submenu into a shared component #6716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ce8139
Extract the filter menu submenu into a shared component
sanne-san Sep 25, 2026
5864348
Remove mouseleave trigger after rebase
zoldar Oct 7, 2026
7ee1057
Apply formatting
zoldar Oct 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
322 changes: 88 additions & 234 deletions assets/js/dashboard/nav-menu/filter-menu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,9 @@
import React, {
useCallback,
useEffect,
useId,
useMemo,
useRef,
useState
} from 'react'
import React, { useMemo, useRef } from 'react'
import { formattedFilters } from '../util/filters'
import { useSiteContext } from '../site-context'
import { filterRoute } from '../router'
import { FilterIcon } from '../components/icons'
import { Popover, Transition } from '@headlessui/react'
import { ChevronLeftIcon, ChevronRightIcon } from '@heroicons/react/20/solid'
import { usePopper } from 'react-popper'
import { popover, BlurMenuButtonOnEscape } from '../components/popover'
import classNames from 'classnames'
import { AppNavigationLink } from '../navigation/use-app-navigate'
Expand All @@ -28,120 +19,16 @@ import {
SEGMENTS_ROW
} from './filter-menu-rows'
import { MenuSeparator } from './nav-menu-components'

const iconClassName = 'size-4 shrink-0'

const SUBMENU_CLOSE_DELAY_MS = 150

const isMdOrWider = () => window.matchMedia('(min-width: 768px)').matches

/**
* `besideMenu` is measured when the submenu opens. If wide enough, the submenu
* sits beside the menu; on small screens it replaces the menu.
*/
type OpenSubmenu = {
key: FilterGroupKey
anchor: HTMLElement
besideMenu: boolean
}

const FilterMenuItems = ({
open,
closeDropdown
}: {
open: boolean
closeDropdown: () => void
}) => {
const site = useSiteContext()
const segments = useListableSegments()
import {
SubmenuInPlace,
SubmenuPanel,
SubmenuRow,
submenuIconClassName as iconClassName,
useSubmenu
} from './submenu'

const FilterMenuItems = ({ closeDropdown }: { closeDropdown: () => void }) => {
const buttonRef = useRef<HTMLButtonElement>(null)
const submenuId = useId()

const rows = useMemo(() => {
const filterRows = getFilterMenuRows(site)
return segments.visible ? [SEGMENTS_ROW, ...filterRows] : filterRows
}, [site, segments.visible])

const [openSubmenu, setOpenSubmenu] = useState<OpenSubmenu | null>(null)
const [submenuElement, setSubmenuElement] = useState<HTMLDivElement | null>(
null
)
const openRow = useMemo(
() =>
rows.find(
(row): row is FilterSubmenuRow =>
row.kind !== 'item' && row.key === openSubmenu?.key
) ?? null,
[rows, openSubmenu]
)
const besideMenu = !!openSubmenu?.besideMenu

const closeTimeout = useRef<ReturnType<typeof setTimeout>>()
const cancelScheduledClose = useCallback(() => {
if (closeTimeout.current) {
clearTimeout(closeTimeout.current)
closeTimeout.current = undefined
}
}, [])
const scheduleClose = useCallback(() => {
cancelScheduledClose()
closeTimeout.current = setTimeout(
() => setOpenSubmenu(null),
SUBMENU_CLOSE_DELAY_MS
)
}, [cancelScheduledClose])
useEffect(() => cancelScheduledClose, [cancelScheduledClose])

useEffect(() => {
if (!open) {
setOpenSubmenu(null)
}
}, [open])

const openWith = useCallback(
(key: FilterGroupKey, anchor: HTMLElement) => {
cancelScheduledClose()
setOpenSubmenu({ key, anchor, besideMenu: isMdOrWider() })
},
[cancelScheduledClose]
)

const closeSubmenuAndRefocus = useCallback(() => {
cancelScheduledClose()
openSubmenu?.anchor.focus()
setOpenSubmenu(null)
}, [cancelScheduledClose, openSubmenu])

/**
* The submenu opens on the right side by default, and flips to the
* left when the viewport doesn't have enough room.
*/
const { styles, attributes } = usePopper(
openSubmenu?.anchor ?? null,
submenuElement,
{
placement: 'right-start',
modifiers: [
{ name: 'offset', options: { offset: [-4, 0] } },
{ name: 'flip', options: { fallbackPlacements: ['left-start'] } },
{ name: 'preventOverflow', options: { padding: 8 } }
]
}
)

const handleEscape = useCallback(
(event: React.KeyboardEvent) => {
if (event.key === 'Escape' && openSubmenu) {
closeSubmenuAndRefocus()
event.stopPropagation()
}
},
[closeSubmenuAndRefocus, openSubmenu]
)

const submenuBody = openRow && (
<SubmenuBody row={openRow} closeDropdown={closeDropdown} />
)

return (
<>
Expand Down Expand Up @@ -175,76 +62,89 @@ const FilterMenuItems = ({
)}
data-testid="filtermenu"
>
{openRow && !besideMenu ? (
<div className="flex flex-col gap-y-0.5" onKeyDown={handleEscape}>
<button
className={popover.items.classNames.iconRow}
onClick={() => setOpenSubmenu(null)}
>
<ChevronLeftIcon className={iconClassName} />
<span className={popover.items.classNames.label}>
{openRow.label}
</span>
</button>
<MenuSeparator />
<div
className="flex flex-col gap-y-0.5"
id={submenuId}
role="group"
aria-label={openRow.label}
data-testid="filtermenu-submenu"
>
{submenuBody}
</div>
</div>
) : (
<div className="flex flex-col gap-y-0.5" onKeyDown={handleEscape}>
{rows.map((row) => (
<React.Fragment key={row.key}>
{row.kind === 'item' ? (
<ItemRow
row={row}
onPointerOrFocus={scheduleClose}
closeDropdown={closeDropdown}
/>
) : (
<>
<SubmenuRow
row={row}
expanded={openSubmenu?.key === row.key}
submenuId={submenuId}
onOpen={openWith}
/>
{openRow?.key === row.key && (
<div
ref={setSubmenuElement}
style={styles.popper}
{...attributes.popper}
id={submenuId}
role="group"
aria-label={openRow.label}
data-testid="filtermenu-submenu"
className={classNames(
popover.panel.classNames.roundedSheet,
'z-20 w-72'
)}
>
{submenuBody}
</div>
)}
</>
)}
{row.kind === 'segments' && <MenuSeparator />}
</React.Fragment>
))}
</div>
)}
<FilterMenuPanelContent closeDropdown={closeDropdown} />
</Popover.Panel>
</Transition>
</>
)
}

const FilterMenuPanelContent = ({
closeDropdown
}: {
closeDropdown: () => void
}) => {
const site = useSiteContext()
const segments = useListableSegments()
const submenu = useSubmenu<FilterGroupKey>()

const rows = useMemo(() => {
const filterRows = getFilterMenuRows(site)
return segments.visible ? [SEGMENTS_ROW, ...filterRows] : filterRows
}, [site, segments.visible])

const openRow = useMemo(
() =>
rows.find(
(row): row is FilterSubmenuRow =>
row.kind !== 'item' && row.key === submenu.openKey
) ?? null,
[rows, submenu.openKey]
)

const submenuBody = openRow && (
<SubmenuBody row={openRow} closeDropdown={closeDropdown} />
)

if (openRow && !submenu.besideMenu) {
return (
<SubmenuInPlace
submenu={submenu}
label={openRow.label}
testId="filtermenu-submenu"
>
{submenuBody}
</SubmenuInPlace>
)
}

return (
<div className="flex flex-col gap-y-0.5" onKeyDown={submenu.handleEscape}>
{rows.map((row) => (
<React.Fragment key={row.key}>
{row.kind === 'item' ? (
<ItemRow
row={row}
onPointerOrFocus={submenu.scheduleClose}
closeDropdown={closeDropdown}
/>
) : (
<>
<SubmenuRow
label={row.label}
Icon={row.Icon}
expanded={submenu.openKey === row.key}
submenuId={submenu.submenuId}
onOpen={(anchor) => submenu.openWith(row.key, anchor)}
/>
{openRow?.key === row.key && (
<SubmenuPanel
submenu={submenu}
label={openRow.label}
testId="filtermenu-submenu"
>
{submenuBody}
</SubmenuPanel>
)}
</>
)}
{row.kind === 'segments' && <MenuSeparator />}
</React.Fragment>
))}
</div>
)
}

const ItemRow = ({
row,
onPointerOrFocus,
Expand All @@ -268,52 +168,6 @@ const ItemRow = ({
</AppNavigationLink>
)

const SubmenuRow = ({
row,
expanded,
submenuId,
onOpen
}: {
row: FilterSubmenuRow
expanded: boolean
submenuId: string
onOpen: (key: FilterGroupKey, anchor: HTMLElement) => void
}) => {
const handleOpen = useCallback(
(event: React.SyntheticEvent<HTMLButtonElement>) =>
onOpen(row.key, event.currentTarget),
[onOpen, row.key]
)

const handleHoverOrFocus = useCallback(
(event: React.SyntheticEvent<HTMLButtonElement>) => {
if (isMdOrWider()) {
handleOpen(event)
}
},
[handleOpen]
)

return (
<button
className={classNames(
popover.items.classNames.iconRow,
popover.items.classNames.selectedOption
)}
data-selected={expanded}
aria-expanded={expanded}
aria-controls={expanded ? submenuId : undefined}
onClick={handleOpen}
onMouseEnter={handleHoverOrFocus}
onFocus={handleHoverOrFocus}
>
<row.Icon className={iconClassName} />
<span className={popover.items.classNames.label}>{row.label}</span>
<ChevronRightIcon className={iconClassName} />
</button>
)
}

const SubmenuBody = ({
row,
closeDropdown
Expand Down Expand Up @@ -346,6 +200,6 @@ const SubmenuBody = ({

export const FilterMenu = () => (
<Popover className="shrink-0 md:relative">
{({ open, close }) => <FilterMenuItems open={open} closeDropdown={close} />}
{({ close }) => <FilterMenuItems closeDropdown={close} />}
</Popover>
)
Loading
Loading