Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Extract the filter menu submenu into a shared component (#6716)
Sanne de Vriesb7c6d81c06ee
diff --git a/assets/js/dashboard/nav-menu/filter-menu.tsx b/assets/js/dashboard/nav-menu/filter-menu.tsxindex cfffb73041..2ed6381d85 100644--- a/assets/js/dashboard/nav-menu/filter-menu.tsx+++ b/assets/js/dashboard/nav-menu/filter-menu.tsx@@ -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'@@ -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 (<>@@ -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,@@ -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@@ -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>)diff --git a/assets/js/dashboard/nav-menu/submenu.tsx b/assets/js/dashboard/nav-menu/submenu.tsxnew file mode 100644index 0000000000..a113430b6f--- /dev/null+++ b/assets/js/dashboard/nav-menu/submenu.tsx@@ -0,0 +1,220 @@+import React, {+ ComponentType,+ ReactNode,+ useCallback,+ useEffect,+ useId,+ useRef,+ useState+} from 'react'+import classNames from 'classnames'+import { usePopper } from 'react-popper'+import { ChevronLeftIcon, ChevronRightIcon } from '@heroicons/react/20/solid'+import { popover } from '../components/popover'+import { MenuSeparator } from './nav-menu-components'++export const submenuIconClassName = '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<K extends string> = {+ key: K+ anchor: HTMLElement+ besideMenu: boolean+}++export function useSubmenu<K extends string>() {+ const submenuId = useId()+ const [openSubmenu, setOpenSubmenu] = useState<OpenSubmenu<K> | null>(null)+ const [submenuElement, setSubmenuElement] = useState<HTMLDivElement | null>(+ null+ )++ 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])++ const openWith = useCallback(+ (key: K, anchor: HTMLElement) => {+ cancelScheduledClose()+ setOpenSubmenu({ key, anchor, besideMenu: isMdOrWider() })+ },+ [cancelScheduledClose]+ )++ const closeSubmenu = useCallback(() => setOpenSubmenu(null), [])++ 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]+ )++ return {+ submenuId,+ openKey: openSubmenu?.key ?? null,+ besideMenu: !!openSubmenu?.besideMenu,+ openWith,+ closeSubmenu,+ scheduleClose,+ handleEscape,+ panelProps: {+ ref: setSubmenuElement,+ style: styles.popper,+ ...attributes.popper,+ id: submenuId,+ onMouseEnter: cancelScheduledClose+ }+ }+}++type Submenu = ReturnType<typeof useSubmenu>++export const SubmenuRow = ({+ label,+ Icon,+ expanded,+ submenuId,+ onOpen+}: {+ label: string+ Icon: ComponentType<{ className?: string }>+ expanded: boolean+ submenuId: string+ onOpen: (anchor: HTMLElement) => void+}) => {+ const handleOpen = useCallback(+ (event: React.SyntheticEvent<HTMLButtonElement>) =>+ onOpen(event.currentTarget),+ [onOpen]+ )++ 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}+ >+ <Icon className={submenuIconClassName} />+ <span className={popover.items.classNames.label}>{label}</span>+ <ChevronRightIcon className={submenuIconClassName} />+ </button>+ )+}++/** The submenu that sits beside the menu. */+export const SubmenuPanel = ({+ submenu,+ label,+ testId,+ children+}: {+ submenu: Pick<Submenu, 'panelProps'>+ label: string+ testId?: string+ children: ReactNode+}) => (+ <div+ {...submenu.panelProps}+ role="group"+ aria-label={label}+ data-testid={testId}+ className={classNames(popover.panel.classNames.roundedSheet, 'z-20 w-72')}+ >+ {children}+ </div>+)++/** The submenu that replaces the menu on small screens. */+export const SubmenuInPlace = ({+ submenu,+ label,+ testId,+ children+}: {+ submenu: Pick<Submenu, 'submenuId' | 'closeSubmenu' | 'handleEscape'>+ label: string+ testId?: string+ children: ReactNode+}) => (+ <div className="flex flex-col gap-y-0.5" onKeyDown={submenu.handleEscape}>+ <button+ className={popover.items.classNames.iconRow}+ onClick={submenu.closeSubmenu}+ >+ <ChevronLeftIcon className={submenuIconClassName} />+ <span className={popover.items.classNames.label}>{label}</span>+ </button>+ <MenuSeparator />+ <div+ className="flex flex-col gap-y-0.5"+ id={submenu.submenuId}+ role="group"+ aria-label={label}+ data-testid={testId}+ >+ {children}+ </div>+ </div>+)