@sanity/ui 3.0.0-static.2 → 3.0.0-static.20

package/src/core/primitives/avatar/__workshop__/withinMenuItem.tsx

@@ -13,7 +13,7 @@ import {
 import {useBoolean} from '@sanity/ui-workshop'
 
 export default function WithinMenuItemStory() {
-  const disabled = useBoolean('Disabled', false, 'Props')
+  const disabled = useBoolean('Disabled', false)
 
   return (
     <Container width={1}>

package/src/core/primitives/avatar/avatar.tsx

@@ -1,66 +1,72 @@
 import {
+  _composeClassNames,
   avatar,
   avatarArrow,
   avatarImage,
   avatarInitials,
-  composeClassNames,
-  ResponsiveProp,
+  type ResponsiveProp,
 } from '@sanity/ui/css'
-import {AvatarSize, ThemeColorAvatarColorKey} from '@sanity/ui/theme'
-import {ForwardedRef, forwardRef, useCallback, useEffect, useMemo, useState} from 'react'
-import ReactIs from 'react-is'
+import type {AvatarColor} from '@sanity/ui/theme'
+import {useCallback, useEffect, useMemo, useState} from 'react'
 
 import {useArrayProp} from '../../hooks'
-import {AvatarPosition, AvatarStatus, Props} from '../../types'
+import type {AvatarPosition, AvatarSize, AvatarStatus, ComponentType, Props} from '../../types'
 import {Box} from '../box'
 import {Label} from '../label'
 
-/**
- * @public
- */
-export interface AvatarProps {
+/** @public */
+export const DEFAULT_AVATAR_ELEMENT = 'div'
+
+/** @public */
+export interface AvatarOwnProps {
   /** @beta */
   __unstable_hideInnerStroke?: boolean
   animateArrowFrom?: AvatarPosition
   arrowPosition?: AvatarPosition
-  color?: ThemeColorAvatarColorKey
+  color?: AvatarColor
   initials?: string
   onImageLoadError?: (event: Error) => void
   size?: ResponsiveProp<AvatarSize>
   src?: string
   /**
    * The status of the entity this Avatar represents.
-   * @alpha
+   * @deprecated Will be removed in next major version.
    */
   status?: AvatarStatus
   title?: string
 }
 
+/** @public */
+export type AvatarElementType = 'a' | 'button' | 'div' | 'span' | ComponentType
+
+/** @public */
+export type AvatarProps<E extends AvatarElementType = AvatarElementType> = Props<AvatarOwnProps, E>
+
 /**
  * Avatars are used to represent people and other agents (e.g. bots).
  *
  * @public
  */
-export const Avatar = forwardRef(function Avatar(
-  props: Props<AvatarProps, 'div'>,
-  ref: ForwardedRef<HTMLDivElement>,
+export function Avatar<E extends AvatarElementType = typeof DEFAULT_AVATAR_ELEMENT>(
+  props: AvatarProps<E>,
 ) {
   const {
     __unstable_hideInnerStroke,
-    as: asProp,
+    as: Element = DEFAULT_AVATAR_ELEMENT,
     className,
-    color = 'gray',
+    color = 'magenta',
     src,
     title,
     initials,
     onImageLoadError,
     arrowPosition: arrowPositionProp,
     animateArrowFrom,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     status = 'online',
     size: sizeProp = 1,
-    ...restProps
-  } = props
-  const As = ReactIs.isValidElementType(asProp) ? asProp : 'div'
+    ...rest
+  } = props as AvatarProps<typeof DEFAULT_AVATAR_ELEMENT>
+
   const size = useArrayProp(sizeProp)
 
   const [arrowPosition, setArrowPosition] = useState<AvatarPosition | undefined>(
@@ -103,17 +109,14 @@ export const Avatar = forwardRef(function Avatar(
   )
 
   return (
-    <As
-      // data-as={typeof As === 'string' ? As : undefined}
+    <Element
       data-hide-inner-stroke={__unstable_hideInnerStroke ? '' : undefined}
       data-ui="Avatar"
-      {...restProps}
+      {...rest}
       aria-label={title}
-      className={composeClassNames(className, avatar({color, size: sizeProp}))}
+      className={_composeClassNames(className, avatar({color, size: sizeProp}))}
       data-arrow-position={arrowPosition}
       data-image-error={imageError ? '' : undefined}
-      data-status={status}
-      ref={ref}
       title={title}
     >
       <span className={avatarArrow()}>
@@ -134,13 +137,7 @@ export const Avatar = forwardRef(function Avatar(
         position="absolute"
         inset={0}
       >
-        <Label
-          align="center"
-          as="span"
-          size={initialsSize}
-          style={{color: 'inherit'}}
-          weight="medium"
-        >
+        <Label align="center" as="span" size={initialsSize} weight="medium">
           {initials}
         </Label>
       </Box>
@@ -151,8 +148,8 @@ export const Avatar = forwardRef(function Avatar(
           <span />
         </Box>
       )}
-    </As>
+    </Element>
   )
-})
+}
 
-Avatar.displayName = 'ForwardRef(Avatar)'
+Avatar.displayName = 'Avatar'

package/src/core/primitives/avatar/avatarCounter.tsx

@@ -1,34 +1,42 @@
-import {avatarCounter, composeClassNames, ResponsiveProp} from '@sanity/ui/css'
-import {AvatarSize} from '@sanity/ui/theme'
-import {ForwardedRef, forwardRef, useMemo} from 'react'
+import {_composeClassNames, avatarCounter, type ResponsiveProp} from '@sanity/ui/css'
+import type {AvatarSize, FontLabelSize} from '@sanity/ui/theme'
+import {useMemo} from 'react'
 
 import {useArrayProp} from '../../hooks'
-import {Props} from '../../types'
-import {Box, BoxProps} from '../box'
+import type {ComponentType, Props} from '../../types'
+import {Box} from '../box'
 import {Label} from '../label'
 
-/**
- * @public
- */
-export interface AvatarCounterProps
-  extends Omit<BoxProps, 'align' | 'className' | 'display' | 'justify' | 'paddingX' | 'sizing'> {
+/** @public */
+export const DEFAULT_AVATAR_COUNTER_ELEMENT = 'div'
+
+/** @public */
+export interface AvatarCounterOwnProps {
   count: number
   size?: ResponsiveProp<AvatarSize>
-  /** @deprecated No longer supported. */
-  tone?: 'navbar'
 }
 
-/**
- * @public
- */
-export const AvatarCounter = forwardRef(function AvatarCounter(
-  props: Props<AvatarCounterProps, 'div'>,
-  ref: ForwardedRef<HTMLDivElement>,
-) {
-  const {className, count, size: sizeProp = 1, ...restProps} = props
+/** @public */
+export type AvatarCounterElementType = 'button' | 'div' | 'span' | ComponentType
+
+/** @public */
+export type AvatarCounterProps<E extends AvatarCounterElementType = AvatarCounterElementType> =
+  Props<AvatarCounterOwnProps, E>
+
+/** @public */
+export function AvatarCounter<
+  E extends AvatarCounterElementType = typeof DEFAULT_AVATAR_COUNTER_ELEMENT,
+>(props: AvatarCounterProps<E>) {
+  const {
+    as = DEFAULT_AVATAR_COUNTER_ELEMENT,
+    className,
+    count,
+    size: sizeProp = 1,
+    ...rest
+  } = props as AvatarCounterProps<typeof DEFAULT_AVATAR_COUNTER_ELEMENT>
   const size = useArrayProp(sizeProp)
 
-  const fontSize = useMemo(
+  const labelSize: FontLabelSize[] = useMemo(
     () =>
       size.map((s) => {
         if (s === 1) return 1
@@ -43,20 +51,20 @@ export const AvatarCounter = forwardRef(function AvatarCounter(
   return (
     <Box
       data-ui="AvatarCounter"
-      {...restProps}
+      {...rest}
       align="center"
-      className={composeClassNames(className, avatarCounter({size}))}
+      as={as}
+      className={_composeClassNames(className, avatarCounter({size}))}
       display="flex"
       justify="center"
       paddingX={2}
-      ref={ref}
       sizing="border"
     >
-      <Label align="center" as="span" size={fontSize} weight="medium">
+      <Label align="center" as="span" size={labelSize} weight="medium">
         {count}
       </Label>
     </Box>
   )
-})
+}
 
-AvatarCounter.displayName = 'ForwardRef(AvatarCounter)'
+AvatarCounter.displayName = 'AvatarCounter'

package/src/core/primitives/avatar/avatarStack.tsx

@@ -1,22 +1,21 @@
-import {avatarStack, composeClassNames, ResponsiveProp} from '@sanity/ui/css'
-import {AvatarSize} from '@sanity/ui/theme'
-import {Children, cloneElement, ForwardedRef, forwardRef, isValidElement, ReactElement} from 'react'
+import {_composeClassNames, avatarStack, type ResponsiveProp} from '@sanity/ui/css'
+import type {AvatarSize} from '@sanity/ui/theme'
+import {Children, cloneElement, isValidElement, type ReactElement} from 'react'
 
 import {useArrayProp} from '../../hooks'
-import {Props} from '../../types'
-import {Box, BoxProps} from '../box'
-import {AvatarProps} from './avatar'
+import type {ComponentType, Props} from '../../types'
+import {Box, type BoxOwnProps} from '../box'
+import type {AvatarProps} from './avatar'
 import {AvatarCounter} from './avatarCounter'
 
-/**
- * @public
- */
-export type AvatarStackChild = ReactElement<Props<AvatarProps, 'div'>> | null | undefined | false
+/** @public */
+export const DEFAULT_AVATAR_STACK_ELEMENT = 'div'
 
-/**
- * @public
- */
-export interface AvatarStackProps extends Omit<BoxProps, 'align' | 'className' | 'display'> {
+/** @public */
+export type AvatarStackChild = ReactElement<AvatarProps<'div'>> | null | undefined | false
+
+/** @public */
+export type AvatarStackOwnProps = Omit<BoxOwnProps, 'align' | 'display'> & {
   children: AvatarStackChild | AvatarStackChild[]
   maxLength?: number
   size?: ResponsiveProp<AvatarSize>
@@ -24,22 +23,30 @@ export interface AvatarStackProps extends Omit<BoxProps, 'align' | 'className' |
   tone?: 'navbar'
 }
 
-/**
- * @public
- */
-export const AvatarStack = forwardRef(function AvatarStack(
-  props: Props<AvatarStackProps, 'div'>,
-  ref: ForwardedRef<HTMLDivElement>,
+/** @public */
+export type AvatarStackElementType = 'div' | 'span' | ComponentType
+
+/** @public */
+export type AvatarStackProps<E extends AvatarStackElementType = AvatarStackElementType> = Props<
+  AvatarStackOwnProps,
+  E
+>
+
+/** @public */
+export function AvatarStack<E extends AvatarStackElementType = typeof DEFAULT_AVATAR_STACK_ELEMENT>(
+  props: AvatarStackProps<E>,
 ) {
   const {
+    as = DEFAULT_AVATAR_STACK_ELEMENT,
     children: childrenProp,
     className,
     maxLength: maxLengthProp = 4,
     size: sizeProp = 1,
-    ...restProps
-  } = props
+    ...rest
+  } = props as AvatarStackProps<typeof DEFAULT_AVATAR_STACK_ELEMENT>
+
   const children = Children.toArray(childrenProp).filter(isValidElement) as ReactElement<
-    Props<AvatarProps, 'div'>
+    AvatarProps<'div'>
   >[]
   const maxLength = Math.max(maxLengthProp, 0)
   const size = useArrayProp(sizeProp)
@@ -52,11 +59,11 @@ export const AvatarStack = forwardRef(function AvatarStack(
   return (
     <Box
       data-ui="AvatarStack"
-      {...restProps}
+      {...rest}
       align="center"
-      className={composeClassNames(className, avatarStack({size}))}
+      as={as}
+      className={_composeClassNames(className, avatarStack({size}))}
       display="flex"
-      ref={ref}
     >
       {len === 0 && (
         <Box flex="none">
@@ -77,6 +84,6 @@ export const AvatarStack = forwardRef(function AvatarStack(
       ))}
     </Box>
   )
-})
+}
 
-AvatarStack.displayName = 'ForwardRef(AvatarStack)'
+AvatarStack.displayName = 'AvatarStack'

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

@@ -1,9 +1,8 @@
-import {ThemeColorAvatarColorKey} from '@sanity/ui/theme'
-
-import {AvatarSize} from '../../types'
+import type {AvatarSize, ThemeColorAvatarColorKey} from '@sanity/ui/theme'
 
 /**
  * @internal
+ * @deprecated This will be removed in next major version.
  */
 export interface AvatarRootStyleProps {
   $color: ThemeColorAvatarColorKey
@@ -11,6 +10,7 @@ export interface AvatarRootStyleProps {
 
 /**
  * @internal
+ * @deprecated This will be removed in next major version.
  */
 export interface ResponsiveAvatarSizeStyleProps {
   $size: AvatarSize[]

package/src/core/primitives/badge/__workshop__/props.tsx

@@ -1,28 +1,17 @@
 import {Badge, Flex} from '@sanity/ui'
 import {useAction, useSelect, useText} from '@sanity/ui-workshop'
 
-import {
-  WORKSHOP_BADGE_MODE_OPTIONS,
-  WORKSHOP_BADGE_TONE_OPTIONS,
-  WORKSHOP_SPACE_OPTIONS,
-} from '../../../../../workshop/constants'
+import {WORKSHOP_BADGE_TONE_OPTIONS, WORKSHOP_SPACE_OPTIONS} from '$workshop'
 
 export default function PropsStory() {
-  const mode = useSelect('Mode (deprecated)', WORKSHOP_BADGE_MODE_OPTIONS, 'default', 'Props')
-  const paddingX = useSelect('Padding X', WORKSHOP_SPACE_OPTIONS, 1, 'Props')
-  const paddingY = useSelect('Padding Y', WORKSHOP_SPACE_OPTIONS, 1, 'Props')
-  const tone = useSelect('Tone', WORKSHOP_BADGE_TONE_OPTIONS, 'default', 'Props')
-  const textProp = useText('Text', 'Label', 'Props')
+  const paddingX = useSelect('Padding X', WORKSHOP_SPACE_OPTIONS, 1)
+  const paddingY = useSelect('Padding Y', WORKSHOP_SPACE_OPTIONS, 1)
+  const tone = useSelect('Tone', WORKSHOP_BADGE_TONE_OPTIONS, 'default')
+  const textProp = useText('Text', 'Label')
 
   return (
     <Flex align="center" height="fill" justify="center">
-      <Badge
-        mode={mode}
-        onClick={useAction('onClick')}
-        paddingX={paddingX}
-        paddingY={paddingY}
-        tone={tone}
-      >
+      <Badge onClick={useAction('onClick')} paddingX={paddingX} paddingY={paddingY} tone={tone}>
         {textProp}
       </Badge>
     </Flex>

package/src/core/primitives/badge/__workshop__/tones.tsx

@@ -1,17 +1,12 @@
 import {Badge, Flex} from '@sanity/ui'
 import {THEME_COLOR_STATE_TONES} from '@sanity/ui/theme'
-import {useSelect} from '@sanity/ui-workshop'
-
-import {WORKSHOP_BADGE_MODE_OPTIONS} from '../../../../../workshop/constants'
 
 export default function Tones() {
-  const mode = useSelect('Mode (deprecated)', WORKSHOP_BADGE_MODE_OPTIONS, 'default', 'Props')
-
   return (
     <Flex align="center" height="fill" justify="center" padding={4} sizing="border">
       <Flex align="center" direction="column" gap={2}>
         {THEME_COLOR_STATE_TONES.map((tone) => (
-          <Badge key={tone} mode={mode} tone={tone}>
+          <Badge key={tone} tone={tone}>
             {tone}
           </Badge>
         ))}

package/src/core/primitives/badge/badge.test.tsx

@@ -1,6 +1,5 @@
-/** @jest-environment jsdom */
-
-import {axe} from 'jest-axe'
+import {describe, expect, it} from 'vitest'
+import {axe} from 'vitest-axe'
 
 import {render} from '../../../../test'
 import {Badge} from './badge'

package/src/core/primitives/badge/badge.tsx

@@ -1,64 +1,65 @@
-import {badge, composeClassNames, RadiusStyleProps} from '@sanity/ui/css'
-import {ForwardedRef, forwardRef} from 'react'
+import type {PaddingStyleProps, RadiusStyleProps, ResponsiveProp} from '@sanity/ui/css'
+import {_composeClassNames, badge} from '@sanity/ui/css'
+import type {FontTextSize} from '@sanity/ui/theme'
 
-import {BadgeMode, BadgeTone, Props} from '../../types'
-import {Box, BoxProps} from '../box'
-import {Text, TextProps} from '../text'
+import type {BadgeTone, ComponentType, Props} from '../../types'
+import {Box} from '../box'
+import {Text} from '../text'
 
-/**
- * @public
- */
-export interface BadgeProps extends BoxProps, RadiusStyleProps {
-  fontSize?: number | number[]
-  /** @deprecated No longer used. */
-  mode?: BadgeMode
-  textAlign?: TextProps['align']
-  tone?: BadgeTone
-}
+/** @public */
+export const DEFAULT_BADGE_ELEMENT = 'span'
+
+/** @public */
+export type BadgeOwnProps = PaddingStyleProps &
+  RadiusStyleProps & {
+    fontSize?: ResponsiveProp<FontTextSize>
+    tone?: BadgeTone
+  }
+
+/** @public */
+export type BadgeElementType = 'div' | 'span' | ComponentType
+
+/** @public */
+export type BadgeProps<E extends BadgeElementType = BadgeElementType> = Props<BadgeOwnProps, E>
 
 /**
  * Badges are used to tag resources.
  *
  * @public
  */
-export const Badge = forwardRef(function Badge(
-  props: Props<BadgeProps, 'div'>,
-  ref: ForwardedRef<HTMLDivElement>,
+export function Badge<E extends BadgeElementType = typeof DEFAULT_BADGE_ELEMENT>(
+  props: BadgeProps<E>,
 ) {
   const {
+    as = DEFAULT_BADGE_ELEMENT,
     children,
     className,
-    display = 'inline-block',
     fontSize = 1,
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    mode: _deprecated_mode,
     padding = 1,
     radius = 2,
-    textAlign,
     tone = 'default',
-    ...restProps
-  } = props
+    ...rest
+  } = props as BadgeProps<typeof DEFAULT_BADGE_ELEMENT>
 
   return (
     <Box
       data-ui="Badge"
-      {...restProps}
-      className={composeClassNames(
+      {...rest}
+      as={as}
+      className={_composeClassNames(
         className,
         badge({
           radius,
           tone,
         }),
       )}
-      display={display}
+      display="inline-flex"
+      maxWidth="fill"
       padding={padding}
-      ref={ref}
     >
-      <Text align={textAlign} size={fontSize}>
-        {children}
-      </Text>
+      <Text size={fontSize}>{children}</Text>
     </Box>
   )
-})
+}
 
-Badge.displayName = 'ForwardRef(Badge)'
+Badge.displayName = 'Badge'

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

@@ -1,7 +1,8 @@
-import {BadgeTone} from '../../types'
+import type {BadgeTone} from '../../types'
 
 /**
  * @internal
+ * @deprecated
  */
 export interface BadgeStyleProps {
   $tone: BadgeTone

package/src/core/primitives/box/__workshop__/props.tsx

@@ -1,10 +1,10 @@
 import {Box, Card, Text} from '@sanity/ui'
 import {useAction, useSelect} from '@sanity/ui-workshop'
 
-import {WORKSHOP_SPACE_OPTIONS} from '../../../../../workshop/constants'
+import {WORKSHOP_SPACE_OPTIONS} from '$workshop'
 
 export default function PropsStory() {
-  const padding = useSelect('Padding', WORKSHOP_SPACE_OPTIONS, 0, 'Props')
+  const padding = useSelect('Padding', WORKSHOP_SPACE_OPTIONS, 0)
 
   return (
     <Box padding={[4, 5, 6]}>

package/src/core/primitives/box/__workshop__/responsive.tsx

@@ -1,4 +1,5 @@
 import {Box, Text} from '@sanity/ui'
+import {vars} from '@sanity/ui/css'
 
 export default function ResponsiveStory() {
   return (
@@ -9,7 +10,7 @@ export default function ResponsiveStory() {
         flex={[1, 2, 3, 4, 5, 6, 7]}
         padding={3}
         sizing={['content', 'border', 'content', 'border', 'content', 'border', 'content']}
-        style={{outline: '1px solid var(--card-border-color)'}}
+        style={{outline: `1px solid ${vars.color.border}`}}
       >
         <Text align="center" muted>
           This is a box with responsive props