@sanity/ui 2.6.6 → 2.6.7-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/ui",
-  "version": "2.6.6",
+  "version": "2.6.7-canary.0",
   "keywords": [
     "sanity",
     "ui",
@@ -51,32 +51,6 @@
     "src",
     "theme.js"
   ],
-  "scripts": {
-    "build": "run-s clean pkg:build pkg:check figma:pkg:build",
-    "clean": "rimraf .workshop dist",
-    "commit": "cz",
-    "cypress:dev": "run-p dev cypress:open",
-    "cypress:open": "cypress open",
-    "cypress:run": "cypress run",
-    "dev": "run-p storybook:dev workshop:dev",
-    "figma:pkg:build": "cd figma && pnpm build",
-    "format": "prettier --write --cache --ignore-unknown .",
-    "lint": "eslint . --ext .cjs,.js,.jsx,.mjs,.ts,.tsx",
-    "pkg:build": "pkg build --strict",
-    "pkg:check": "pkg --strict",
-    "prepare": "husky install",
-    "prepublishOnly": "pnpm build",
-    "release": "semantic-release",
-    "storybook:build": "storybook build",
-    "storybook:dev": "storybook dev -p 6006",
-    "test": "jest",
-    "test:browser": "start-server-and-test 'run-s workshop:build workshop:start' http://localhost:1337 'run-s cypress:run'",
-    "ts:check": "tsc",
-    "watch": "pkg watch --strict",
-    "workshop:build": "workshop build",
-    "workshop:dev": "workshop dev",
-    "workshop:start": "http-server -a localhost -c-0 -p 1337 -s -P http://localhost:1337/index.html? dist"
-  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -194,19 +168,37 @@
     "react-is": "^18",
     "styled-components": "^5.2 || ^6"
   },
-  "packageManager": "pnpm@9.5.0",
   "engines": {
     "node": ">=14.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "pnpm": {
-    "overrides": {
-      "conventional-changelog-conventionalcommits": ">= 8.0.0"
-    }
-  },
   "esm.sh": {
     "bundle": false
+  },
+  "scripts": {
+    "build": "run-s clean pkg:build pkg:check figma:pkg:build",
+    "clean": "rimraf .workshop dist",
+    "commit": "cz",
+    "cypress:dev": "run-p dev cypress:open",
+    "cypress:open": "cypress open",
+    "cypress:run": "cypress run",
+    "dev": "run-p storybook:dev workshop:dev",
+    "figma:pkg:build": "cd figma && pnpm build",
+    "format": "prettier --write --cache --ignore-unknown .",
+    "lint": "eslint . --ext .cjs,.js,.jsx,.mjs,.ts,.tsx",
+    "pkg:build": "pkg build --strict",
+    "pkg:check": "pkg --strict",
+    "release": "semantic-release",
+    "storybook:build": "storybook build",
+    "storybook:dev": "storybook dev -p 6006",
+    "test": "jest",
+    "test:browser": "start-server-and-test 'run-s workshop:build workshop:start' http://localhost:1337 'run-s cypress:run'",
+    "ts:check": "tsc",
+    "watch": "pkg watch --strict",
+    "workshop:build": "workshop build",
+    "workshop:dev": "workshop dev",
+    "workshop:start": "http-server -a localhost -c-0 -p 1337 -s -P http://localhost:1337/index.html? dist"
   }
-}
+}

package/src/core/components/breadcrumbs/breadcrumbs.tsx

@@ -1,4 +1,13 @@
-import {Children, forwardRef, Fragment, isValidElement, useCallback, useMemo, useState} from 'react'
+import {
+  Children,
+  forwardRef,
+  Fragment,
+  isValidElement,
+  useCallback,
+  useMemo,
+  useRef,
+  useState,
+} from 'react'
 import {useArrayProp, useClickOutside} from '../../hooks'
 import {Box, Popover, Stack, Text} from '../../primitives'
 import {ExpandButton, Root} from './breadcrumbs.styles'
@@ -22,13 +31,13 @@ export const Breadcrumbs = forwardRef(function Breadcrumbs(
   const {children, maxLength, separator, space: spaceRaw = 2, ...restProps} = props
   const space = useArrayProp(spaceRaw)
   const [open, setOpen] = useState(false)
-  const [expandElement, setExpandElement] = useState<HTMLButtonElement | null>(null)
-  const [popoverElement, setPopoverElement] = useState<HTMLDivElement | null>(null)
+  const expandElementRef = useRef<HTMLButtonElement | null>(null)
+  const popoverElementRef = useRef<HTMLDivElement | null>(null)
 
   const collapse = useCallback(() => setOpen(false), [])
   const expand = useCallback(() => setOpen(true), [])
 
-  useClickOutside(collapse, [expandElement, popoverElement])
+  useClickOutside(collapse, () => [expandElementRef.current, popoverElementRef.current])
 
   const rawItems = useMemo(() => Children.toArray(children).filter(isValidElement), [children])
 
@@ -52,14 +61,14 @@ export const Breadcrumbs = forwardRef(function Breadcrumbs(
           open={open}
           placement="top"
           portal
-          ref={setPopoverElement}
+          ref={popoverElementRef}
         >
           <ExpandButton
             fontSize={1}
             mode="bleed"
             onClick={open ? collapse : expand}
             padding={1}
-            ref={setExpandElement}
+            ref={expandElementRef}
             selected={open}
             text="…"
           />

package/src/core/components/dialog/dialog.tsx

@@ -1,6 +1,6 @@
 import {CloseIcon} from '@sanity/icons'
 import {ThemeColorSchemeKey} from '@sanity/ui/theme'
-import {forwardRef, useCallback, useEffect, useImperativeHandle, useRef, useState} from 'react'
+import {forwardRef, useCallback, useEffect, useImperativeHandle, useRef} from 'react'
 import {styled} from 'styled-components'
 import {
   containsOrEqualsElement,
@@ -170,7 +170,6 @@ const DialogCard = forwardRef(function DialogCard(
   const shadow = useArrayProp(shadowProp)
   const width = useArrayProp(widthProp)
   const ref = useRef<HTMLDivElement | null>(null)
-  const [rootElement, setRootElement] = useState<HTMLDivElement | null>(null)
   const contentRef = useRef<HTMLDivElement | null>(null)
   const layer = useLayer()
   const {isTopLayer} = layer
@@ -216,32 +215,24 @@ const DialogCard = forwardRef(function DialogCard(
   )
 
   useClickOutside(
-    useCallback(
-      (event: MouseEvent) => {
-        if (!isTopLayer || !onClickOutside) return
+    (event: MouseEvent | TouchEvent) => {
+      if (!isTopLayer || !onClickOutside) return
 
-        const target = event.target as Node | null
+      const target = event.target as Node | null
 
-        if (target && !isTargetWithinScope(boundaryElement, portalElement, target)) {
-          // Ignore clicks outside of the scope
-          return
-        }
+      if (target && !isTargetWithinScope(boundaryElement, portalElement, target)) {
+        // Ignore clicks outside of the scope
+        return
+      }
 
-        onClickOutside()
-      },
-      [boundaryElement, isTopLayer, onClickOutside, portalElement],
-    ),
-    [rootElement],
+      onClickOutside()
+    },
+    () => [ref.current],
   )
 
-  const setRef = useCallback((el: HTMLDivElement | null) => {
-    setRootElement(el)
-    ref.current = el
-  }, [])
-
   return (
     <DialogContainer data-ui="DialogCard" width={width}>
-      <DialogCardRoot radius={radius} ref={setRef} scheme={scheme} shadow={shadow}>
+      <DialogCardRoot radius={radius} ref={ref} scheme={scheme} shadow={shadow}>
         <DialogLayout direction="column">
           {showHeader && (
             <DialogHeader>

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

@@ -19,7 +19,7 @@ export interface MenuProps extends ResponsivePaddingProps {
    * @deprecated Use `shouldFocus="last"` instead.
    */
   focusLast?: boolean
-  onClickOutside?: (event: MouseEvent) => void
+  onClickOutside?: (event: MouseEvent | TouchEvent) => void
   onEscape?: () => void
   onItemClick?: () => void
   onItemSelect?: (index: number) => void
@@ -75,16 +75,18 @@ export const Menu = forwardRef(function Menu(
     handleItemMouseLeave,
     handleKeyDown,
     mount,
-    rootElement,
-    setRootElement,
-  } = useMenuController({onKeyDown, originElement, shouldFocus})
+  } = useMenuController({onKeyDown, originElement, shouldFocus, rootElementRef: ref})
 
   const handleRefChange = useCallback(
     (el: HTMLDivElement | null) => {
-      setRootElement(el)
       ref.current = el
+
+      // Register root element (for nested menus)
+      if (ref.current && registerElement) {
+        registerElement(ref.current)
+      }
     },
-    [setRootElement],
+    [registerElement],
   )
 
   // Trigger `onItemSelect` when active index changes
@@ -94,11 +96,8 @@ export const Menu = forwardRef(function Menu(
 
   // Close menu when clicking outside
   useClickOutside(
-    useCallback(
-      (event) => isTopLayer && onClickOutside && onClickOutside(event),
-      [isTopLayer, onClickOutside],
-    ),
-    [rootElement],
+    (event) => isTopLayer && onClickOutside && onClickOutside(event),
+    () => [ref.current],
   )
 
   // Close menu when pressing Escape
@@ -116,13 +115,7 @@ export const Menu = forwardRef(function Menu(
     ),
   )
 
-  // Register root element (for nested menus)
-  useEffect(() => {
-    if (!rootElement || !registerElement) return
-
-    return registerElement(rootElement)
-  }, [registerElement, rootElement])
-
+  // @TODO split out into separate contexts
   const value: MenuContextValue = useMemo(
     () => ({
       version: 0.0,

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

@@ -140,7 +140,7 @@ export const MenuButton = forwardRef(function MenuButton(
   }, [])
 
   const handleMenuClickOutside = useCallback(
-    (event: MouseEvent) => {
+    (event: MouseEvent | TouchEvent) => {
       const target = event.target
 
       if (!(target instanceof Node)) {

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

@@ -5,7 +5,7 @@ export interface MenuContextValue {
   activeElement: HTMLElement | null
   activeIndex: number
   mount: (element: HTMLElement | null, selected?: boolean) => () => void
-  onClickOutside?: (event: MouseEvent) => void
+  onClickOutside?: (event: MouseEvent | TouchEvent) => void
   onEscape?: () => void
   onItemClick?: () => void
   onItemMouseEnter?: (event: React.MouseEvent<HTMLElement>) => void

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

@@ -1,4 +1,4 @@
-import {useCallback, useEffect, useRef, useState} from 'react'
+import {useCallback, useEffect, useMemo, useRef, useState} from 'react'
 import {_getFocusableElements, _sortElements} from './helpers'
 
 /**
@@ -11,8 +11,6 @@ export interface MenuController {
   handleItemMouseLeave: () => void
   handleKeyDown: (event: React.KeyboardEvent<HTMLDivElement>) => void
   mount: (element: HTMLElement | null, selected?: boolean) => () => void
-  rootElement: HTMLDivElement | null
-  setRootElement: (el: HTMLDivElement | null) => void
 }
 
 /**
@@ -24,14 +22,14 @@ export function useMenuController(props: {
   onKeyDown?: React.KeyboardEventHandler
   originElement?: HTMLElement | null
   shouldFocus: 'first' | 'last' | null
+  rootElementRef: React.MutableRefObject<HTMLDivElement | null>
 }): MenuController {
-  const {onKeyDown, originElement, shouldFocus} = props
+  const {onKeyDown, originElement, shouldFocus, rootElementRef} = props
   const elementsRef = useRef<HTMLElement[]>([])
-  const [rootElement, setRootElement] = useState<HTMLDivElement | null>(null)
   const [activeIndex, _setActiveIndex] = useState(-1)
   const activeIndexRef = useRef(activeIndex)
-  const activeElement = elementsRef.current[activeIndex] || null
-  const mounted = Boolean(rootElement)
+  const activeElement = useMemo(() => elementsRef.current[activeIndex] || null, [activeIndex])
+  const mounted = Boolean(rootElementRef.current)
 
   const setActiveIndex = useCallback((nextActiveIndex: number) => {
     _setActiveIndex(nextActiveIndex)
@@ -44,7 +42,7 @@ export function useMenuController(props: {
 
       if (elementsRef.current.indexOf(element) === -1) {
         elementsRef.current.push(element)
-        _sortElements(rootElement, elementsRef.current)
+        _sortElements(rootElementRef.current, elementsRef.current)
       }
 
       if (selected) {
@@ -61,7 +59,7 @@ export function useMenuController(props: {
         }
       }
     },
-    [rootElement, setActiveIndex],
+    [rootElementRef, setActiveIndex],
   )
 
   const handleKeyDown = useCallback(
@@ -179,17 +177,15 @@ export function useMenuController(props: {
     // which would be incorrect when the user hovers over a gap
     // between two menu items or a menu divider.
     setActiveIndex(-2)
-    rootElement?.focus()
-  }, [setActiveIndex, rootElement])
+    rootElementRef.current?.focus()
+  }, [rootElementRef, setActiveIndex])
 
   // Set focus on the currently active element
   useEffect(() => {
     if (!mounted) return
 
     const rafId = window.requestAnimationFrame(() => {
-      const _activeIndex = activeIndexRef.current
-
-      if (_activeIndex === -1) {
+      if (activeIndex === -1) {
         if (shouldFocus === 'first') {
           const focusableElements = _getFocusableElements(elementsRef.current)
           const el = focusableElements[0]
@@ -217,7 +213,7 @@ export function useMenuController(props: {
         return
       }
 
-      const element = elementsRef.current[_activeIndex] || null
+      const element = elementsRef.current[activeIndex] || null
 
       element?.focus()
     })
@@ -234,7 +230,5 @@ export function useMenuController(props: {
     handleItemMouseLeave,
     handleKeyDown,
     mount,
-    rootElement,
-    setRootElement,
   }
 }

package/src/core/components/toast/styles.ts

@@ -14,11 +14,12 @@ const loadingAnimation = keyframes`
   }
   100% {
     width: 100%;
-  } 
+  }
 `
 
 const LOADING_BAR_HEIGHT = 2
 
+// @TODO get rid of $duration modifier, set data attribute instead and use stable selector
 export function rootStyles(
   props: {$duration?: number; tone: ThemeColorStateToneKey} & ThemeProps,
 ): ReturnType<typeof css> {

package/src/core/components/toast/useToast.ts

@@ -13,6 +13,7 @@ export function useToast(): ToastContextValue {
     throw new Error('useToast(): missing context value')
   }
 
+  // @TODO context and hooks doesn't really work like this, there will never be a mismatch between the provider and the consumer, we can remove these version specifiers
   // NOTE: This check is for future-compatiblity
   // - If the value is not an object, it’s not compatible with the current version
   // - If the value is an object, but doesn’t have `version: 0.0`, it’s not compatible with the current version

package/src/core/components/tree/tree.tsx

@@ -84,6 +84,7 @@ export const Tree = memo(
       })
     }, [])
 
+    // @TODO split out into separate contexts
     const contextValue: TreeContextValue = useMemo(
       () => ({
         version: 0.0,

package/src/core/components/tree/treeItem.tsx

@@ -76,6 +76,7 @@ export const TreeItem = memo(function TreeItem(
   const focused = tree.focusedElement === rootRef.current
   const expanded = itemState?.expanded === undefined ? expandedProp : itemState?.expanded || false
   const tabIndex = tree.focusedElement && tree.focusedElement === rootRef.current ? 0 : -1
+  // @TODO split out into separate contexts
   const contextValue = useMemo(
     () => ({...tree, level: tree.level + 1, path: itemPath}),
     [itemPath, tree],

package/src/core/helpers/focus.ts

@@ -15,6 +15,7 @@ import {
  * @internal
  */
 export function _hasFocus(element: HTMLElement): boolean {
+  // @TODO verify this is not called during render
   return Boolean(document.activeElement) && element.contains(document.activeElement)
 }
 

package/src/core/helpers/scroll.ts

@@ -4,6 +4,7 @@
 export function _isScrollable(el: Node): boolean {
   if (!(el instanceof Element)) return false
 
+  // @TODO check if this is called during render
   const style = window.getComputedStyle(el)
 
   return (

package/src/core/hooks/index.ts

@@ -1,10 +1,11 @@
 export * from './useArrayProp'
 export * from './useClickOutside'
+export * from './useCustomValidity'
 export * from './useElementRect'
 export * from './useElementSize'
+export * from './useForwardedRef'
 export * from './useGlobalKeyDown'
+export * from './useMatchMedia'
 export * from './useMediaIndex'
 export * from './usePrefersDark'
 export * from './usePrefersReducedMotion'
-export * from './useForwardedRef'
-export * from './useCustomValidity'

package/src/core/hooks/useClickOutside.ts

@@ -1,99 +1,65 @@
-import {useEffect, useRef, useState} from 'react'
+import {useEffect} from 'react'
+import {useEffectEvent} from 'use-effect-event'
 import {EMPTY_ARRAY} from '../constants'
 
 /**
  * @public
  */
-export type ClickOutsideListener = (event: MouseEvent) => void
-
-function _getElements(
-  element: HTMLElement | null,
-  elementsArg: Array<HTMLElement | HTMLElement[] | null>,
-): HTMLElement[] {
-  const ret = [element]
-
-  for (const el of elementsArg) {
-    if (Array.isArray(el)) {
-      ret.push(...el)
-    } else {
-      ret.push(el)
-    }
-  }
-
-  return ret.filter(Boolean) as HTMLElement[]
-}
+export type ClickOutsideListener = (event: MouseEvent | TouchEvent) => void
 
 /**
+ * Use the callback version of `elementsArg` if you're using `useRef` to handle elements:
+ * ```tsx
+ * useClickOutside(
+ *   () => {},
+ *   () => [ref.current],
+ * )
+ *
  * @public
  */
 export function useClickOutside(
   listener: ClickOutsideListener,
-  elementsArg: Array<HTMLElement | HTMLElement[] | null> = EMPTY_ARRAY,
+  elementsArg:
+    | Array<HTMLElement | HTMLElement[] | null>
+    | (() => Array<HTMLElement | HTMLElement[] | null>) = EMPTY_ARRAY,
   boundaryElement?: HTMLElement | null,
-): (el: HTMLElement | null) => void {
-  const [element, setElement] = useState<HTMLElement | null>(null)
-  const [elements, setElements] = useState(() => _getElements(element, elementsArg))
-  const elementsRef = useRef(elements)
-
-  useEffect(() => {
-    const prevElements = elementsRef.current
-    const nextElements = _getElements(element, elementsArg)
-
-    if (prevElements.length !== nextElements.length) {
-      setElements(nextElements)
-      elementsRef.current = nextElements
-
+): void {
+  /**
+   * The `useEffectEvent` hook allow us to always see the latest value of `listener`, `elementsArg` and `boundaryElement` without needing to
+   * juggle `useState`, `useRef` and `useState` to make sure the `mousedown` event listener isn't constantly being added and removed.
+   */
+  const eventHandler = useEffectEvent((evt: MouseEvent | TouchEvent) => {
+    const target = evt.target
+
+    if (!(target instanceof Node)) {
       return
     }
 
-    for (const el of prevElements) {
-      if (!nextElements.includes(el)) {
-        setElements(nextElements)
-        elementsRef.current = nextElements
-
-        return
-      }
-    }
-
-    for (const el of nextElements) {
-      if (!prevElements.includes(el)) {
-        setElements(nextElements)
-        elementsRef.current = nextElements
-
-        return
-      }
+    if (boundaryElement && !boundaryElement.contains(target)) {
+      return
     }
-  }, [element, elementsArg])
 
-  useEffect(() => {
-    if (!listener) return undefined
-
-    const handleWindowMouseDown = (evt: MouseEvent) => {
-      const target = evt.target
+    const resolvedElements = Array.isArray(elementsArg) ? elementsArg : elementsArg()
+    const elements = resolvedElements.flat()
 
-      if (!(target instanceof Node)) {
-        return
-      }
+    for (const el of elements) {
+      if (!el) continue
 
-      if (boundaryElement && !boundaryElement.contains(target)) {
+      if (target === el || el.contains(target)) {
         return
       }
-
-      for (const el of elements) {
-        if (target === el || el.contains(target)) {
-          return
-        }
-      }
-
-      listener(evt)
     }
 
-    window.addEventListener('mousedown', handleWindowMouseDown)
+    listener(evt)
+  })
+
+  useEffect(() => {
+    document.addEventListener('mousedown', eventHandler)
+    document.addEventListener('touchstart', eventHandler)
 
     return () => {
-      window.removeEventListener('mousedown', handleWindowMouseDown)
+      document.removeEventListener('mousedown', eventHandler)
+      document.removeEventListener('touchstart', eventHandler)
     }
-  }, [boundaryElement, listener, elements])
-
-  return setElement
+  }, [eventHandler])
 }

package/src/core/hooks/useElementSize.ts

@@ -6,6 +6,7 @@ import {ElementSize, _elementSizeObserver} from '../observers/elementSizeObserve
  * @beta
  */
 export function useElementSize(element: HTMLElement | null): ElementSize | null {
+  // @TODO we can probably use something in framer-motion or @floating-ui instead of rolling our own
   const [size, setSize] = useState<ElementSize | null>(null)
 
   useEffect(() => {

package/src/core/hooks/useMatchMedia.ts

@@ -0,0 +1,46 @@
+import {useDebugValue, useMemo, useSyncExternalStore} from 'react'
+
+/**
+ * Efficiently subscribes to `window.matchMedia` queries
+ *
+ * @param getServerSnapshot - Only called during server-side rendering, and hydration if using hydrateRoot. Required if the hook is called during SSR (https://react.dev/reference/react/useSyncExternalStore#adding-support-for-server-rendering)
+ *
+ * @public
+ */
+export function useMatchMedia(
+  mediaQueryString: `(${string})`,
+  getServerSnapshot?: () => boolean,
+): boolean {
+  const {subscribe, getSnapshot} = useMemo(() => {
+    /**
+     * `subscribe` and `getSnapshot` are only called on the client and both need access to the same `matchMedia` instance
+     * we don't want to eagerly instantiate it to ensure it's only created when actually used
+     */
+    let MEDIA_QUERY_CACHE: MediaQueryList | undefined
+
+    const getMatchMedia = (): MediaQueryList => {
+      if (!MEDIA_QUERY_CACHE) {
+        // As this function is only called during `subscribe` and `getSnapshot`, we can assume that the
+        // the `window` global is available and we're in a browser environment
+        MEDIA_QUERY_CACHE = window.matchMedia(mediaQueryString)
+      }
+
+      return MEDIA_QUERY_CACHE
+    }
+
+    return {
+      subscribe: (onStoreChange: () => void): (() => void) => {
+        const matchMedia = getMatchMedia()
+
+        matchMedia.addEventListener('change', onStoreChange)
+
+        return () => matchMedia.removeEventListener('change', onStoreChange)
+      },
+      getSnapshot: () => getMatchMedia().matches,
+    }
+  }, [mediaQueryString])
+
+  useDebugValue(mediaQueryString)
+
+  return useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot)
+}

package/src/core/hooks/useMediaIndex/useMediaIndex.ts

@@ -1,4 +1,4 @@
-import {useSyncExternalStore} from 'react'
+import {useMemo, useSyncExternalStore} from 'react'
 import {useTheme_v2} from '../../theme'
 
 /**
@@ -9,8 +9,6 @@ export interface _MediaStore {
   getSnapshot: () => number
 }
 
-const MEDIA_STORE_CACHE = new WeakMap<number[], _MediaStore>()
-
 type MediaQueryMinWidth = `(min-width: ${number}px)`
 type MediaQueryMaxWidth = `(max-width: ${number}px)`
 type MediaQueryMinMaxWidth = `${MediaQueryMinWidth} and ${MediaQueryMaxWidth}`
@@ -97,13 +95,7 @@ function getServerSnapshot() {
  */
 export function useMediaIndex(): number {
   const {media} = useTheme_v2()
-
-  let store = MEDIA_STORE_CACHE.get(media)
-
-  if (!store) {
-    store = _createMediaStore(media)
-    MEDIA_STORE_CACHE.set(media, store)
-  }
+  const store = useMemo(() => _createMediaStore(media), [media])
 
   return useSyncExternalStore(store.subscribe, store.getSnapshot, getServerSnapshot)
 }