@sanity/ui 3.0.0-static.3 → 3.0.0-static.30

package/src/core/components/menu/helpers.ts

@@ -0,0 +1,82 @@
+import {isHTMLAnchorElement, isHTMLButtonElement} from '../../helpers/element'
+
+/**
+ * @internal
+ */
+function _isFocusable(element: HTMLElement) {
+  return (
+    (isHTMLAnchorElement(element) && element.getAttribute('data-disabled') !== 'true') ||
+    (isHTMLButtonElement(element) && !element.disabled)
+  )
+}
+
+/**
+ * @internal
+ */
+export function _getFocusableElements(elements: HTMLElement[]): HTMLElement[] {
+  return elements.filter(_isFocusable)
+}
+
+/**
+ * @internal
+ */
+export function _getDOMPath(rootElement: HTMLElement, el: HTMLElement): number[] {
+  const path: number[] = []
+
+  let e = el
+
+  while (e !== rootElement) {
+    const parentElement = e.parentElement
+
+    if (!parentElement) return path
+
+    const children = Array.from(parentElement.childNodes)
+    const index = children.indexOf(e)
+
+    path.unshift(index)
+
+    if (parentElement === rootElement) {
+      return path
+    }
+
+    e = parentElement
+  }
+
+  return path
+}
+
+const EMPTY_PATH: number[] = []
+
+/**
+ * @internal
+ */
+export function _sortElements(rootElement: HTMLElement | null, elements: HTMLElement[]): void {
+  if (!rootElement) return
+
+  const map = new WeakMap<HTMLElement, number[]>()
+
+  for (const el of elements) {
+    map.set(el, _getDOMPath(rootElement, el))
+  }
+
+  const _sort = (a: HTMLElement, b: HTMLElement) => {
+    const _a = map.get(a) || EMPTY_PATH
+    const _b = map.get(b) || EMPTY_PATH
+
+    const len = Math.max(_a.length, _b.length)
+
+    // Loop until there are different indexes
+    for (let i = 0; i < len; i += 1) {
+      const aIndex = _a[i] || -1
+      const bIndex = _b[i] || -1
+
+      if (aIndex !== bIndex) {
+        return aIndex - bIndex
+      }
+    }
+
+    return 0
+  }
+
+  elements.sort(_sort)
+}

package/src/core/components/menu/menu.test.tsx

@@ -0,0 +1,127 @@
+/* eslint-disable no-console */
+
+import {type MouseEvent, useCallback, useMemo} from 'react'
+import {describe, expect, it, vi} from 'vitest'
+
+import {render} from '../../../../test'
+import {MenuContext, type MenuContextValue} from './menuContext'
+import {useMenu} from './useMenu'
+
+describe('components/menu', () => {
+  describe('useMenu', () => {
+    it('should get context value', async () => {
+      const log = vi.fn()
+
+      function Debug() {
+        const rootMenu = useMenu()
+
+        log(rootMenu)
+
+        return <>debug</>
+      }
+
+      function Root() {
+        const handleItemMouseEnter = useCallback(
+          (event: MouseEvent<HTMLElement>) => console.log(event),
+          [],
+        )
+
+        const handleItemMouseLeave = useCallback(
+          (event: MouseEvent<HTMLElement>) => console.log(event),
+          [],
+        )
+
+        const value: MenuContextValue = useMemo(
+          () => ({
+            version: 0.0,
+            activeElement: null,
+            activeIndex: 0,
+            mount: (element: HTMLElement | null) => () => console.log(element),
+            onItemClick: () => undefined,
+            onItemMouseEnter: handleItemMouseEnter,
+            onItemMouseLeave: handleItemMouseLeave,
+            onMouseEnter: handleItemMouseEnter,
+            onMouseLeave: handleItemMouseLeave,
+          }),
+          [handleItemMouseEnter, handleItemMouseLeave],
+        )
+
+        return (
+          <MenuContext.Provider value={value}>
+            <Debug />
+          </MenuContext.Provider>
+        )
+      }
+
+      render(<Root />)
+
+      const contextValue = log.mock.calls[0][0]
+
+      expect(contextValue.version).toBe(0.0)
+      expect(contextValue.activeIndex).toBe(0)
+      expect(typeof contextValue.mount).toBe('function')
+      expect(typeof contextValue.onItemClick).toBe('function')
+      expect(typeof contextValue.onItemMouseEnter).toBe('function')
+      expect(typeof contextValue.onItemMouseEnter).toBe('function')
+    })
+
+    it('should fail when no context value is provided', async () => {
+      const log = vi.fn()
+
+      function Debug() {
+        try {
+          useMenu()
+        } catch (err) {
+          log(err)
+        }
+
+        return null
+      }
+
+      function Root() {
+        const value: any = undefined
+
+        return (
+          <MenuContext.Provider value={value}>
+            <Debug />
+          </MenuContext.Provider>
+        )
+      }
+
+      render(<Root />)
+
+      expect(log.mock.calls[0][0].message).toEqual('useMenu(): missing context value')
+    })
+
+    it('should fail when context value is not compatible', async () => {
+      const log = vi.fn()
+
+      function Debug() {
+        try {
+          useMenu()
+        } catch (err) {
+          log(err)
+        }
+
+        return null
+      }
+
+      function Root() {
+        // NOTE: we’re testing this because the context value may be a function in the future
+        const value: any = () => {
+          return {version: 1}
+        }
+
+        return (
+          <MenuContext.Provider value={value}>
+            <Debug />
+          </MenuContext.Provider>
+        )
+      }
+
+      render(<Root />)
+
+      expect(log.mock.calls[0][0].message).toEqual('useMenu(): the context value is not compatible')
+    })
+  })
+})

package/src/core/components/menu/menu.tsx

@@ -0,0 +1,194 @@
+import {menu, type PaddingStyleProps, type ResponsiveProp} from '@sanity/ui/css'
+import type {Space} from '@sanity/ui/theme'
+import {useCallback, useEffect, useImperativeHandle, useMemo, useRef} from 'react'
+
+import {useClickOutsideEvent} from '../../hooks/useClickOutsideEvent'
+import {useGlobalKeyDown} from '../../hooks/useGlobalKeyDown'
+import {Box} from '../../primitives/box/box'
+import {useLayer} from '../../primitives/layer/useLayer'
+import {Stack} from '../../primitives/stack/stack'
+import type {ComponentType, Props} from '../../types/props'
+import {MenuContext, type MenuContextValue} from './menuContext'
+import {useMenuController} from './useMenuController'
+
+/** @public */
+export const DEFAULT_MENU_ELEMENT = 'div'
+
+/** @public */
+export type MenuOwnProps = PaddingStyleProps & {
+  /**
+   * @deprecated Use `shouldFocus="first"` instead.
+   */
+  'focusFirst'?: boolean
+  /**
+   * @deprecated Use `shouldFocus="last"` instead.
+   */
+  'focusLast'?: boolean
+  'gap'?: ResponsiveProp<Space>
+  'onClickOutside'?: (event: MouseEvent) => void
+  'onEscape'?: () => void
+  'onItemClick'?: () => void
+  'onItemSelect'?: (index: number) => void
+  'originElement'?: HTMLElement | null
+  'registerElement'?: (el: HTMLElement) => () => void
+  'shouldFocus'?: 'first' | 'last' | null
+  /** @deprecated Use `gap` property instead. */
+  'space'?: ResponsiveProp<Space>
+  'aria-labelledby'?: string
+  // 'onBlurCapture'?: (event: FocusEvent) => void
+}
+
+/** @public */
+export type MenuElementType = 'div' | 'span' | ComponentType
+
+/** @public */
+export type MenuProps<E extends MenuElementType = MenuElementType> = Props<MenuOwnProps, E>
+
+/**
+ * The `Menu` component is a building block for application menus.
+ *
+ * @public
+ */
+export function Menu<E extends MenuElementType = typeof DEFAULT_MENU_ELEMENT>(props: MenuProps<E>) {
+  const {
+    as = DEFAULT_MENU_ELEMENT,
+    children,
+    className,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    focusFirst,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    focusLast,
+    gap,
+    onClickOutside,
+    onEscape,
+    onItemClick,
+    onItemSelect,
+    onKeyDown,
+    originElement,
+    padding = 1,
+    ref: forwardedRef,
+    registerElement,
+    shouldFocus: _shouldFocus,
+    space = 1,
+    ...rest
+  } = props as MenuProps<typeof DEFAULT_MENU_ELEMENT>
+
+  const shouldFocus =
+    _shouldFocus ?? ((props.focusFirst && 'first') || (props.focusLast && 'last') || null)
+
+  const ref = useRef<HTMLDivElement | null>(null)
+
+  useImperativeHandle<HTMLDivElement | null, HTMLDivElement | null>(forwardedRef, () => ref.current)
+
+  const {isTopLayer} = useLayer()
+
+  const {
+    activeElement,
+    activeIndex,
+    handleItemMouseEnter,
+    handleItemMouseLeave,
+    handleKeyDown,
+    mount,
+  } = useMenuController({
+    onKeyDown,
+    originElement,
+    shouldFocus,
+    rootElementRef: ref,
+  })
+
+  const unregisterElementRef = useRef<(() => void) | null>(null)
+  const handleRefChange = useCallback(
+    (el: HTMLDivElement | null) => {
+      // Run cleanup of previously registered elements
+      if (unregisterElementRef.current) {
+        // The `registerElement` callback were originally used in a `useEffect`, so it returns a cleanup function that is a bit gnarly to handle in a ref callback.
+        // Since we can't change the `registerElement` implementation itself without making breaking change,
+        // that is explained in the code comments for createGlobalScopedContext.tsx,
+        // we need to handle with a ref that holds on to the cleanup function last returned when the ref callback is called.
+        unregisterElementRef.current()
+        unregisterElementRef.current = null
+      }
+
+      ref.current = el
+
+      // Register root element (for nested menus)
+      if (ref.current && registerElement) {
+        unregisterElementRef.current = registerElement(ref.current)
+      }
+    },
+    [registerElement],
+  )
+
+  // Trigger `onItemSelect` when active index changes
+  useEffect(() => {
+    if (onItemSelect) onItemSelect(activeIndex)
+  }, [activeIndex, onItemSelect])
+
+  // Close menu when clicking outside
+  useClickOutsideEvent(isTopLayer && onClickOutside, () => [ref.current])
+
+  // Close menu when pressing Escape
+  useGlobalKeyDown(
+    useCallback(
+      (event) => {
+        if (!isTopLayer) return
+
+        if (event.key === 'Escape') {
+          event.stopPropagation()
+          if (onEscape) onEscape()
+        }
+      },
+      [isTopLayer, onEscape],
+    ),
+  )
+
+  const value: MenuContextValue = useMemo(
+    () => ({
+      version: 0.0,
+      activeElement,
+      activeIndex,
+      mount,
+      onClickOutside,
+      onEscape,
+      onItemClick,
+      onItemMouseEnter: handleItemMouseEnter,
+      onItemMouseLeave: handleItemMouseLeave,
+      registerElement,
+
+      // deprecated
+      onMouseEnter: handleItemMouseEnter,
+      onMouseLeave: handleItemMouseLeave,
+    }),
+    [
+      activeElement,
+      activeIndex,
+      mount,
+      handleItemMouseEnter,
+      handleItemMouseLeave,
+      onClickOutside,
+      onEscape,
+      onItemClick,
+      registerElement,
+    ],
+  )
+
+  return (
+    <MenuContext.Provider value={value}>
+      <Box
+        data-ui="Menu"
+        {...rest}
+        as={as}
+        className={menu({className})}
+        onKeyDown={handleKeyDown}
+        overflow="auto"
+        outline="none"
+        padding={padding}
+        ref={handleRefChange}
+        role="menu"
+        tabIndex={-1}
+      >
+        <Stack gap={gap ?? space}>{children}</Stack>
+      </Box>
+    </MenuContext.Provider>
+  )
+}

package/src/core/components/menu/menuButton.tsx

@@ -0,0 +1,271 @@
+import type {Radius, ThemeColorSchemeKey} from '@sanity/ui/theme'
+import {
+  cloneElement,
+  type FocusEvent,
+  type ForwardedRef,
+  type KeyboardEvent,
+  type MouseEvent as ReactMouseEvent,
+  type ReactElement,
+  useCallback,
+  useEffect,
+  useImperativeHandle,
+  useMemo,
+  useRef,
+  useState,
+} from 'react'
+
+import type {ButtonProps} from '../../primitives/button/button'
+import {Popover, type PopoverProps} from '../../primitives/popover/popover'
+import type {Placement} from '../../types/placement'
+import type {Props} from '../../types/props'
+import type {MenuProps} from './menu'
+
+/** @public */
+export type MenuButtonProps = {
+  /**
+   * @beta Do not use in production.
+   */
+  __unstable_disableRestoreFocusOnClose?: boolean
+  /**
+   * @deprecated Use `popover={{boundaryElement: element}}` instead.
+   */
+  boundaryElement?: HTMLElement
+  button: ReactElement<ButtonProps>
+  id: string
+  menu?: ReactElement
+  onClose?: () => void
+  onOpen?: () => void
+  /**
+   * @deprecated Use `popover={{placement: 'top'}}` instead.
+   */
+  placement?: Placement
+  popover?: Omit<PopoverProps, 'content' | 'open'>
+  /**
+   * @deprecated Use `popover={{scheme: 'dark'}}` instead.
+   */
+  popoverScheme?: ThemeColorSchemeKey
+  /**
+   * @deprecated Use `popover={{radius: 2}}` instead.
+   */
+  popoverRadius?: Radius | Radius[]
+  /**
+   * @beta Do not use in production.
+   * @deprecated Use `popover={{portal: true}}` instead.
+   */
+  portal?: boolean
+  /**
+   * @deprecated Use `popover={{preventOverflow: true}}` instead.
+   */
+  preventOverflow?: boolean
+  ref?: ForwardedRef<HTMLButtonElement | null>
+}
+
+/**
+ * The `MenuButton` component follows the WAI-ARIA specification for menu buttons.
+ *
+ * @public
+ */
+export function MenuButton(props: MenuButtonProps) {
+  const {
+    __unstable_disableRestoreFocusOnClose: disableRestoreFocusOnClose = false,
+    boundaryElement: deprecated_boundaryElement,
+    button: buttonProp,
+    id,
+    menu: menuProp,
+    onClose,
+    onOpen,
+    placement: deprecated_placement,
+    popoverScheme: deprecated_popoverScheme,
+    portal: deprecated_portal = true,
+    popover,
+    popoverRadius: deprecated_popoverRadius,
+    preventOverflow: deprecated_preventOverflow,
+    ref: forwardedRef,
+  } = props
+  const [open, setOpen] = useState(false)
+  const [shouldFocus, setShouldFocus] = useState<'first' | 'last' | null>(null)
+  const [buttonElement, setButtonElement] = useState<HTMLButtonElement | null>(null)
+  const [menuElements, setChildMenuElements] = useState<HTMLElement[]>([])
+  const openRef = useRef<boolean>(open)
+
+  // Notify consumers when the menu opens
+  useEffect(() => {
+    if (onOpen && open && !openRef.current) {
+      onOpen()
+    }
+  }, [onOpen, open])
+
+  // Notify consumers when the menu closes
+  useEffect(() => {
+    if (onClose && !open && openRef.current) {
+      onClose()
+    }
+  }, [onClose, open])
+
+  useEffect(() => {
+    openRef.current = open
+  }, [open])
+
+  const handleButtonClick = useCallback(() => {
+    setOpen((v) => !v)
+    setShouldFocus(null)
+  }, [])
+
+  // Prevent mouse event propagation when the menu is open.
+  // This is to ensure that `handleBlur` isn't triggered when clicking the menu button whilst open,
+  // which can lead to `setOpen` being triggered multiple times (once by `handleBlur`, and again by `handleButtonClick`).
+  const handleMouseDown = useCallback(
+    (event: ReactMouseEvent<HTMLElement>) => {
+      if (open) event.preventDefault()
+    },
+    [open],
+  )
+
+  const handleButtonKeyDown = useCallback((event: KeyboardEvent<HTMLButtonElement>) => {
+    // On `ArrowDown`, `Enter` and `Space`
+    // - Opens menu and moves focus to first menuitem
+    if (event.key === 'ArrowDown' || event.key === 'Enter' || event.key === ' ') {
+      event.preventDefault()
+      setOpen(true)
+      setShouldFocus('first')
+
+      return
+    }
+
+    // On `ArrowUp`
+    // - 	Opens menu and moves focus to last menuitem
+    if (event.key === 'ArrowUp') {
+      event.preventDefault()
+      setOpen(true)
+      setShouldFocus('last')
+
+      return
+    }
+  }, [])
+
+  const handleMenuClickOutside = useCallback(
+    (event: MouseEvent) => {
+      const target = event.target
+
+      if (!(target instanceof Node)) {
+        return
+      }
+
+      if (buttonElement && (target === buttonElement || buttonElement.contains(target))) {
+        return
+      }
+
+      for (const el of menuElements) {
+        if (target === el || el.contains(target)) {
+          return
+        }
+      }
+
+      setOpen(false)
+    },
+    [buttonElement, menuElements],
+  )
+
+  const handleMenuEscape = useCallback(() => {
+    setOpen(false)
+    if (disableRestoreFocusOnClose) return
+    if (buttonElement) buttonElement.focus()
+  }, [buttonElement, disableRestoreFocusOnClose])
+
+  const handleBlur = useCallback(
+    (event: FocusEvent<HTMLDivElement>) => {
+      const target = event.relatedTarget
+
+      if (!(target instanceof Node)) {
+        return
+      }
+
+      for (const el of menuElements) {
+        if (el === target || el.contains(target)) {
+          return
+        }
+      }
+
+      setOpen(false)
+    },
+    [menuElements],
+  )
+
+  const handleItemClick = useCallback(() => {
+    setOpen(false)
+    if (disableRestoreFocusOnClose) return
+    if (buttonElement) buttonElement.focus()
+  }, [buttonElement, disableRestoreFocusOnClose])
+
+  const registerElement = useCallback((el: HTMLElement) => {
+    setChildMenuElements((els) => els.concat([el]))
+
+    return () => setChildMenuElements((els) => els.filter((_el) => _el !== el))
+  }, [])
+
+  const menuProps: Props<MenuProps, 'div'> = {
+    'aria-labelledby': id,
+    'onBlurCapture': handleBlur,
+    'onClickOutside': handleMenuClickOutside,
+    'onEscape': handleMenuEscape,
+    'onItemClick': handleItemClick,
+    'originElement': buttonElement,
+    registerElement,
+    shouldFocus,
+  }
+
+  const menu = menuProp && cloneElement(menuProp, menuProps)
+
+  const button = useMemo(() => {
+    if (!buttonProp) return null
+
+    const buttonProps: ButtonProps<'button'> = {
+      'data-ui': 'MenuButton',
+      id,
+      'onClick': handleButtonClick,
+      'onKeyDown': handleButtonKeyDown,
+      'onMouseDown': handleMouseDown,
+      'aria-haspopup': true,
+      'aria-expanded': open,
+      'ref': setButtonElement,
+      'selected': buttonProp.props.selected ?? open,
+    }
+
+    return cloneElement(buttonProp, buttonProps)
+  }, [buttonProp, handleButtonClick, handleButtonKeyDown, handleMouseDown, id, open])
+
+  // Forward button ref to parent
+  useImperativeHandle<HTMLButtonElement | null, HTMLButtonElement | null>(
+    forwardedRef,
+    () => buttonElement,
+    [buttonElement],
+  )
+
+  const popoverProps: MenuButtonProps['popover'] = useMemo(
+    () => ({
+      boundaryElement: deprecated_boundaryElement,
+      overflow: 'auto',
+      placement: deprecated_placement,
+      portal: deprecated_portal,
+      preventOverflow: deprecated_preventOverflow,
+      radius: deprecated_popoverRadius,
+      scheme: deprecated_popoverScheme,
+      ...(popover || {}),
+    }),
+    [
+      deprecated_boundaryElement,
+      deprecated_placement,
+      deprecated_popoverRadius,
+      deprecated_popoverScheme,
+      deprecated_portal,
+      deprecated_preventOverflow,
+      popover,
+    ],
+  )
+
+  return (
+    <Popover data-ui="MenuButton__popover" {...popoverProps} content={menu} open={open}>
+      {button || <></>}
+    </Popover>
+  )
+}

package/src/core/components/menu/menuContext.ts

@@ -0,0 +1,31 @@
+import {type MouseEvent as ReactMouseEvent} from 'react'
+
+import {createGlobalScopedContext} from '../../lib/createGlobalScopedContext'
+
+export interface MenuContextValue {
+  version: 0.0
+  activeElement: HTMLElement | null
+  activeIndex: number
+  mount: (element: HTMLElement | null, selected?: boolean) => () => void
+  onClickOutside?: (event: MouseEvent) => void
+  onEscape?: () => void
+  onItemClick?: () => void
+  onItemMouseEnter?: (event: ReactMouseEvent<HTMLElement>) => void
+  onItemMouseLeave?: (event: ReactMouseEvent<HTMLElement>) => void
+  registerElement?: (el: HTMLElement) => () => void
+
+  /**
+   * @deprecated Use `onItemMouseEnter` instead
+   */
+  onMouseEnter: (event: ReactMouseEvent<HTMLElement>) => void
+
+  /**
+   * @deprecated Use `onItemMouseLeave` instead
+   */
+  onMouseLeave: (event: ReactMouseEvent<HTMLElement>) => void
+}
+
+export const MenuContext = createGlobalScopedContext<MenuContextValue | null>(
+  '@sanity/ui/context/menu',
+  null,
+)