@sanity/ui 2.0.0-alpha.9 → 2.0.0-beta.10

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

@@ -0,0 +1,129 @@
+/** @jest-environment jsdom */
+
+/* eslint-disable no-console */
+
+import React, {useCallback, useMemo} from 'react'
+import {render} from '../../../../test'
+import {MenuContext, MenuContextValue} from './menuContext'
+import {useMenu} from './useMenu'
+
+describe('components/menu', () => {
+  describe('useMenu', () => {
+    it('should get context value', async () => {
+      const log = jest.fn()
+
+      function Debug() {
+        const rootMenu = useMenu()
+
+        log(rootMenu)
+
+        return <>debug</>
+      }
+
+      function Root() {
+        const handleItemMouseEnter = useCallback(
+          (event: React.MouseEvent<HTMLElement>) => console.log(event),
+          [],
+        )
+
+        const handleItemMouseLeave = useCallback(
+          (event: React.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 = jest.fn()
+
+      function Debug() {
+        try {
+          useMenu()
+        } catch (err) {
+          log(err)
+        }
+
+        return null
+      }
+
+      function Root() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        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 = jest.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
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        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,169 @@
+import {forwardRef, useCallback, useEffect, useMemo} from 'react'
+import styled from 'styled-components'
+import {useClickOutside, useForwardedRef, useGlobalKeyDown} from '../../hooks'
+import {Box, Stack} from '../../primitives'
+import {ResponsivePaddingProps} from '../../primitives/types'
+import {useLayer} from '../../utils'
+import {MenuContext, MenuContextValue} from './menuContext'
+import {useMenuController} from './useMenuController'
+
+/**
+ * @public
+ */
+export interface MenuProps extends ResponsivePaddingProps {
+  /**
+   * @deprecated Use `shouldFocus="first"` instead.
+   */
+  focusFirst?: boolean
+  /**
+   * @deprecated Use `shouldFocus="last"` instead.
+   */
+  focusLast?: boolean
+  onClickOutside?: (event: MouseEvent) => void
+  onEscape?: () => void
+  onItemClick?: () => void
+  onItemSelect?: (index: number) => void
+  originElement?: HTMLElement | null
+  registerElement?: (el: HTMLElement) => () => void
+  shouldFocus?: 'first' | 'last' | null
+  space?: number | number[]
+}
+
+const Root = styled(Box)`
+  outline: none;
+  overflow: auto;
+`
+
+/**
+ * The `Menu` component is a building block for application menus.
+ *
+ * @public
+ */
+export const Menu = forwardRef(function Menu(
+  props: MenuProps & Omit<React.HTMLProps<HTMLDivElement>, 'as' | 'height' | 'role' | 'tabIndex'>,
+  ref: React.ForwardedRef<HTMLDivElement>,
+) {
+  const {
+    children,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    focusFirst,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    focusLast,
+    onClickOutside,
+    onEscape,
+    onItemClick,
+    onItemSelect,
+    onKeyDown,
+    originElement,
+    padding = 1,
+    registerElement,
+    shouldFocus = (props.focusFirst && 'first') || (props.focusLast && 'last') || null,
+    space = 1,
+    ...restProps
+  } = props
+
+  const forwardedRef = useForwardedRef(ref)
+
+  const {isTopLayer} = useLayer()
+
+  const {
+    activeElement,
+    activeIndex,
+    handleItemMouseEnter,
+    handleItemMouseLeave,
+    handleKeyDown,
+    mount,
+    rootElement,
+    setRootElement,
+  } = useMenuController({onKeyDown, originElement, shouldFocus})
+
+  const handleRefChange = useCallback(
+    (el: HTMLDivElement | null) => {
+      setRootElement(el)
+      forwardedRef.current = el
+    },
+    [forwardedRef, setRootElement],
+  )
+
+  // Trigger `onItemSelect` when active index changes
+  useEffect(() => {
+    if (onItemSelect) onItemSelect(activeIndex)
+  }, [activeIndex, onItemSelect])
+
+  // Close menu when clicking outside
+  useClickOutside(
+    useCallback(
+      (event) => isTopLayer && onClickOutside && onClickOutside(event),
+      [isTopLayer, onClickOutside],
+    ),
+    [rootElement],
+  )
+
+  // Close menu when pressing Escape
+  useGlobalKeyDown(
+    useCallback(
+      (event) => {
+        if (!isTopLayer) return
+
+        if (event.key === 'Escape') {
+          event.stopPropagation()
+          if (onEscape) onEscape()
+        }
+      },
+      [isTopLayer, onEscape],
+    ),
+  )
+
+  // Register root element (for nested menus)
+  useEffect(() => {
+    if (!rootElement || !registerElement) return
+
+    return registerElement(rootElement)
+  }, [registerElement, rootElement])
+
+  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}>
+      <Root
+        data-ui="Menu"
+        {...restProps}
+        onKeyDown={handleKeyDown}
+        padding={padding}
+        ref={handleRefChange}
+        role="menu"
+        tabIndex={-1}
+      >
+        <Stack space={space}>{children}</Stack>
+      </Root>
+    </MenuContext.Provider>
+  )
+})

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

@@ -0,0 +1,281 @@
+import {ThemeColorSchemeKey} from '@sanity/ui/theme'
+import {cloneElement, forwardRef, useCallback, useMemo, useState, useEffect, useRef} from 'react'
+import {isElement} from 'react-is'
+import {Popover, PopoverProps} from '../../primitives'
+import {Placement, Radius} from '../../types'
+import {MenuProps} from './menu'
+
+/**
+ * @public
+ */
+export interface MenuButtonProps {
+  /**
+   * @beta Do not use in production.
+   */
+  __unstable_disableRestoreFocusOnClose?: boolean
+  /**
+   * @deprecated Use `popover={{boundaryElement: element}}` instead.
+   */
+  boundaryElement?: HTMLElement
+  button: React.ReactElement
+  id: string
+  menu?: React.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
+}
+
+/**
+ * The `MenuButton` component follows the WAI-ARIA specification for menu buttons.
+ *
+ * @public
+ */
+export const MenuButton = forwardRef(function MenuButton(
+  props: MenuButtonProps,
+  ref: React.ForwardedRef<HTMLButtonElement | null>,
+) {
+  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,
+  } = 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: PointerEvent) => {
+      if (open) event.preventDefault()
+    },
+    [open],
+  )
+
+  const handleButtonKeyDown = useCallback((event: React.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: React.FocusEvent<HTMLButtonElement>) => {
+      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) => {
+        return els.filter((_el) => _el !== el)
+      })
+    }
+  }, [])
+
+  const menuProps: MenuProps = useMemo(
+    () => ({
+      'aria-labelledby': id,
+      onBlurCapture: handleBlur,
+      onClickOutside: handleMenuClickOutside,
+      onEscape: handleMenuEscape,
+      onItemClick: handleItemClick,
+      originElement: buttonElement,
+      registerElement,
+      shouldFocus,
+    }),
+    [
+      buttonElement,
+      handleMenuClickOutside,
+      handleMenuEscape,
+      handleItemClick,
+      id,
+      handleBlur,
+      registerElement,
+      shouldFocus,
+    ],
+  )
+
+  const menu = isElement(menuProp) ? cloneElement(menuProp, menuProps) : null
+
+  const setButtonRef = useCallback(
+    (el: HTMLButtonElement | null) => {
+      if (typeof ref === 'function') {
+        ref(el)
+      } else if (ref) {
+        ref.current = el
+      }
+
+      setButtonElement(el)
+    },
+    [ref],
+  )
+
+  const button = useMemo(
+    () =>
+      isElement(buttonProp)
+        ? cloneElement(buttonProp, {
+            'data-ui': 'MenuButton',
+            id,
+            onClick: handleButtonClick,
+            onKeyDown: handleButtonKeyDown,
+            onMouseDown: handleMouseDown,
+            'aria-haspopup': true,
+            'aria-expanded': open,
+            ref: setButtonRef,
+            selected: open,
+          })
+        : null,
+    [buttonProp, handleButtonClick, handleButtonKeyDown, handleMouseDown, id, open, setButtonRef],
+  )
+
+  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/menuDivider.ts

@@ -0,0 +1,11 @@
+import styled from 'styled-components'
+
+/**
+ * @public
+ */
+export const MenuDivider = styled.hr`
+  height: 1px;
+  border: 0;
+  background: var(--card-hairline-soft-color);
+  margin: 0;
+`