@sanity/ui 3.3.2 → 3.3.4

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

@@ -1,242 +0,0 @@
-import {
-  forwardRef,
-  useCallback,
-  useEffect,
-  useImperativeHandle,
-  useMemo,
-  useRef,
-  useState,
-} from 'react'
-
-import {Stack} from '../../primitives'
-import {_findNextItemElement, _findPrevItemElement, _focusItemElement} from './helpers'
-import {TreeContext} from './treeContext'
-import {TreeContextValue, TreeState} from './types'
-
-/**
- * This API might change. DO NOT USE IN PRODUCTION.
- * @beta
- */
-export interface TreeProps {
-  gap?: number | number[]
-  /**
-   * @deprecated Use `gap` instead. `space` will be removed in v4.
-   */
-  space?: number | number[]
-}
-
-/**
- * This API might change. DO NOT USE IN PRODUCTION.
- * @beta
- */
-export const Tree = forwardRef(function Tree(
-  props: TreeProps &
-    Omit<React.HTMLProps<HTMLUListElement>, 'align' | 'as' | 'height' | 'ref' | 'role' | 'wrap'>,
-  forwardedRef: React.ForwardedRef<HTMLUListElement>,
-): React.JSX.Element {
-  // oxlint-disable-next-line no-deprecated
-  const {children, gap, space: deprecated_space = 1, onFocus, ...restProps} = props
-  const spacing = gap === undefined ? deprecated_space : gap
-  const ref = useRef<HTMLUListElement | null>(null)
-  const [focusedElement, setFocusedElement] = useState<HTMLElement | null>(null)
-  const focusedElementRef = useRef(focusedElement)
-  const path: string[] = useMemo(() => [], [])
-  const [itemElements, setItemElements] = useState<HTMLElement[]>([])
-  const [state, setState] = useState<TreeState>({})
-  const stateRef = useRef(state)
-
-  useImperativeHandle<HTMLUListElement | null, HTMLUListElement | null>(
-    forwardedRef,
-    () => ref.current,
-  )
-
-  useEffect(() => {
-    focusedElementRef.current = focusedElement
-  }, [focusedElement])
-
-  useEffect(() => {
-    stateRef.current = state
-  }, [state])
-
-  const registerItem = useCallback(
-    (element: HTMLElement, path: string, expanded: boolean, selected: boolean) => {
-      setState((s) => ({...s, [path]: {element, expanded}}))
-
-      if (selected) {
-        setFocusedElement(element)
-      }
-
-      return () => {
-        setState((s) => {
-          const newState = {...s}
-
-          delete newState[path]
-
-          return newState
-        })
-      }
-    },
-    [],
-  )
-
-  const setExpanded = useCallback((path: string, expanded: boolean) => {
-    setState((s) => {
-      const itemState = s[path]
-
-      if (!itemState) return s
-
-      return {...s, [path]: {...itemState, expanded}}
-    })
-  }, [])
-
-  const contextValue: TreeContextValue = useMemo(
-    () => ({
-      version: 0.0,
-      focusedElement: focusedElement || itemElements[0] || null,
-      level: 0,
-      path,
-      registerItem,
-      setExpanded,
-      setFocusedElement,
-      gap: spacing,
-      space: spacing,
-      state,
-    }),
-    [focusedElement, itemElements, path, registerItem, setExpanded, spacing, state],
-  )
-
-  const handleKeyDown = useCallback(
-    (event: React.KeyboardEvent<HTMLUListElement>) => {
-      if (!focusedElementRef.current) return
-
-      if (event.key === 'ArrowDown') {
-        event.preventDefault()
-
-        const nextEl = _findNextItemElement(
-          stateRef.current,
-          itemElements,
-          focusedElementRef.current,
-        )
-
-        if (nextEl) {
-          _focusItemElement(nextEl)
-          setFocusedElement(nextEl)
-        }
-
-        return
-      }
-
-      if (event.key === 'ArrowUp') {
-        event.preventDefault()
-
-        const prevEl = _findPrevItemElement(
-          stateRef.current,
-          itemElements,
-          focusedElementRef.current,
-        )
-
-        if (prevEl) {
-          _focusItemElement(prevEl)
-          setFocusedElement(prevEl)
-        }
-
-        return
-      }
-
-      if (event.key === 'ArrowLeft') {
-        event.preventDefault()
-
-        const itemKey = focusedElementRef.current.getAttribute('data-tree-key')
-
-        if (!itemKey) return
-
-        const itemState = stateRef.current[itemKey]
-
-        if (!itemState) return
-
-        if (itemState.expanded) {
-          setState((s) => {
-            const itemState = s[itemKey]
-
-            if (!itemState) return s
-
-            return {...s, [itemKey]: {...itemState, expanded: false}}
-          })
-        } else {
-          const itemPath = itemKey.split('/')
-
-          itemPath.pop()
-
-          const parentKey = itemPath.join('/')
-          const parentState = parentKey && stateRef.current[parentKey]
-
-          if (parentState) {
-            parentState.element.focus()
-            setFocusedElement(parentState.element)
-          }
-        }
-
-        return
-      }
-
-      if (event.key === 'ArrowRight') {
-        event.preventDefault()
-
-        const focusedKey = focusedElementRef.current.getAttribute('data-tree-key')
-
-        if (!focusedKey) return
-
-        if (!stateRef.current[focusedKey]?.expanded) {
-          setState((s) => {
-            const itemState = s[focusedKey]
-
-            if (!itemState) return s
-
-            return {...s, [focusedKey]: {...itemState, expanded: true}}
-          })
-        }
-
-        return
-      }
-    },
-    [itemElements],
-  )
-
-  const handleFocus = useCallback(
-    (event: React.FocusEvent<HTMLUListElement>) => {
-      setFocusedElement(event.target)
-
-      // Call the element's `focus` handler
-      onFocus?.(event)
-    },
-    [onFocus],
-  )
-
-  useEffect(() => {
-    if (!ref.current) return
-    const _itemElements = Array.from(
-      ref.current.querySelectorAll('[data-ui="TreeItem"]'),
-    ) as HTMLElement[]
-
-    setItemElements(_itemElements)
-  }, [children])
-
-  return (
-    <TreeContext.Provider value={contextValue}>
-      {/* oxlint-disable-next-line interactive-supports-focus */}
-      <Stack
-        as="ul"
-        data-ui="Tree"
-        {...restProps}
-        onFocus={handleFocus}
-        onKeyDown={handleKeyDown}
-        ref={ref}
-        role="tree"
-        gap={spacing}
-      >
-        {children}
-      </Stack>
-    </TreeContext.Provider>
-  )
-})
-Tree.displayName = 'ForwardRef(Tree)'

package/src/core/components/tree/treeContext.ts

@@ -1,10 +0,0 @@
-import {createGlobalScopedContext} from '../../lib/createGlobalScopedContext'
-import {TreeContextValue} from './types'
-
-/**
- * @internal
- */
-export const TreeContext = createGlobalScopedContext<TreeContextValue | null>(
-  '@sanity/ui/context/tree',
-  null,
-)

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

@@ -1,29 +0,0 @@
-import {Stack} from '../../primitives'
-import {useTree} from './useTree'
-
-export interface TreeGroupProps {
-  expanded?: boolean
-}
-
-export function TreeGroup(
-  props: TreeGroupProps &
-    Omit<React.HTMLProps<HTMLUListElement>, 'as' | 'height' | 'ref' | 'role' | 'wrap'>,
-): React.JSX.Element {
-  const {children, expanded = false, ...restProps} = props
-  const tree = useTree()
-
-  return (
-    <Stack
-      as="ul"
-      data-ui="TreeGroup"
-      {...restProps}
-      hidden={!expanded}
-      marginTop={tree.gap}
-      // oxlint-disable-next-line prefer-tag-over-role
-      role="group"
-      gap={tree.gap}
-    >
-      {children}
-    </Stack>
-  )
-}

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

@@ -1,70 +0,0 @@
-/** @vitest-environment jsdom */
-
-import {beforeEach, describe, expect, it, vi} from 'vitest'
-
-import {render} from '../../../../test'
-import {Box} from '../../primitives'
-import {TreeContext} from './treeContext'
-import {TreeItem} from './treeItem'
-import {TreeContextValue, TreeState} from './types'
-
-vi.mock('../../primitives', async (importOriginal) => {
-  const actual = await importOriginal<typeof import('../../primitives')>()
-
-  return {
-    ...actual,
-    // oxlint-disable-next-line no-unsafe-type-assertion
-    Box: vi.fn((props: Record<string, unknown>) => (actual.Box as any).render(props, null)),
-  }
-})
-
-const treeContextValue: TreeContextValue = {
-  version: 0.0,
-  focusedElement: null,
-  gap: 1,
-  level: 0,
-  path: [],
-  registerItem: () => () => undefined,
-  setExpanded: () => undefined,
-  setFocusedElement: () => undefined,
-  // oxlint-disable-next-line no-deprecated
-  space: 1,
-  // oxlint-disable-next-line no-unnecessary-type-assertion
-  state: {} as TreeState,
-}
-
-function renderTreeItem(props: Partial<React.ComponentProps<typeof TreeItem>> = {}) {
-  return render(
-    <TreeContext.Provider value={treeContextValue}>
-      <TreeItem text="Item" {...props} />
-    </TreeContext.Provider>,
-  )
-}
-
-describe('components/treeItem spacing', () => {
-  const mockedBox = vi.mocked(Box)
-
-  beforeEach(() => {
-    mockedBox.mockClear()
-  })
-
-  it('should support `space` and `gap` with the same behavior', () => {
-    renderTreeItem({space: 2})
-    expect(mockedBox.mock.calls.map(([props]) => props)).toContainEqual(
-      expect.objectContaining({marginRight: 2}),
-    )
-
-    mockedBox.mockClear()
-    renderTreeItem({gap: 2})
-    expect(mockedBox.mock.calls.map(([props]) => props)).toContainEqual(
-      expect.objectContaining({marginRight: 2}),
-    )
-  })
-
-  it('should prefer `gap` over `space` when both are provided', () => {
-    renderTreeItem({gap: 3, space: 1})
-    const propsList = mockedBox.mock.calls.map(([props]) => props)
-    expect(propsList).toContainEqual(expect.objectContaining({marginRight: 3}))
-    expect(propsList).not.toContainEqual(expect.objectContaining({marginRight: 1}))
-  })
-})

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

@@ -1,225 +0,0 @@
-import {ToggleArrowRightIcon} from '@sanity/icons'
-import {ThemeFontWeightKey} from '@sanity/ui/theme'
-import {startTransition, useCallback, useEffect, useId, useMemo, useRef, useState} from 'react'
-import {styled} from 'styled-components'
-
-import {Box, Flex, Text} from '../../primitives'
-import {ElementType} from '../../types'
-import {
-  treeItemBoxStyle,
-  TreeItemBoxStyleProps,
-  treeItemRootColorStyle,
-  treeItemRootStyle,
-} from './style'
-import {TreeContext} from './treeContext'
-import {TreeGroup} from './treeGroup'
-import {useTree} from './useTree'
-
-/**
- * @beta
- */
-export interface TreeItemProps {
-  expanded?: boolean
-  fontSize?: number | number[]
-  icon?: React.ElementType
-  /**
-   * Allows passing a custom element type to the link component
-   */
-  linkAs?: ElementType
-  padding?: number | number[]
-  gap?: number | number[]
-  /**
-   * @deprecated Use `gap` instead. `space` will be removed in v4.
-   */
-  space?: number | number[]
-  text?: React.ReactNode
-  weight?: ThemeFontWeightKey
-}
-
-const StyledTreeItem = styled.li(treeItemRootStyle, treeItemRootColorStyle)
-
-const TreeItemBox = styled(Box).attrs({forwardedAs: 'a'})<TreeItemBoxStyleProps>(treeItemBoxStyle)
-
-const ToggleArrowText = styled(Text)`
-  & > svg {
-    transition: transform 100ms;
-  }
-`
-
-/**
- * This API might change. DO NOT USE IN PRODUCTION.
- * @beta
- */
-export function TreeItem(
-  props: TreeItemProps & Omit<React.HTMLProps<HTMLLIElement>, 'as' | 'ref' | 'role'>,
-): React.JSX.Element {
-  const {
-    children,
-    expanded: expandedProp = false,
-    fontSize = 1,
-    href,
-    icon: IconComponent,
-    id: idProp,
-    linkAs,
-    muted,
-    onClick,
-    padding = 2,
-    selected = false,
-    gap,
-    // oxlint-disable-next-line no-deprecated
-    space: deprecated_space = 2,
-    text,
-    weight,
-    ...restProps
-  } = props
-  const spacing = gap === undefined ? deprecated_space : gap
-  const [rootElement, _setRootElement] = useState<HTMLLIElement | null>(null)
-  /**
-   * The startTransition wrapper here is to avoid an issue when on React 18 where this error can happen:
-   * >Maximum update depth exceeded. This can happen when a component repeatedly calls setState inside componentWillUpdate or componentDidUpdate. React limits the number of nested updates to prevent infinite loops.
-   * This doesn't happen on React 19 due to automatic batching of all state updates, the startTransition wrapper here gives a type of batching for 18 users in a way that still works with 19.
-   * NOTE: The startTransition wrapper is not needed in UI v4, since the baseline there is React 19.
-   */
-  const setRootElement = useCallback((node: HTMLLIElement | null) => {
-    startTransition(() => _setRootElement(node))
-  }, [])
-
-  const treeitemRef = useRef<HTMLDivElement | null>(null)
-  const tree = useTree()
-  const {path, registerItem, setExpanded, setFocusedElement} = tree
-  const _id = useId()
-  const id = idProp || _id
-  const [itemPath, itemKey] = useMemo(() => {
-    const itemPath = path.concat([id || ''])
-    return [itemPath, itemPath.join('/')]
-  }, [id, path])
-  const itemState = tree.state[itemKey]
-  const focused = tree.focusedElement === rootElement
-  const expanded = itemState?.expanded === undefined ? expandedProp : itemState?.expanded || false
-  const tabIndex = tree.focusedElement && tree.focusedElement === rootElement ? 0 : -1
-  const contextValue = useMemo(
-    () => ({...tree, level: tree.level + 1, path: itemPath}),
-    [itemPath, tree],
-  )
-
-  const handleClick = useCallback(
-    (event: React.MouseEvent<HTMLLIElement>) => {
-      if (onClick) onClick(event)
-
-      const target = event.target
-
-      if (
-        target instanceof HTMLElement &&
-        (target.getAttribute('data-ui') === 'TreeItem' ||
-          target.closest('[data-ui="TreeItem__box"]'))
-      ) {
-        event.stopPropagation()
-        setExpanded(itemKey, !expanded)
-        setFocusedElement(rootElement)
-      }
-    },
-    [expanded, itemKey, onClick, rootElement, setExpanded, setFocusedElement],
-  )
-
-  const handleKeyDown = useCallback(
-    (event: React.KeyboardEvent<HTMLElement>) => {
-      if (focused && event.key === 'Enter') {
-        const el = treeitemRef.current || rootElement
-
-        el?.click()
-      }
-    },
-    [focused, rootElement],
-  )
-
-  useEffect(() => {
-    if (!rootElement) return
-
-    return registerItem(rootElement, itemKey, expanded, selected)
-  }, [expanded, itemKey, registerItem, rootElement, selected])
-
-  const content = (
-    <Flex padding={padding}>
-      <Box
-        marginRight={spacing}
-        style={{
-          visibility: IconComponent || children ? 'visible' : 'hidden',
-          pointerEvents: 'none',
-        }}
-      >
-        {IconComponent && (
-          <Text muted={muted} size={fontSize} weight={weight}>
-            <IconComponent />
-          </Text>
-        )}
-        {!IconComponent && (
-          <ToggleArrowText muted={muted} size={fontSize} weight={weight}>
-            <ToggleArrowRightIcon style={{transform: expanded ? 'rotate(90deg)' : undefined}} />
-          </ToggleArrowText>
-        )}
-      </Box>
-      <Box flex={1}>
-        <Text muted={muted} size={fontSize} textOverflow="ellipsis" weight={weight}>
-          {text}
-        </Text>
-      </Box>
-    </Flex>
-  )
-
-  if (href) {
-    return (
-      <StyledTreeItem
-        data-selected={selected ? '' : undefined}
-        data-tree-id={id}
-        data-tree-key={itemKey}
-        data-ui="TreeItem"
-        {...restProps}
-        onClick={handleClick}
-        ref={setRootElement}
-        role="none"
-      >
-        <TreeItemBox
-          $level={tree.level}
-          aria-expanded={expanded}
-          as={linkAs}
-          data-ui="TreeItem__box"
-          href={href}
-          ref={treeitemRef}
-          role="treeitem"
-          tabIndex={tabIndex}
-        >
-          {content}
-        </TreeItemBox>
-
-        <TreeContext.Provider value={contextValue}>
-          {children && <TreeGroup hidden={!expanded}>{children}</TreeGroup>}
-        </TreeContext.Provider>
-      </StyledTreeItem>
-    )
-  }
-
-  return (
-    <StyledTreeItem
-      data-selected={selected ? '' : undefined}
-      data-ui="TreeItem"
-      data-tree-id={id}
-      data-tree-key={itemKey}
-      {...restProps}
-      aria-expanded={expanded}
-      onClick={handleClick}
-      onKeyDown={handleKeyDown}
-      ref={setRootElement}
-      role="treeitem"
-      tabIndex={tabIndex}
-    >
-      <TreeItemBox $level={tree.level} as="div" data-ui="TreeItem__box">
-        {content}
-      </TreeItemBox>
-
-      <TreeContext.Provider value={contextValue}>
-        {children && <TreeGroup expanded={expanded}>{children}</TreeGroup>}
-      </TreeContext.Provider>
-    </StyledTreeItem>
-  )
-}
-TreeItem.displayName = 'TreeItem'

package/src/core/components/tree/types.ts

@@ -1,25 +0,0 @@
-/**
- * @beta
- */
-export interface TreeState {
-  [key: string]: {element: HTMLElement; expanded: boolean} | undefined
-}
-
-/**
- * @beta
- */
-export interface TreeContextValue {
-  version: 0.0
-  focusedElement: HTMLElement | null
-  level: number
-  path: string[]
-  registerItem: (element: HTMLElement, path: string, expanded: boolean, selected: boolean) => void
-  setExpanded: (path: string, expanded: boolean) => void
-  setFocusedElement: (focusedElement: HTMLElement | null) => void
-  gap: number | number[]
-  /**
-   * @deprecated Use `gap` instead. `space` will be removed in v4.
-   */
-  space: number | number[]
-  state: TreeState
-}

package/src/core/components/tree/useTree.ts

@@ -1,17 +0,0 @@
-import {useContext} from 'react'
-
-import {TreeContext} from './treeContext'
-import {TreeContextValue} from './types'
-
-/**
- * @beta
- */
-export function useTree(): TreeContextValue {
-  const tree = useContext(TreeContext)
-
-  if (!tree) {
-    throw new Error('Tree: missing context value')
-  }
-
-  return tree
-}

package/src/core/constants.ts

@@ -1,79 +0,0 @@
-import type {Transition, Variant} from 'motion/react'
-
-/**
- * @internal
- */
-export const EMPTY_ARRAY: never[] = []
-
-/**
- * @internal
- */
-export const EMPTY_RECORD: Record<string, never> = {}
-
-const POPOVER_MOTION_DURATION = 0.2
-
-/**
- * Shared `framer-motion` variants used by `Popover` and `Tooltip` components.
- * @internal
- */
-export const POPOVER_MOTION_PROPS: {
-  card: {
-    initial: Variant
-    hidden: Variant
-    visible: Variant
-    scaleIn: Variant
-    scaleOut: Variant
-  }
-  children: {
-    hidden: Variant
-    visible: Variant
-  }
-  transition: Transition
-} = {
-  card: {
-    initial: {
-      scale: 0.97,
-      willChange: 'transform',
-    },
-    hidden: {
-      opacity: 0,
-    },
-    visible: {
-      opacity: 1,
-      transition: {
-        when: 'beforeChildren',
-        duration: POPOVER_MOTION_DURATION / 2,
-      },
-    },
-    scaleIn: {
-      scale: 1,
-    },
-    scaleOut: {
-      scale: 0.97,
-    },
-  },
-  children: {
-    hidden: {
-      opacity: 0,
-    },
-    visible: {
-      opacity: 1,
-    },
-  },
-  transition: {
-    type: 'spring',
-    visualDuration: POPOVER_MOTION_DURATION,
-    bounce: 0.25,
-  },
-}
-
-/**
- * @internal
- * @deprecated No longer used.
- */
-export const FLOATING_STATIC_SIDES: Record<string, 'bottom' | 'left' | 'top' | 'right'> = {
-  top: 'bottom',
-  right: 'left',
-  bottom: 'top',
-  left: 'right',
-}