@sanity/ui 3.0.0-static.4 → 3.0.0-static.40

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

@@ -0,0 +1,225 @@
+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 {Props} from '../../types'
+import type {MenuProps} from './menu'
+
+/** @public */
+export type MenuButtonProps = {
+  /**
+   * @beta Do not use in production.
+   */
+  __unstable_disableRestoreFocusOnClose?: boolean
+  button: ReactElement<ButtonProps>
+  id: string
+  menu?: ReactElement
+  onClose?: () => void
+  onOpen?: () => void
+  popover?: Omit<PopoverProps, 'content' | 'open'>
+
+  ref?: ForwardedRef<HTMLButtonElement | null>
+}
+
+/**
+ * The `MenuButton` component follows the WAI-ARIA specification for menu buttons.
+ *
+ * @public
+ */
+export function MenuButton(props: MenuButtonProps): React.JSX.Element {
+  const {
+    __unstable_disableRestoreFocusOnClose: disableRestoreFocusOnClose = false,
+    button: buttonProp,
+    id,
+    menu: menuProp,
+    onClose,
+    onOpen,
+    popover,
+    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(
+    () => ({
+      overflow: 'auto',
+      ...(popover || {}),
+    }),
+    [popover],
+  )
+
+  return (
+    <Popover data-ui="MenuButton__popover" {...popoverProps} content={menu} open={open}>
+      {button || <></>}
+    </Popover>
+  )
+}

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

@@ -0,0 +1,19 @@
+import {type Context, 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
+}
+
+export const MenuContext: Context<MenuContextValue | null> =
+  createGlobalScopedContext<MenuContextValue | null>('@sanity/ui/v3/menu', null)

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

@@ -0,0 +1,32 @@
+import {menuDivider} from '@sanity/ui/css'
+
+import type {ComponentType, Props} from '../../types'
+
+/** @public */
+export const DEFAULT_MENU_DIVIDER_ELEMENT = 'hr'
+
+/** @public */
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export type MenuDividerOwnProps = {}
+
+/** @public */
+export type MenuDividerElementType = 'div' | 'hr' | 'span' | ComponentType
+
+/** @public */
+export type MenuDividerProps<E extends MenuDividerElementType = MenuDividerElementType> = Props<
+  MenuDividerOwnProps,
+  E
+>
+
+/** @public */
+export function MenuDivider<E extends MenuDividerElementType = typeof DEFAULT_MENU_DIVIDER_ELEMENT>(
+  props: MenuDividerProps<E>,
+): React.JSX.Element {
+  const {
+    as: Element = DEFAULT_MENU_DIVIDER_ELEMENT,
+    className,
+    ...rest
+  } = props as MenuDividerProps<typeof DEFAULT_MENU_DIVIDER_ELEMENT>
+
+  return <Element {...rest} className={menuDivider({className})} />
+}

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

@@ -0,0 +1,233 @@
+import {ChevronRightIcon} from '@sanity/icons'
+import type {RadiusStyleProps, ResponsiveProp} from '@sanity/ui/css'
+import type {ElementTone, FontTextSize, Space} from '@sanity/ui/theme'
+import {
+  type ElementType,
+  isValidElement,
+  type KeyboardEvent,
+  type MouseEvent,
+  type ReactNode,
+  useCallback,
+  useEffect,
+  useState,
+} from 'react'
+import {isValidElementType} from 'react-is'
+
+import {Box} from '../../primitives/box/box'
+import {Flex} from '../../primitives/flex/flex'
+import {Popover, type PopoverProps} from '../../primitives/popover/popover'
+import {Selectable} from '../../primitives/selectable/selectable'
+import {Text} from '../../primitives/text/text'
+import type {ComponentType, Props} from '../../types'
+import {DEFAULT_MENU_ELEMENT, Menu, type MenuProps} from './menu'
+import {useMenu} from './useMenu'
+
+/** @public */
+export const DEFAULT_MENU_GROUP_ELEMENT = 'button'
+
+/** @public */
+export type MenuGroupOwnProps = RadiusStyleProps & {
+  disabled?: boolean
+  fontSize?: ResponsiveProp<FontTextSize>
+  gap?: ResponsiveProp<Space>
+  icon?: ElementType | ReactNode
+  menu?: Omit<
+    MenuProps<typeof DEFAULT_MENU_ELEMENT>,
+    | 'onClickOutside'
+    | 'onEscape'
+    | 'onItemClick'
+    | 'onKeyDown'
+    | 'onMouseEnter'
+    | 'registerElement'
+    | 'shouldFocus'
+    | 'onBlurCapture'
+  >
+  padding?: ResponsiveProp<Space>
+  popover?: Omit<PopoverProps, 'content' | 'open'>
+  text?: ReactNode
+  tone?: ElementTone
+}
+
+/** @public */
+export type MenuGroupElementType = 'button' | ComponentType
+
+/** @public */
+export type MenuGroupProps<E extends MenuGroupElementType = MenuGroupElementType> = Props<
+  MenuGroupOwnProps,
+  E
+>
+
+/** @public */
+export function MenuGroup<E extends MenuGroupElementType = typeof DEFAULT_MENU_GROUP_ELEMENT>(
+  props: MenuGroupProps<E>,
+): React.JSX.Element {
+  const {
+    as = DEFAULT_MENU_GROUP_ELEMENT,
+    children,
+    fontSize = 1,
+    gap = 3,
+    icon: IconComponent,
+    menu: menuProps,
+    onClick,
+    padding = 3,
+    popover,
+    radius = 2,
+    text,
+    tone = 'default',
+    ...rest
+  } = props as MenuGroupProps<typeof DEFAULT_MENU_GROUP_ELEMENT>
+
+  const {
+    activeElement,
+    mount,
+    onClickOutside,
+    onEscape,
+    onItemClick,
+    onItemMouseEnter,
+    registerElement,
+  } = useMenu()
+
+  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: MouseEvent<HTMLElement>) => {
+      setWithinMenu(false)
+      onItemMouseEnter?.(event)
+      setOpen(true)
+    },
+    [onItemMouseEnter],
+  )
+
+  const handleMenuKeyDown = useCallback(
+    (event: KeyboardEvent<HTMLDivElement>) => {
+      if (event.key === 'ArrowLeft') {
+        event.stopPropagation()
+
+        setOpen(false)
+
+        requestAnimationFrame(() => {
+          rootElement?.focus()
+        })
+      }
+    },
+    [rootElement],
+  )
+
+  const handleClick = useCallback(
+    (event: MouseEvent<HTMLButtonElement>) => {
+      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(() => {
+    if (!active) setOpen(false)
+  }, [active])
+
+  // Update state when child menu is no longer open
+  useEffect(() => {
+    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))
+
+    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: KeyboardEvent<HTMLButtonElement>) => {
+    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}
+        {...rest}
+        aria-pressed={as === 'button' ? withinMenu : undefined}
+        as={as}
+        // data-pressed={as !== 'button' ? withinMenu : undefined}
+        // data-selected={!withinMenu && active ? '' : undefined}
+        onClick={handleClick}
+        onKeyDown={handleKeyDown}
+        onMouseEnter={handleMouseEnter}
+        radius={radius}
+        ref={setRootElement}
+        selected={withinMenu}
+        tabIndex={-1}
+        tone={tone}
+        type={as === 'button' ? 'button' : undefined}
+      >
+        <Flex gap={gap} 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>
+  )
+}

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

@@ -0,0 +1,183 @@
+import type {
+  GapStyleProps,
+  PaddingStyleProps,
+  RadiusStyleProps,
+  ResponsiveProp,
+} from '@sanity/ui/css'
+import type {ElementTone, FontTextSize} from '@sanity/ui/theme'
+import {
+  type ElementType,
+  isValidElement,
+  type MouseEvent,
+  type ReactNode,
+  useCallback,
+  useEffect,
+  useImperativeHandle,
+  useMemo,
+  useRef,
+  useState,
+} from 'react'
+import {isValidElementType} from 'react-is'
+
+import {Box} from '../../primitives/box/box'
+import {Flex} from '../../primitives/flex/flex'
+import {Selectable} from '../../primitives/selectable/selectable'
+import {Text} from '../../primitives/text/text'
+import type {ComponentType, Props} from '../../types'
+import {Hotkeys} from '../hotkeys/hotkeys'
+import {useMenu} from './useMenu'
+
+/** @public */
+export const DEFAULT_MENU_ITEM_ELEMENT = 'button'
+
+/** @public */
+export type MenuItemOwnProps = GapStyleProps &
+  PaddingStyleProps &
+  RadiusStyleProps & {
+    disabled?: boolean
+    fontSize?: ResponsiveProp<FontTextSize>
+    hotkeys?: string[]
+    icon?: ElementType | ReactNode
+    iconRight?: ElementType | ReactNode
+    pressed?: boolean
+    selected?: boolean
+    text?: ReactNode
+    tone?: ElementTone
+  }
+
+/** @public */
+export type MenuItemElementType = 'button' | 'a' | ComponentType
+
+/** @public */
+export type MenuItemProps<E extends MenuItemElementType = MenuItemElementType> = Omit<
+  Props<MenuItemOwnProps, E>,
+  'role'
+>
+
+/** @public */
+export function MenuItem<E extends MenuItemElementType = typeof DEFAULT_MENU_ITEM_ELEMENT>(
+  props: MenuItemProps<E>,
+): React.JSX.Element {
+  const {
+    as = DEFAULT_MENU_ITEM_ELEMENT,
+    children,
+    disabled,
+    fontSize = 1,
+    gap = 3,
+    gapX,
+    gapY,
+    hotkeys,
+    icon: IconComponent,
+    iconRight: IconRightComponent,
+    onClick,
+    padding = 3,
+    paddingX,
+    paddingY,
+    paddingTop,
+    paddingRight,
+    paddingBottom,
+    paddingLeft,
+    pressed,
+    radius = 2,
+    ref: forwardedRef,
+    selected: selectedProp,
+    text,
+    tone = 'default',
+    ...rest
+  } = props as MenuItemProps<typeof DEFAULT_MENU_ITEM_ELEMENT>
+
+  const menu = useMenu()
+  const {activeElement, mount, onItemClick, onItemMouseEnter, onItemMouseLeave} = menu
+  const [rootElement, setRootElement] = useState<HTMLButtonElement | null>(null)
+  const active = Boolean(activeElement) && activeElement === rootElement
+  const ref = useRef<HTMLButtonElement | null>(null)
+
+  useImperativeHandle<HTMLButtonElement | null, HTMLButtonElement | null>(
+    forwardedRef,
+    () => ref.current,
+  )
+
+  useEffect(() => mount(rootElement, selectedProp), [mount, rootElement, selectedProp])
+
+  const handleClick = useCallback(
+    (event: MouseEvent<HTMLButtonElement>) => {
+      if (disabled) return
+      if (onClick) onClick(event)
+      if (onItemClick) onItemClick()
+    },
+    [disabled, onClick, onItemClick],
+  )
+
+  const paddingProps = useMemo(
+    () => ({
+      padding,
+      paddingX,
+      paddingY,
+      paddingTop,
+      paddingRight,
+      paddingBottom,
+      paddingLeft,
+    }),
+    [padding, paddingX, paddingY, paddingTop, paddingRight, paddingBottom, paddingLeft],
+  )
+
+  const setRef = useCallback((el: HTMLButtonElement | null) => {
+    ref.current = el
+    setRootElement(el)
+  }, [])
+
+  return (
+    <Selectable
+      data-ui="MenuItem"
+      {...rest}
+      as={as}
+      data-pressed={pressed ? '' : undefined}
+      data-selected={active ? '' : undefined}
+      data-disabled={disabled ? '' : undefined}
+      radius={radius}
+      disabled={disabled}
+      onClick={handleClick}
+      onMouseEnter={onItemMouseEnter}
+      onMouseLeave={onItemMouseLeave}
+      ref={setRef}
+      role="menuitem"
+      tabIndex={-1}
+      tone={tone}
+      type={as === 'button' ? 'button' : undefined}
+    >
+      {(IconComponent || text || IconRightComponent) && (
+        <Flex as="span" gap={gap} gapX={gapX} gapY={gapY} align="center" {...paddingProps}>
+          {IconComponent && (
+            <Text muted size={fontSize}>
+              {isValidElement(IconComponent) && IconComponent}
+              {isValidElementType(IconComponent) && <IconComponent />}
+            </Text>
+          )}
+
+          {text && (
+            <Box flex={1}>
+              <Text size={fontSize} textOverflow="ellipsis" weight="medium">
+                {text}
+              </Text>
+            </Box>
+          )}
+
+          {hotkeys && <Hotkeys keys={hotkeys} style={{marginTop: -4, marginBottom: -4}} />}
+
+          {IconRightComponent && (
+            <Text muted size={fontSize}>
+              {isValidElement(IconRightComponent) && IconRightComponent}
+              {isValidElementType(IconRightComponent) && <IconRightComponent />}
+            </Text>
+          )}
+        </Flex>
+      )}
+
+      {children && (
+        <Box as="span" {...paddingProps}>
+          {children}
+        </Box>
+      )}
+    </Selectable>
+  )
+}