@sanity/ui 3.3.2 → 3.3.4

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

@@ -1,276 +0,0 @@
-import {ThemeColorSchemeKey} from '@sanity/ui/theme'
-import {
-  cloneElement,
-  forwardRef,
-  useCallback,
-  useEffect,
-  useImperativeHandle,
-  useMemo,
-  useRef,
-  useState,
-} from 'react'
-
-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.JSX.Element
-  id: string
-  menu?: React.JSX.Element
-  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,
-  forwardedRef: React.ForwardedRef<HTMLButtonElement | null>,
-) {
-  const {
-    __unstable_disableRestoreFocusOnClose: disableRestoreFocusOnClose = false,
-    // oxlint-disable-next-line no-deprecated
-    boundaryElement: deprecated_boundaryElement,
-    button: buttonProp,
-    id,
-    menu: menuProp,
-    onClose,
-    onOpen,
-    // oxlint-disable-next-line no-deprecated
-    placement: deprecated_placement,
-    // oxlint-disable-next-line no-deprecated
-    popoverScheme: deprecated_popoverScheme,
-    // oxlint-disable-next-line no-deprecated
-    portal: deprecated_portal = true,
-    popover,
-    // oxlint-disable-next-line no-deprecated
-    popoverRadius: deprecated_popoverRadius,
-    // oxlint-disable-next-line no-deprecated
-    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: FocusEvent) => {
-      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: MenuProps = {
-    'aria-labelledby': id,
-    'onBlurCapture': handleBlur,
-    'onClickOutside': handleMenuClickOutside,
-    'onEscape': handleMenuEscape,
-    'onItemClick': handleItemClick,
-    'originElement': buttonElement,
-    registerElement,
-    shouldFocus,
-  }
-
-  const menu = menuProp && cloneElement(menuProp, menuProps)
-
-  const button = useMemo(
-    () =>
-      buttonProp &&
-      cloneElement(buttonProp, {
-        'data-ui': 'MenuButton',
-        id,
-        'onClick': handleButtonClick,
-        'onKeyDown': handleButtonKeyDown,
-        'onMouseDown': handleMouseDown,
-        'aria-haspopup': true,
-        'aria-expanded': open,
-        'ref': setButtonElement,
-        'selected': buttonProp.props.selected ?? open,
-      }),
-    [buttonProp, handleButtonClick, handleButtonKeyDown, handleMouseDown, id, open],
-  )
-
-  // Forward button ref to parent
-  useImperativeHandle<HTMLButtonElement | null, HTMLButtonElement | null>(
-    forwardedRef,
-    () => buttonElement,
-    [buttonElement],
-  )
-
-  const popoverProps: MenuButtonProps['popover'] = useMemo(
-    () => ({
-      // oxlint-disable-next-line no-deprecated
-      boundaryElement: deprecated_boundaryElement,
-      overflow: 'auto',
-      placement: deprecated_placement,
-      portal: deprecated_portal,
-      preventOverflow: deprecated_preventOverflow,
-      radius: deprecated_popoverRadius,
-      scheme: deprecated_popoverScheme,
-      // oxlint-disable-next-line no-useless-fallback-in-spread
-      ...(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>
-  )
-})
-MenuButton.displayName = 'ForwardRef(MenuButton)'

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

@@ -1,18 +0,0 @@
-import {createGlobalScopedContext} from '../../lib/createGlobalScopedContext'
-
-export interface MenuContextValue {
-  version: 2
-  activeElement: HTMLElement | null
-  mount: (element: HTMLElement | null, selected?: boolean) => () => void
-  onClickOutside?: (event: MouseEvent) => void
-  onEscape?: () => void
-  onItemClick?: () => void
-  onItemMouseEnter: (event: React.MouseEvent<HTMLElement>) => void
-  onItemMouseLeave: (event: React.MouseEvent<HTMLElement>) => void
-  registerElement?: (el: HTMLElement) => () => void
-}
-
-export const MenuContext = createGlobalScopedContext<MenuContextValue | null>(
-  '@sanity/ui/context/menu',
-  null,
-)

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

@@ -1,24 +0,0 @@
-import {styled} from 'styled-components'
-
-import {ElementType, EmptyProps, Props} from '../../types'
-
-const StyledMenuDivider = styled.hr`
-  height: 1px;
-  border: 0;
-  background: var(--card-hairline-soft-color);
-  margin: 0;
-`
-StyledMenuDivider.displayName = 'MenuDivider'
-
-/**
- * @public
- */
-export type MenuDividerProps<E extends ElementType = 'hr'> = Props<EmptyProps, E>
-
-/**
- * @public
- */
-// oxlint-disable-next-line no-unsafe-type-assertion
-export const MenuDivider = StyledMenuDivider as unknown as <E extends ElementType = 'hr'>(
-  props: MenuDividerProps<E>,
-) => React.JSX.Element

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

@@ -1,66 +0,0 @@
-/** @vitest-environment jsdom */
-
-import {beforeEach, describe, expect, it, vi} from 'vitest'
-
-import {render} from '../../../../test'
-import {Flex} from '../../primitives'
-import {MenuContext, MenuContextValue} from './menuContext'
-import {MenuGroup} from './menuGroup'
-import {MenuItem} from './menuItem'
-
-vi.mock('../../primitives', async (importOriginal) => {
-  const actual = await importOriginal<typeof import('../../primitives')>()
-
-  return {
-    ...actual,
-    // oxlint-disable-next-line no-unsafe-type-assertion
-    Flex: vi.fn((props: Record<string, unknown>) => (actual.Flex as any).render(props, null)),
-    Popover: vi.fn(({children}: {children?: React.ReactNode}) => children),
-  }
-})
-
-const menuContextValue: MenuContextValue = {
-  version: 2,
-  activeElement: null,
-  mount: () => () => undefined,
-  onItemMouseEnter: () => undefined,
-  onItemMouseLeave: () => undefined,
-}
-
-function renderMenuGroup(props: Partial<React.ComponentProps<typeof MenuGroup>> = {}) {
-  return render(
-    <MenuContext.Provider value={menuContextValue}>
-      <MenuGroup id="menu-group" text="Menu group" {...props}>
-        <MenuItem id="submenu-item" text="Submenu item" />
-      </MenuGroup>
-    </MenuContext.Provider>,
-  )
-}
-
-describe('components/menuGroup spacing', () => {
-  const mockedFlex = vi.mocked(Flex)
-
-  beforeEach(() => {
-    mockedFlex.mockClear()
-  })
-
-  it('should support `space` and `gap` with the same behavior', () => {
-    renderMenuGroup({space: 2})
-    expect(mockedFlex.mock.calls.map(([props]) => props)).toContainEqual(
-      expect.objectContaining({gap: 2}),
-    )
-
-    mockedFlex.mockClear()
-    renderMenuGroup({gap: 2})
-    expect(mockedFlex.mock.calls.map(([props]) => props)).toContainEqual(
-      expect.objectContaining({gap: 2}),
-    )
-  })
-
-  it('should prefer `gap` over `space` when both are provided', () => {
-    renderMenuGroup({gap: 3, space: 1})
-    const propsList = mockedFlex.mock.calls.map(([props]) => props)
-    expect(propsList).toContainEqual(expect.objectContaining({gap: 3}))
-    expect(propsList).not.toContainEqual(expect.objectContaining({gap: 1}))
-  })
-})

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

@@ -1,237 +0,0 @@
-import {ChevronRightIcon} from '@sanity/icons'
-import {isValidElement, useCallback, useEffect, useState} from 'react'
-import {isValidElementType} from 'react-is'
-
-import {Box, Flex, Popover, PopoverProps, Text} from '../../primitives'
-import {Selectable} from '../../primitives/_selectable'
-import {_getArrayProp} from '../../styles'
-import {useRootTheme} from '../../theme'
-import {ElementType, Props, Radius, SelectableTone} from '../../types'
-import {Menu, MenuProps} from './menu'
-import {useMenu} from './useMenu'
-
-/**
- * @public
- */
-export interface MenuGroupOwnProps {
-  fontSize?: number | number[]
-  // oxlint-disable-next-line no-redundant-type-constituents
-  icon?: React.ElementType | React.ReactNode
-  menu?: Omit<
-    MenuProps,
-    | 'onClickOutside'
-    | 'onEscape'
-    | 'onItemClick'
-    | 'onKeyDown'
-    | 'onMouseEnter'
-    | 'registerElement'
-    | 'shouldFocus'
-    | 'onBlurCapture'
-  >
-  padding?: number | number[]
-  popover?: Omit<PopoverProps, 'content' | 'open'>
-  radius?: Radius | Radius[]
-  gap?: number | number[]
-  /**
-   * @deprecated Use `gap` instead. `space` will be removed in v4.
-   */
-  space?: number | number[]
-  text: React.ReactNode
-  tone?: SelectableTone
-}
-
-/**
- * @public
- */
-export type MenuGroupProps<E extends ElementType = 'button'> = Props<MenuGroupOwnProps, E>
-
-function MenuGroupComponent(
-  props: Omit<React.HTMLProps<HTMLDivElement>, 'as' | 'height' | 'popover' | 'ref' | 'tabIndex'> &
-    MenuGroupOwnProps & {as?: ElementType},
-): React.JSX.Element {
-  const {
-    as = 'button',
-    children,
-    fontSize = 1,
-    icon: IconComponent,
-    menu: menuProps,
-    onClick,
-    padding = 3,
-    popover,
-    radius = 2,
-    gap,
-    // oxlint-disable-next-line no-deprecated
-    space: deprecated_space = 3,
-    text,
-    tone = 'default',
-    ...restProps
-  } = props
-  const spacing = gap === undefined ? deprecated_space : gap
-  const menu = useMenu()
-  const {scheme} = useRootTheme()
-  const {
-    activeElement,
-    mount,
-    onClickOutside,
-    onEscape,
-    onItemClick,
-    onItemMouseEnter: _onItemMouseEnter,
-    registerElement,
-  } = menu
-  const onItemMouseEnter = _onItemMouseEnter ?? menu.onItemMouseEnter
-  const [rootElement, setRootElement] = useState<HTMLButtonElement | HTMLDivElement | null>(null)
-  const [open, setOpen] = useState(false)
-  const [shouldFocus, setShouldFocus] = useState<'first' | 'last' | null>(null)
-  const active = Boolean(activeElement) && activeElement === rootElement
-  const [withinMenu, setWithinMenu] = useState(false)
-
-  const handleMouseEnter = useCallback(
-    (event: React.MouseEvent<HTMLElement>) => {
-      setWithinMenu(false)
-      onItemMouseEnter(event)
-      setOpen(true)
-    },
-    [onItemMouseEnter],
-  )
-
-  const handleMenuKeyDown = useCallback(
-    (event: React.KeyboardEvent<HTMLDivElement>) => {
-      if (event.key === 'ArrowLeft') {
-        event.stopPropagation()
-
-        setOpen(false)
-
-        requestAnimationFrame(() => {
-          rootElement?.focus()
-        })
-      }
-    },
-    [rootElement],
-  )
-
-  const handleClick = useCallback(
-    (event: React.MouseEvent<HTMLDivElement>) => {
-      onClick?.(event)
-
-      setShouldFocus('first')
-      setOpen(true)
-    },
-    [onClick],
-  )
-
-  const handleChildItemClick = useCallback(() => {
-    setOpen(false)
-    onItemClick?.()
-  }, [onItemClick])
-
-  const handleMenuMouseEnter = useCallback(() => setWithinMenu(true), [])
-
-  // Register the menu item element
-  useEffect(() => mount(rootElement), [mount, rootElement])
-
-  // Close child menu when a sibling item becomes active
-  useEffect(() => {
-    // oxlint-disable-next-line react-compiler
-    if (!active) setOpen(false)
-  }, [active])
-
-  // Update state when child menu is no longer open
-  useEffect(() => {
-    // oxlint-disable-next-line react-compiler
-    if (!open) setWithinMenu(false)
-  }, [open])
-
-  // Reset the shouldFocus state after it has been used
-  useEffect(() => {
-    if (!shouldFocus) return
-    // The useMenuController effect that handles `shouldFocus` schedules a request animation frame where it's processed.
-    // By doing the same here, we ensure that the reset is processed after the focus change.
-    const rafId = requestAnimationFrame(() => setShouldFocus(null))
-
-    // oxlint-disable-next-line consistent-return
-    return () => cancelAnimationFrame(rafId)
-  }, [shouldFocus])
-
-  const childMenu = (
-    <Menu
-      {...menuProps}
-      onClickOutside={onClickOutside}
-      onEscape={onEscape}
-      onItemClick={handleChildItemClick}
-      onKeyDown={handleMenuKeyDown}
-      onMouseEnter={handleMenuMouseEnter}
-      registerElement={registerElement}
-      shouldFocus={shouldFocus}
-    >
-      {children}
-    </Menu>
-  )
-
-  const handleKeyDown = useCallback((event: React.KeyboardEvent<HTMLDivElement>) => {
-    const target = event.currentTarget
-
-    if (document.activeElement !== target) {
-      return
-    }
-
-    if (event.key === 'ArrowRight') {
-      setShouldFocus('first')
-      setOpen(true)
-      setWithinMenu(true)
-
-      return
-    }
-  }, [])
-
-  return (
-    <Popover {...popover} content={childMenu} data-ui="MenuGroup__popover" open={open}>
-      <Selectable
-        data-as={as}
-        data-ui="MenuGroup"
-        forwardedAs={as}
-        {...restProps}
-        aria-pressed={as === 'button' ? withinMenu : undefined}
-        data-pressed={as !== 'button' ? withinMenu : undefined}
-        data-selected={!withinMenu && active ? '' : undefined}
-        $radius={_getArrayProp(radius)}
-        $tone={tone}
-        $scheme={scheme}
-        onClick={handleClick}
-        onKeyDown={handleKeyDown}
-        onMouseEnter={handleMouseEnter}
-        ref={setRootElement}
-        tabIndex={-1}
-        type={as === 'button' ? 'button' : undefined}
-      >
-        <Flex gap={spacing} padding={padding}>
-          {IconComponent && (
-            <Text size={fontSize}>
-              {isValidElement(IconComponent) && IconComponent}
-              {isValidElementType(IconComponent) && <IconComponent />}
-            </Text>
-          )}
-
-          <Box flex={1}>
-            <Text size={fontSize} textOverflow="ellipsis" weight="medium">
-              {text}
-            </Text>
-          </Box>
-
-          <Text size={fontSize}>
-            <ChevronRightIcon />
-          </Text>
-        </Flex>
-      </Selectable>
-    </Popover>
-  )
-}
-
-MenuGroupComponent.displayName = 'MenuGroup'
-
-/**
- * @public
- */
-// oxlint-disable-next-line no-unsafe-type-assertion
-export const MenuGroup = MenuGroupComponent as unknown as <E extends ElementType = 'button'>(
-  props: MenuGroupProps<E>,
-) => React.JSX.Element

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

@@ -1,62 +0,0 @@
-/** @vitest-environment jsdom */
-
-import {beforeEach, describe, expect, it, vi} from 'vitest'
-
-import {render} from '../../../../test'
-import {Flex} from '../../primitives'
-import {MenuContext, MenuContextValue} from './menuContext'
-import {MenuItem} from './menuItem'
-
-vi.mock('../../primitives', async (importOriginal) => {
-  const actual = await importOriginal<typeof import('../../primitives')>()
-
-  return {
-    ...actual,
-    // oxlint-disable-next-line no-unsafe-type-assertion
-    Flex: vi.fn((props: Record<string, unknown>) => (actual.Flex as any).render(props, null)),
-  }
-})
-
-const menuContextValue: MenuContextValue = {
-  version: 2,
-  activeElement: null,
-  mount: () => () => undefined,
-  onItemMouseEnter: () => undefined,
-  onItemMouseLeave: () => undefined,
-}
-
-function renderMenuItem(props: Partial<React.ComponentProps<typeof MenuItem>> = {}) {
-  return render(
-    <MenuContext.Provider value={menuContextValue}>
-      <MenuItem id="menu-item" text="Menu item" {...props} />
-    </MenuContext.Provider>,
-  )
-}
-
-describe('components/menuItem spacing', () => {
-  const mockedFlex = vi.mocked(Flex)
-
-  beforeEach(() => {
-    mockedFlex.mockClear()
-  })
-
-  it('should support `space` and `gap` with the same behavior', () => {
-    renderMenuItem({space: 2})
-    expect(mockedFlex.mock.calls.map(([props]) => props)).toContainEqual(
-      expect.objectContaining({gap: 2}),
-    )
-
-    mockedFlex.mockClear()
-    renderMenuItem({gap: 2})
-    expect(mockedFlex.mock.calls.map(([props]) => props)).toContainEqual(
-      expect.objectContaining({gap: 2}),
-    )
-  })
-
-  it('should prefer `gap` over `space` when both are provided', () => {
-    renderMenuItem({gap: 3, space: 1})
-    const propsList = mockedFlex.mock.calls.map(([props]) => props)
-    expect(propsList).toContainEqual(expect.objectContaining({gap: 3}))
-    expect(propsList).not.toContainEqual(expect.objectContaining({gap: 1}))
-  })
-})