@sanity/ui 3.0.0-static.11 → 3.0.0-static.13

package/src/ui/components/breadcrumbs/breadcrumbs.tsx

@@ -2,8 +2,6 @@ import {breadcrumbs, composeClassNames, GapStyleProps} from '@sanity/ui/css'
 import {Space} from '@sanity/ui/theme'
 import {
   Children,
-  ForwardedRef,
-  forwardRef,
   Fragment,
   isValidElement,
   ReactNode,
@@ -15,27 +13,35 @@ import {
 
 import {useClickOutsideEvent} from '../../hooks'
 import {Box, Button, ButtonProps, Flex, Popover, Stack, Text} from '../../primitives'
-import {Props} from '../../types'
+import {ComponentType, Props} from '../../types'
 
-/**
- * @beta
- */
-export interface BreadcrumbsProps extends GapStyleProps {
-  expandButton?: Omit<ButtonProps, 'onClick' | 'selected'>
+/** @beta */
+export const DEFAULT_BREADCRUMBS_ELEMENT = 'nav'
+
+/** @beta */
+export type BreadcrumbsOwnProps = GapStyleProps & {
+  expandButton?: Omit<ButtonProps<'button'>, 'as' | 'onClick' | 'selected'>
   maxLength?: number
   separator?: ReactNode
   /** @deprecated - Use `gap`, `gapX`, `gapY` instead */
   space?: number | number[]
 }
 
-/**
- * @beta
- */
-export const Breadcrumbs = forwardRef(function Breadcrumbs(
-  props: Props<BreadcrumbsProps, 'div'>,
-  ref: ForwardedRef<HTMLDivElement>,
+/** @beta */
+export type BreadcrumbsElementType = 'div' | 'nav' | ComponentType
+
+/** @beta */
+export type BreadcrumbsProps<E extends BreadcrumbsElementType = BreadcrumbsElementType> = Props<
+  BreadcrumbsOwnProps,
+  E
+>
+
+/** @beta */
+export function Breadcrumbs<E extends BreadcrumbsElementType = typeof DEFAULT_BREADCRUMBS_ELEMENT>(
+  props: BreadcrumbsProps<E>,
 ) {
   const {
+    as = DEFAULT_BREADCRUMBS_ELEMENT,
     children,
     className,
     expandButton: expandButtonProps,
@@ -47,8 +53,9 @@ export const Breadcrumbs = forwardRef(function Breadcrumbs(
     separator,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     space: _spaceProp,
-    ...restProps
-  } = props
+    ...rest
+  } = props as BreadcrumbsProps<typeof DEFAULT_BREADCRUMBS_ELEMENT>
+
   const [open, setOpen] = useState(false)
   const expandElementRef = useRef<HTMLButtonElement | null>(null)
   const popoverElementRef = useRef<HTMLDivElement | null>(null)
@@ -102,13 +109,12 @@ export const Breadcrumbs = forwardRef(function Breadcrumbs(
 
   return (
     <Flex
-      as="nav"
+      as={as}
       data-ui="Breadcrumbs"
-      {...restProps}
+      {...rest}
       className={composeClassNames(className, breadcrumbs())}
       gapX={gapX}
       gapY={gapY}
-      ref={ref}
     >
       {items.map((item, itemIndex) => (
         <Fragment key={itemIndex}>
@@ -122,6 +128,6 @@ export const Breadcrumbs = forwardRef(function Breadcrumbs(
       ))}
     </Flex>
   )
-})
+}
 
-Breadcrumbs.displayName = 'ForwardRef(Breadcrumbs)'
+Breadcrumbs.displayName = 'Breadcrumbs'

package/src/ui/components/dialog/dialog.tsx

@@ -1,285 +1,74 @@
-import {CloseIcon} from '@sanity/icons'
 import {
   composeClassNames,
   ContainerStyleProps,
   dialog,
-  dialogCardRoot,
   dialogContainer,
-  dialogContent,
-  dialogFooter,
-  dialogHeader,
-  dialogLayout,
-  PaddingStyleProps,
-  RadiusStyleProps,
   ResponsiveProp,
-  ShadowStyleProps,
 } from '@sanity/ui/css'
 import {ThemeColorSchemeKey} from '@sanity/ui/theme'
-import {
-  FocusEvent,
-  ForwardedRef,
-  forwardRef,
-  ReactNode,
-  useCallback,
-  useEffect,
-  useImperativeHandle,
-  useRef,
-} from 'react'
+import {FocusEvent, ForwardedRef, ReactNode, useCallback, useRef} from 'react'
 
 import {Z_OFFSETS} from '../../constants'
-import {
-  containsOrEqualsElement,
-  focusFirstDescendant,
-  focusLastDescendant,
-  isHTMLElement,
-} from '../../helpers'
-import {
-  useArrayProp,
-  useClickOutsideEvent,
-  useGlobalKeyDown,
-  usePrefersReducedMotion,
-} from '../../hooks'
-import {Box, Button, Card, Container, Flex, Text} from '../../primitives'
-import {CardTone, DialogPosition, Props, Radius} from '../../types'
-import {Layer, LayerProps, Portal, useBoundaryElement, useLayer, usePortal} from '../../utils'
+import {focusFirstDescendant, focusLastDescendant, isHTMLElement} from '../../helpers'
+import {useArrayProp, usePrefersReducedMotion} from '../../hooks'
+import {Container} from '../../primitives'
+import {CardTone, ComponentType, DialogPosition, Props, Radius} from '../../types'
+import {Layer, LayerOwnProps, LayerProps, Portal, useBoundaryElement, usePortal} from '../../utils'
+import {DialogCard} from './dialogCard'
+import {isTargetWithinScope} from './isTargetWithinScope'
 import {useDialog} from './useDialog'
 
-/**
- * @public
- */
-export interface DialogProps extends ContainerStyleProps, PaddingStyleProps, ShadowStyleProps {
-  /**
-   * @beta
-   */
-  __unstable_autoFocus?: boolean
-  /**
-   * @beta
-   */
-  __unstable_hideCloseButton?: boolean
-  /**
-   * Whether the dialog should animate in on mount.
-   *
-   * @beta
-   * @defaultValue false
-   */
-  animate?: boolean
-  cardRadius?: ResponsiveProp<Radius>
-  contentRef?: ForwardedRef<HTMLDivElement>
-  footer?: ReactNode
-  header?: ReactNode
-  id: string
-  /** A callback that fires when the dialog becomes the top layer when it was not the top layer before. */
-  onActivate?: LayerProps['onActivate']
-  onClickOutside?: () => void
-  onClose?: () => void
-  open?: boolean
-  portal?: string
-  position?: DialogPosition | DialogPosition[]
-  scheme?: ThemeColorSchemeKey
-  tone?: CardTone
-  zOffset?: number | number[]
-}
-
-interface DialogCardProps extends ContainerStyleProps, RadiusStyleProps, ShadowStyleProps {
-  /**
-   * @beta
-   */
-  __unstable_autoFocus: boolean
-  /**
-   * @beta
-   */
-  __unstable_hideCloseButton: boolean
-  children: ReactNode
-  contentRef?: ForwardedRef<HTMLDivElement>
-  footer: ReactNode
-  header: ReactNode
-  id: string
-  onClickOutside?: () => void
-  onClose?: () => void
-  portal?: string
-  // radius: Radius | Radius[]
-  scheme?: ThemeColorSchemeKey
-  // shadow: number | number[]
-  tone?: CardTone
-}
-
-function isTargetWithinScope(
-  boundaryElement: HTMLElement | null,
-  portalElement: HTMLElement | null,
-  target: Node,
-): boolean {
-  if (!boundaryElement || !portalElement) return true
-
-  return (
-    containsOrEqualsElement(boundaryElement, target) ||
-    containsOrEqualsElement(portalElement, target)
-  )
-}
-
-const DialogCard = forwardRef(function DialogCard(
-  props: DialogCardProps,
-  forwardedRef: ForwardedRef<HTMLDivElement>,
-) {
-  const {
-    __unstable_autoFocus: autoFocus,
-    __unstable_hideCloseButton: hideCloseButton,
-    children,
-    contentRef: forwardedContentRef,
-    footer,
-    header,
-    id,
-    onClickOutside,
-    onClose,
-    portal: portalProp,
-    radius: radiusProp,
-    scheme,
-    shadow: shadowProp = 4,
-    tone,
-    width: widthProp,
-  } = props
-  const portal = usePortal()
-  const portalElement = portalProp ? portal.elements?.[portalProp] || null : portal.element
-  const boundaryElement = useBoundaryElement().element
-  const radius = useArrayProp(radiusProp)
-  const shadow = useArrayProp(shadowProp)
-  const width = useArrayProp(widthProp)
-  const ref = useRef<HTMLDivElement | null>(null)
-  const contentRef = useRef<HTMLDivElement | null>(null)
-  const layer = useLayer()
-  const {isTopLayer} = layer
-  const labelId = `${id}_label`
-  const showCloseButton = Boolean(onClose) && hideCloseButton === false
-  const showHeader = Boolean(header) || showCloseButton
-
-  useImperativeHandle<HTMLDivElement | null, HTMLDivElement | null>(forwardedRef, () => ref.current)
-  useImperativeHandle<HTMLDivElement | null, HTMLDivElement | null>(
-    forwardedContentRef,
-    () => contentRef.current,
-  )
-
-  useEffect(() => {
-    if (!autoFocus) return
-
-    // On mount: focus the first focusable element
-    if (ref.current) {
-      focusFirstDescendant(ref.current)
-    }
-  }, [autoFocus, ref])
-
-  useGlobalKeyDown(
-    useCallback(
-      (event: KeyboardEvent) => {
-        if (!isTopLayer || !onClose) return
-
-        const target = document.activeElement
-
-        if (target && !isTargetWithinScope(boundaryElement, portalElement, target)) {
-          // Ignore key presses when the focused element is outside of scope
-          return
-        }
-
-        if (event.key === 'Escape') {
-          event.preventDefault()
-          event.stopPropagation()
-          onClose()
-        }
-      },
-      [boundaryElement, isTopLayer, onClose, portalElement],
-    ),
-  )
-
-  useClickOutsideEvent(
-    isTopLayer &&
-      onClickOutside &&
-      ((event) => {
-        const target = event.target as Node | null
-
-        if (target && !isTargetWithinScope(boundaryElement, portalElement, target)) {
-          // Ignore clicks outside of the scope
-          return
-        }
-
-        onClickOutside()
-      }),
-    () => [ref.current],
-  )
-
-  return (
-    <Container
-      align="center"
-      className={dialogContainer()}
-      data-ui="DialogCard"
-      direction="column"
-      display="flex"
-      justify="center"
-      width={width}
-    >
-      <Card
-        className={dialogCardRoot()}
-        display="flex"
-        radius={radius}
-        ref={ref}
-        scheme={scheme}
-        shadow={shadow}
-        tone={tone}
-      >
-        <Flex className={dialogLayout()} direction="column" flex={1}>
-          {showHeader && (
-            <Box className={dialogHeader()} position="relative">
-              <Flex align="flex-start" padding={3}>
-                <Box flex={1} padding={2}>
-                  {header && (
-                    <Text id={labelId} size={1} weight="semibold">
-                      {header}
-                    </Text>
-                  )}
-                </Box>
-                {showCloseButton && (
-                  <Box flex="none">
-                    <Button
-                      aria-label="Close dialog"
-                      disabled={!onClose}
-                      icon={CloseIcon}
-                      mode="bleed"
-                      onClick={onClose}
-                      padding={2}
-                    />
-                  </Box>
-                )}
-              </Flex>
-            </Box>
-          )}
-          <Box
-            className={dialogContent()}
-            flex={1}
-            overflow="auto"
-            position="relative"
-            ref={contentRef}
-            tabIndex={-1}
-          >
-            {children}
-          </Box>
-          {footer && (
-            <Box className={dialogFooter()} position="relative">
-              {footer}
-            </Box>
-          )}
-        </Flex>
-      </Card>
-    </Container>
-  )
-})
-
-DialogCard.displayName = 'ForwardRef(DialogCard)'
+/** @public */
+export const DEFAULT_DIALOG_ELEMENT = 'div'
+
+/** @public */
+export type DialogOwnProps = ContainerStyleProps &
+  Omit<LayerOwnProps, 'width'> & {
+    /**
+     * @beta
+     */
+    __unstable_autoFocus?: boolean
+    /**
+     * @beta
+     */
+    __unstable_hideCloseButton?: boolean
+    /**
+     * Whether the dialog should animate in on mount.
+     *
+     * @beta
+     * @defaultValue false
+     */
+    animate?: boolean
+    cardRadius?: ResponsiveProp<Radius>
+    contentRef?: ForwardedRef<HTMLDivElement>
+    footer?: ReactNode
+    header?: ReactNode
+    id: string
+    /** A callback that fires when the dialog becomes the top layer when it was not the top layer before. */
+    onActivate?: LayerProps['onActivate']
+    onClickOutside?: () => void
+    onClose?: () => void
+    open?: boolean
+    portal?: string
+    position?: DialogPosition | DialogPosition[]
+    scheme?: ThemeColorSchemeKey
+    tone?: CardTone
+    zOffset?: number | number[]
+  }
+
+/** @public */
+export type DialogElementType = 'div' | 'span' | ComponentType
+
+/** @public */
+export type DialogProps<E extends DialogElementType = DialogElementType> = Props<DialogOwnProps, E>
 
 /**
  * The Dialog component.
  *
  * @public
  */
-export const Dialog = forwardRef(function Dialog(
-  props: Props<DialogProps, 'div'>,
-  ref: ForwardedRef<HTMLDivElement>,
+export function Dialog<E extends DialogElementType = typeof DEFAULT_DIALOG_ELEMENT>(
+  props: DialogProps<E>,
 ) {
   const context = useDialog()
   const {
@@ -287,7 +76,6 @@ export const Dialog = forwardRef(function Dialog(
     __unstable_hideCloseButton: hideCloseButton = false,
     animate: _animate = false,
     cardRadius: cardRadiusProp = 4,
-    // cardShadow = 3,
     children,
     className,
     contentRef,
@@ -302,12 +90,13 @@ export const Dialog = forwardRef(function Dialog(
     portal: portalProp,
     position: _positionProp,
     scheme,
-    shadow: cardShadow,
-    width: widthProp = 0,
+    shadow: cardShadow = 4,
+    width = 0,
     zOffset: _zOffsetProp,
     tone,
-    ...restProps
-  } = props
+    ...rest
+  } = props as DialogProps<typeof DEFAULT_DIALOG_ELEMENT>
+
   const positionProp = _positionProp ?? context.position ?? 'fixed'
   const zOffsetProp = _zOffsetProp ?? context.zOffset ?? Z_OFFSETS.dialog
   const prefersReducedMotion = usePrefersReducedMotion()
@@ -317,7 +106,7 @@ export const Dialog = forwardRef(function Dialog(
   const boundaryElement = useBoundaryElement().element
   const cardRadius = useArrayProp(cardRadiusProp)
   const position = useArrayProp(positionProp)
-  const width = useArrayProp(widthProp)
+  // const width = useArrayProp(widthProp)
   const zOffset = useArrayProp(zOffsetProp)
   const preDivRef = useRef<HTMLDivElement | null>(null)
   const postDivRef = useRef<HTMLDivElement | null>(null)
@@ -384,7 +173,7 @@ export const Dialog = forwardRef(function Dialog(
   return (
     <Portal __unstable_name={portalProp}>
       <Layer
-        {...restProps}
+        {...rest}
         aria-labelledby={labelId}
         aria-modal
         className={composeClassNames(className, dialog())}
@@ -397,36 +186,45 @@ export const Dialog = forwardRef(function Dialog(
         onFocus={handleFocus}
         padding={padding}
         position={position}
-        ref={ref}
         role="dialog"
         zOffset={zOffset}
       >
         {/* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */}
         <div ref={preDivRef} tabIndex={0} />
-        <DialogCard
-          __unstable_autoFocus={autoFocus}
-          __unstable_hideCloseButton={hideCloseButton}
-          contentRef={contentRef}
-          footer={footer}
-          header={header}
-          id={id}
-          onClickOutside={onClickOutside}
-          onClose={onClose}
-          portal={portalProp}
-          radius={cardRadius}
-          ref={cardRef}
-          scheme={scheme}
-          shadow={cardShadow}
-          tone={tone}
+        <Container
+          align="center"
+          className={dialogContainer()}
+          data-ui="DialogCard"
+          direction="column"
+          display="flex"
+          justify="center"
           width={width}
         >
-          {children}
-        </DialogCard>
+          <DialogCard
+            __unstable_autoFocus={autoFocus}
+            __unstable_hideCloseButton={hideCloseButton}
+            contentRef={contentRef}
+            footer={footer}
+            header={header}
+            id={id}
+            onClickOutside={onClickOutside}
+            onClose={onClose}
+            portal={portalProp}
+            radius={cardRadius}
+            ref={cardRef}
+            scheme={scheme}
+            shadow={cardShadow}
+            tone={tone}
+            width={width}
+          >
+            {children}
+          </DialogCard>
+        </Container>
         {/* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */}
         <div ref={postDivRef} tabIndex={0} />
       </Layer>
     </Portal>
   )
-})
+}
 
-Dialog.displayName = 'ForwardRef(Dialog)'
+Dialog.displayName = 'Dialog'