@sanity/ui 4.0.0-v4.1 → 4.0.0

package/src/core/primitives/layer/Layer.tsx

@@ -1,42 +0,0 @@
-import type {ResponsiveProp} from '@sanity/ui/css'
-
-import type {CardElementType, CardOwnProps} from '../../primitives/card/Card'
-import type {Props} from '../../types'
-import {LayerCard} from './LayerCard'
-import {LayerProvider} from './LayerProvider'
-
-/** @public */
-export const DEFAULT_LAYER_ELEMENT = 'div'
-
-/** @public */
-export type LayerOwnProps = CardOwnProps & {
-  /** A callback that fires when the layer becomes the top layer when it was not the top layer before. */
-  onActivate?: (props: {activeElement: HTMLElement | null}) => void
-  zOffset?: ResponsiveProp<number>
-}
-
-/** @public */
-export type LayerElementType = CardElementType
-
-/** @public */
-export type LayerProps<E extends LayerElementType = LayerElementType> = Props<LayerOwnProps, E>
-
-/** @public */
-export function Layer<E extends LayerElementType = typeof DEFAULT_LAYER_ELEMENT>(
-  props: LayerProps<E>,
-): React.JSX.Element {
-  const {
-    as = DEFAULT_LAYER_ELEMENT,
-    children,
-    zOffset = 1,
-    ...rest
-  } = props as LayerProps<typeof DEFAULT_LAYER_ELEMENT>
-
-  return (
-    <LayerProvider zOffset={zOffset}>
-      <LayerCard {...rest} as={as}>
-        {children}
-      </LayerCard>
-    </LayerProvider>
-  )
-}

package/src/core/primitives/layer/LayerCard.tsx

@@ -1,90 +0,0 @@
-import {type FocusEvent, useCallback, useEffect, useImperativeHandle, useRef} from 'react'
-
-import {EMPTY_RECORD} from '../../constants'
-import {containsOrEqualsElement, isHTMLElement} from '../../helpers/element'
-import {Card, type CardElementType} from '../../primitives/card/Card'
-import type {Props} from '../../types'
-import type {LayerElementType, LayerOwnProps} from './Layer'
-import {useLayer} from './useLayer'
-
-/** @internal */
-export const DEFAULT_LAYER_CARD_ELEMENT = 'div'
-
-/** @internal */
-export type LayerCardOwnProps = Omit<LayerOwnProps, 'zOffset'>
-
-/** @internal */
-export type LayerCardElementType = LayerElementType
-
-/** @internal */
-export type LayerCardProps<E extends LayerCardElementType = LayerCardElementType> = Props<
-  LayerCardOwnProps,
-  E
->
-
-/** @internal */
-export function LayerCard<E extends LayerCardElementType = typeof DEFAULT_LAYER_CARD_ELEMENT>(
-  props: LayerCardProps<E>,
-): React.JSX.Element {
-  const {
-    as = DEFAULT_LAYER_CARD_ELEMENT,
-    children,
-    onActivate,
-    onFocus,
-    position = 'relative',
-    ref: forwardedRef,
-    style = EMPTY_RECORD,
-    ...rest
-  } = props as LayerCardProps<typeof DEFAULT_LAYER_CARD_ELEMENT>
-
-  const {zIndex, isTopLayer} = useLayer()
-  const lastFocusedRef = useRef<HTMLElement | null>(null)
-  const ref = useRef<HTMLDivElement | null>(null)
-  const isTopLayerRef = useRef<boolean>(isTopLayer)
-
-  useImperativeHandle<HTMLDivElement | null, HTMLDivElement | null>(forwardedRef, () => ref.current)
-
-  // When the layer very first mounts, it will be the top layer, but we don't want to fire
-  // the callback in that case. We use a ref to track the previous value of isTopLayer to
-  // determine if the layer has become the top layer since the last render.
-  useEffect(() => {
-    const becameTopLayer = isTopLayerRef.current !== isTopLayer && isTopLayer
-
-    if (becameTopLayer) {
-      onActivate?.({activeElement: lastFocusedRef.current})
-    }
-
-    isTopLayerRef.current = isTopLayer
-  }, [isTopLayer, onActivate])
-
-  const handleFocus = useCallback(
-    (event: FocusEvent<HTMLDivElement, Element>) => {
-      // Call the user-provided onFocus handler if any
-      onFocus?.(event)
-
-      const rootElement = ref.current
-      const target = document.activeElement
-
-      if (!isTopLayer || !rootElement || !target) return
-
-      if (isHTMLElement(target) && containsOrEqualsElement(rootElement, target)) {
-        lastFocusedRef.current = target
-      }
-    },
-    [isTopLayer, onFocus],
-  )
-
-  return (
-    <Card
-      data-ui="Layer"
-      {...rest}
-      as={as as CardElementType}
-      onFocus={handleFocus}
-      position={position}
-      ref={ref}
-      style={{...style, zIndex}}
-    >
-      {children}
-    </Card>
-  )
-}

package/src/core/primitives/layer/LayerContext.ts

@@ -1,7 +0,0 @@
-import type {Context} from 'react'
-
-import {createGlobalScopedContext} from '../../lib/createGlobalScopedContext'
-import type {LayerContextValue} from './types'
-
-export const LayerContext: Context<LayerContextValue | null> =
-  createGlobalScopedContext<LayerContextValue | null>('@sanity/ui/v3/layer', null)

package/src/core/primitives/layer/LayerProvider.tsx

@@ -1,106 +0,0 @@
-import type {Breakpoint, ResponsiveProp} from '@sanity/ui/css'
-import {type ReactNode, useCallback, useContext, useEffect, useMemo, useState} from 'react'
-
-import {useMediaIndex} from '../../hooks/useMediaIndex/useMediaIndex'
-import {useResponsiveProp} from '../../hooks/useResponsiveProp'
-import {getLayerContext} from './getLayerContext'
-import {LayerContext} from './LayerContext'
-import type {LayerContextValue} from './types'
-
-/** @public */
-export interface LayerProviderProps {
-  children?: ReactNode
-  zOffset?: ResponsiveProp<number>
-}
-
-/** @public */
-export function LayerProvider(props: LayerProviderProps): React.JSX.Element {
-  const {children, zOffset: zOffsetProp = 0} = props
-
-  // Get parent context values
-  const parentContextValue = useContext(LayerContext)
-  const parent = parentContextValue && getLayerContext(parentContextValue)
-  const parentRegisterChild = parent?.registerChild
-  const parentLevel = parent?.level ?? 0
-
-  // Get level
-  const level = parentLevel + 1
-
-  // Get z-index offset
-  const zOffset = useResponsiveProp(zOffsetProp)
-
-  // Get responsive z-index value
-  const maxMediaIndex = Object.values(zOffset).length - 1
-  const mediaIndex = Math.min(useMediaIndex(), maxMediaIndex) as Breakpoint
-  const zIndex = parent ? parent.zIndex + (zOffset[mediaIndex] ?? 0) : (zOffset[mediaIndex] ?? 0)
-
-  // A state value that is used to keep track of the number of child layers on each level
-  const [, setChildLayers] = useState<Record<number, number>>({})
-
-  // A state value that is used to keep track of the number of child levels
-  const [size, setSize] = useState(0)
-
-  const isTopLayer = size === 0
-
-  const registerChild = useCallback(
-    (childLevel?: number) => {
-      // Register child layers to the parent layer
-      const parentDispose = parentRegisterChild?.(childLevel)
-
-      if (childLevel !== undefined) {
-        setChildLayers((state) => {
-          const prevLen = state[childLevel] ?? 0
-          const nextState = {...state, [childLevel]: prevLen + 1}
-
-          setSize(Object.keys(nextState).length)
-
-          return nextState
-        })
-      } else {
-        // Legacy behavior: if no child level is provided, increment the size by 1
-        setSize((v) => v + 1)
-      }
-
-      return () => {
-        if (childLevel !== undefined) {
-          setChildLayers((state) => {
-            const nextState = {...state}
-
-            if (nextState[childLevel] === 1) {
-              delete nextState[childLevel]
-
-              setSize(Object.keys(nextState).length)
-            } else {
-              nextState[childLevel] -= 1
-            }
-
-            return nextState
-          })
-        } else {
-          // Legacy behavior: if no child level is provided, decrement the size by 1
-          setSize((v) => v - 1)
-        }
-
-        parentDispose?.()
-      }
-    },
-    [parentRegisterChild, setSize, setChildLayers],
-  )
-
-  // Register this layer on mount
-  useEffect(() => parentRegisterChild?.(level), [level, parentRegisterChild])
-
-  const value: LayerContextValue = useMemo(
-    () => ({
-      version: 0.0,
-      isTopLayer,
-      level,
-      registerChild,
-      size,
-      zIndex,
-    }),
-    [isTopLayer, level, registerChild, size, zIndex],
-  )
-
-  return <LayerContext.Provider value={value}>{children}</LayerContext.Provider>
-}

package/src/core/primitives/layer/__workshop__/MultipleRoots.tsx

@@ -1,49 +0,0 @@
-import {Card, Layer, LayerProvider, Stack} from '@sanity/ui'
-
-import {LayerDebugInfo} from './_debug'
-
-export default function MultipleRootsStory(): React.JSX.Element {
-  return (
-    <Stack gap={4}>
-      <LayerProvider zOffset={100}>
-        <Card padding={3} shadow={1}>
-          <Stack gap={3}>
-            <LayerDebugInfo />
-            <Layer>
-              <Card padding={3} shadow={1}>
-                <Stack gap={3}>
-                  <LayerDebugInfo />
-                  <Layer>
-                    <Card padding={3} shadow={1}>
-                      <LayerDebugInfo />
-                    </Card>
-                  </Layer>
-                </Stack>
-              </Card>
-            </Layer>
-          </Stack>
-        </Card>
-      </LayerProvider>
-
-      <LayerProvider zOffset={200}>
-        <Card as={Layer} padding={3} shadow={5} style={{top: -50, left: 30}}>
-          <Stack gap={3}>
-            <LayerDebugInfo />
-            <Layer>
-              <Card padding={3} shadow={1}>
-                <Stack gap={3}>
-                  <LayerDebugInfo />
-                  <Layer>
-                    <Card padding={3} shadow={1}>
-                      <LayerDebugInfo />
-                    </Card>
-                  </Layer>
-                </Stack>
-              </Card>
-            </Layer>
-          </Stack>
-        </Card>
-      </LayerProvider>
-    </Stack>
-  )
-}

package/src/core/primitives/layer/__workshop__/Nested.tsx

@@ -1,98 +0,0 @@
-import {CloseIcon} from '@sanity/icons'
-import {Box, Button, Card, Flex, Layer, LayerProvider, Stack, Text} from '@sanity/ui'
-import {useCallback, useState} from 'react'
-
-import {LayerDebugInfo} from './_debug'
-
-export default function PlainStory(): React.JSX.Element {
-  return (
-    <Box padding={3}>
-      <Root />
-      <Root />
-      <Root />
-    </Box>
-  )
-}
-
-function Root() {
-  const [open, setOpen] = useState(false)
-  const handleOpen = useCallback(() => setOpen(true), [])
-  const handleClose = useCallback(() => setOpen(false), [])
-
-  return (
-    <LayerProvider>
-      <Card radius={2} shadow={1}>
-        <Box padding={3}>
-          <Text>
-            <strong>Root layer</strong>
-          </Text>
-        </Box>
-        <Box padding={3}>
-          <Stack gap={3}>
-            <LayerDebugInfo id="layer-debug-info-1" />
-            <Button id="open-layer-1" mode="ghost" onClick={handleOpen} text="Open layer 1" />
-            {open && (
-              <Layer style={{display: 'flex', alignItems: 'center', justifyContent: 'center'}}>
-                <Layer1 onClose={handleClose} />
-              </Layer>
-            )}
-          </Stack>
-        </Box>
-      </Card>
-    </LayerProvider>
-  )
-}
-
-function Layer1({onClose}: {onClose: () => void}) {
-  const [open, setOpen] = useState(false)
-  const handleOpen = useCallback(() => setOpen(true), [])
-  const handleClose = useCallback(() => setOpen(false), [])
-
-  return (
-    <Card radius={2} shadow={3}>
-      <Flex>
-        <Box flex={1} padding={3}>
-          <Text>
-            <strong>Layer 1</strong>
-          </Text>
-        </Box>
-        <Box padding={1}>
-          <Button icon={CloseIcon} mode="bleed" onClick={onClose} padding={2} />
-        </Box>
-      </Flex>
-      <Box padding={3}>
-        <Stack gap={3}>
-          <LayerDebugInfo />
-          <Button id="open-layer-2" mode="ghost" onClick={handleOpen} text="Open layer 2" />
-          {open && (
-            <Layer style={{display: 'flex', alignItems: 'center', justifyContent: 'center'}}>
-              <Layer2 onClose={handleClose} />
-            </Layer>
-          )}
-        </Stack>
-      </Box>
-    </Card>
-  )
-}
-
-function Layer2({onClose}: {onClose: () => void}) {
-  return (
-    <Card radius={2} shadow={3}>
-      <Flex>
-        <Box flex={1} padding={3}>
-          <Text>
-            <strong>Layer 2</strong>
-          </Text>
-        </Box>
-        <Box padding={1}>
-          <Button icon={CloseIcon} mode="bleed" onClick={onClose} padding={2} />
-        </Box>
-      </Flex>
-      <Box padding={3}>
-        <Stack gap={3}>
-          <LayerDebugInfo />
-        </Stack>
-      </Box>
-    </Card>
-  )
-}

package/src/core/primitives/layer/__workshop__/ResponsiveZOffset.tsx

@@ -1,17 +0,0 @@
-import {Layer} from '@sanity/ui'
-
-import {LayerDebugInfo} from './_debug'
-
-export default function ResponsiveZOffsetStory(): React.JSX.Element {
-  return (
-    <Layer
-      id="responsive-layer"
-      padding={[1, 2, 3, 4, 5, 6, 7]}
-      sizing="border"
-      shadow={1}
-      zOffset={[1, 2, 3, 4, 5, 6, 7]}
-    >
-      <LayerDebugInfo />
-    </Layer>
-  )
-}

package/src/core/primitives/layer/__workshop__/_debug.tsx

@@ -1,17 +0,0 @@
-import {Code, useLayer} from '@sanity/ui'
-
-export function LayerDebugInfo(props: {id?: string}): React.JSX.Element {
-  const {id} = props
-  const layer = useLayer()
-
-  return (
-    <Code id={id} size={1}>
-      {[
-        //
-        `isTopLayer=${layer.isTopLayer}`,
-        `size=${layer.size}`,
-        `zIndex=${layer.zIndex}`,
-      ].join('\n')}
-    </Code>
-  )
-}

package/src/core/primitives/layer/__workshop__/index.ts

@@ -1,26 +0,0 @@
-import type {WorkshopScope} from '@sanity/ui-workshop'
-import {lazy} from 'react'
-
-const scope: WorkshopScope = {
-  name: 'primitives/layer',
-  title: 'Layer',
-  stories: [
-    {
-      name: 'nested',
-      title: 'Nested',
-      component: lazy(() => import('./Nested')),
-    },
-    {
-      name: 'multiple-roots',
-      title: 'Multiple roots',
-      component: lazy(() => import('./MultipleRoots')),
-    },
-    {
-      name: 'responsive-z-offset',
-      title: 'Responsive z-offset',
-      component: lazy(() => import('./ResponsiveZOffset')),
-    },
-  ],
-}
-
-export default scope

package/src/core/primitives/layer/getLayerContext.test.ts

@@ -1,32 +0,0 @@
-import {describe, expect, it} from 'vitest'
-
-import {getLayerContext} from './getLayerContext'
-import type {LayerContextValue} from './types'
-
-describe('getLayerContext', () => {
-  describe('0.0', () => {
-    it('should convert 0.0 to 0.0', () => {
-      const contextValue: LayerContextValue = {
-        version: 0.0,
-        isTopLayer: true,
-        level: 0,
-        registerChild: () => () => {
-          //
-        },
-        size: 0,
-        zIndex: 0,
-      }
-
-      const result = getLayerContext(contextValue)
-
-      expect(result).toEqual({
-        version: 0.0,
-        isTopLayer: true,
-        level: 0,
-        registerChild: expect.any(Function),
-        size: 0,
-        zIndex: 0,
-      })
-    })
-  })
-})

package/src/core/primitives/layer/getLayerContext.ts

@@ -1,21 +0,0 @@
-import {isRecord} from '../../lib/isRecord'
-import type {LayerContextValue} from './types'
-
-export function getLayerContext(contextValue: LayerContextValue): LayerContextValue {
-  // 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
-  if (!isRecord(contextValue) || contextValue.version !== 0.0) {
-    throw new Error('the context value is not compatible')
-  }
-
-  if (!contextValue) {
-    throw new Error('components using `useLayer()` should be wrapped in a <LayerProvider>.')
-  }
-
-  if (contextValue.version === 0.0) {
-    return contextValue
-  }
-
-  throw new Error('could not get layer context')
-}

package/src/core/primitives/layer/types.ts

@@ -1,9 +0,0 @@
-/** @public */
-export interface LayerContextValue {
-  version: 0.0
-  isTopLayer: boolean
-  level?: number
-  registerChild: (childLevel?: number) => () => void
-  size: number
-  zIndex: number
-}

package/src/core/primitives/layer/useLayer.ts

@@ -1,24 +0,0 @@
-import {useContext} from 'react'
-
-import {getLayerContext} from './getLayerContext'
-import {LayerContext} from './LayerContext'
-import type {LayerContextValue} from './types'
-
-/** @public */
-export function useLayer(): LayerContextValue {
-  const value = useContext(LayerContext)
-
-  if (!value) {
-    throw new Error('useLayer(): missing context value')
-  }
-
-  try {
-    return getLayerContext(value)
-  } catch (err) {
-    if (err instanceof Error) {
-      throw new Error(`useLayer(): ${err.message}`)
-    } else {
-      throw new Error(`useLayer(): ${err}`)
-    }
-  }
-}