@sanity/ui 3.0.0-static.8 → 3.0.0

package/src/core/hooks/usePrefersReducedMotion.ts

@@ -0,0 +1,16 @@
+import {useMatchMedia} from './useMatchMedia'
+
+/**
+ * Returns true if motion should be reduced
+ *
+ * @param getServerSnapshot - Only called during server-side rendering, and hydration if using hydrateRoot. Since the server environment doesn't have access to the DOM, we can't determine the current value of the media query and we assume `(prefers-reduced-motion: no-preference)` since it's the most common scheme (https://react.dev/reference/react/useSyncExternalStore#adding-support-for-server-rendering)
+ *
+ * If you persist the detected preference in a cookie or a header then you may implement your own server snapshot to read it.
+ * Chrome supports reading the `prefers-reduced-motion` media query from a header if the server response: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-CH-Prefers-Reduced-Motion
+ * @example https://gist.github.com/stipsan/0c0f839a27842249cada893e9fb7767b
+ *
+ * @public
+ */
+export function usePrefersReducedMotion(getServerSnapshot = () => false): boolean {
+  return useMatchMedia('(prefers-reduced-motion: reduce)', getServerSnapshot)
+}

package/src/core/index.ts

@@ -0,0 +1,10 @@
+export * from './_compat'
+export * from './components'
+export * from './helpers'
+export * from './hooks'
+export * from './observers'
+export * from './primitives'
+export * from './styles'
+export * from './theme'
+export * from './types'
+export * from './utils'

package/src/core/primitives/_selectable/selectable.tsx

@@ -0,0 +1,15 @@
+import {styled} from 'styled-components'
+
+import {responsiveRadiusStyle, ResponsiveRadiusStyleProps} from '../../styles/radius'
+import {Box} from '../box'
+import {selectableBaseStyle, selectableColorStyle, SelectableStyleProps} from './style'
+
+/**
+ * @internal
+ */
+export const Selectable = styled(Box)<SelectableStyleProps & ResponsiveRadiusStyleProps>(
+  responsiveRadiusStyle,
+  selectableBaseStyle,
+  selectableColorStyle,
+)
+Selectable.displayName = 'Selectable'

package/src/core/primitives/_selectable/style.ts

@@ -0,0 +1,115 @@
+import {getTheme_v2} from '@sanity/ui/theme'
+import {css} from 'styled-components'
+
+import {ThemeProps} from '../../styles'
+import {_cardColorStyle} from '../../styles/card'
+import {SelectableTone} from '../../types'
+
+/**
+ * @internal
+ */
+export interface SelectableStyleProps {
+  $tone: SelectableTone
+}
+
+export function selectableBaseStyle(): ReturnType<typeof css> {
+  return css`
+    background-color: inherit;
+    color: inherit;
+
+    &[data-as='button'] {
+      -webkit-font-smoothing: inherit;
+      appearance: none;
+      outline: none;
+      font: inherit;
+      text-align: inherit;
+      border: 0;
+      width: -moz-available;
+      width: -webkit-fill-available;
+      width: stretch;
+    }
+
+    /* &:is(a) */
+    &[data-as='a'] {
+      text-decoration: none;
+    }
+  `
+}
+
+export function selectableColorStyle(
+  props: SelectableStyleProps & ThemeProps,
+): ReturnType<typeof css> {
+  const {$tone} = props
+  const {color, style} = getTheme_v2(props.theme)
+  const tone = color.selectable[$tone]
+
+  return css`
+    ${_cardColorStyle(color, tone.enabled)}
+
+    background-color: var(--card-bg-color);
+    color: var(--card-fg-color);
+    outline: none;
+
+    /* &:is(button) */
+    &[data-as='button'] {
+      &:disabled {
+        ${_cardColorStyle(color, tone.disabled)}
+      }
+
+      &:not(:disabled) {
+        &[aria-pressed='true'] {
+          ${_cardColorStyle(color, tone.pressed)}
+        }
+
+        &[data-selected],
+        &[aria-selected='true'] > & {
+          ${_cardColorStyle(color, tone.selected)}
+        }
+
+        @media (hover: hover) {
+          &:not([data-selected]) {
+            &[data-hovered],
+            &:hover {
+              ${_cardColorStyle(color, tone.hovered)}
+            }
+
+            &:active {
+              ${_cardColorStyle(color, tone.pressed)}
+            }
+          }
+        }
+      }
+    }
+
+    /* &:is(a) */
+    &[data-as='a'] {
+      &[data-disabled] {
+        ${_cardColorStyle(color, tone.disabled)}
+      }
+
+      &:not([data-disabled]) {
+        &[data-pressed] {
+          ${_cardColorStyle(color, tone.pressed)}
+        }
+
+        &[data-selected] {
+          ${_cardColorStyle(color, tone.selected)}
+        }
+
+        @media (hover: hover) {
+          &:not([data-selected]) {
+            &[data-hovered],
+            &:hover {
+              ${_cardColorStyle(color, tone.hovered)}
+            }
+            &:active {
+              ${_cardColorStyle(color, tone.pressed)}
+            }
+          }
+        }
+      }
+    }
+
+    ${style?.card?.root}
+  `
+}

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

@@ -0,0 +1,14 @@
+import {Avatar, Flex} from '@sanity/ui'
+import {useSelect} from '@sanity/ui-workshop'
+
+import {WORKSHOP_AVATAR_SIZE_OPTIONS} from '../../../__workshop__/constants'
+
+export default function AsButtonStory() {
+  const size = useSelect('Size', WORKSHOP_AVATAR_SIZE_OPTIONS, 1, 'Props')
+
+  return (
+    <Flex align="center" height="fill" justify="center">
+      <Avatar as="button" color="purple" initials="uq" size={size} />
+    </Flex>
+  )
+}

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

@@ -0,0 +1,25 @@
+import {Avatar, AvatarCounter, AvatarStack, Flex} from '@sanity/ui'
+import {useSelect} from '@sanity/ui-workshop'
+
+import {WORKSHOP_AVATAR_SIZE_OPTIONS} from '../../../__workshop__/constants'
+
+export default function StackStory() {
+  const size = useSelect('Size', WORKSHOP_AVATAR_SIZE_OPTIONS, 1, 'Props')
+
+  return (
+    <Flex align="center" height="fill" justify="center">
+      <AvatarStack size={size}>
+        <AvatarCounter count={2} />
+        <Avatar color="magenta" initials="uq" />
+        <Avatar
+          color="purple"
+          src="https://avatars3.githubusercontent.com/u/406933?s=400&u=af898b0a50ef2ef1248be32dfa1410ccb55f6f65&v=4"
+        />
+        <Avatar
+          color="blue"
+          src="https://avatars3.githubusercontent.com/u/406933?s=400&u=af898b0a50ef2ef1248be32dfa1410ccb55f6f65&v=4"
+        />
+      </AvatarStack>
+    </Flex>
+  )
+}

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

@@ -0,0 +1,63 @@
+import {useBoolean} from '@sanity/ui-workshop'
+
+import {Box} from '../../box'
+import {Button} from '../../button'
+import {Container} from '../../container'
+import {Flex} from '../../flex'
+import {Stack} from '../../stack'
+import {Text} from '../../text'
+import {Avatar} from '../avatar'
+import {AvatarStack} from '../avatarStack'
+
+export default function WithinButtonStory() {
+  const disabled = useBoolean('Disabled', false, 'Props')
+
+  return (
+    <Container width={1}>
+      <Stack paddingX={4} paddingY={[5, 6, 7]} space={1}>
+        <Button disabled={disabled} padding={1}>
+          <Flex align="center" gap={3} padding={2}>
+            <Box flex={1}>
+              <Text size={1}>Default button</Text>
+            </Box>
+            <Box flex="none">
+              <AvatarStack>
+                <Avatar color="blue" initials="AB" />
+                <Avatar color="magenta" initials="CD" />
+                <Avatar color="purple" initials="EF" />
+              </AvatarStack>
+            </Box>
+          </Flex>
+        </Button>
+        <Button disabled={disabled} mode="ghost" padding={1}>
+          <Flex align="center" gap={3} padding={2}>
+            <Box flex={1}>
+              <Text size={1}>Ghost button</Text>
+            </Box>
+            <Box flex="none">
+              <AvatarStack>
+                <Avatar color="blue" initials="AB" />
+                <Avatar color="magenta" initials="CD" />
+                <Avatar color="purple" initials="EF" />
+              </AvatarStack>
+            </Box>
+          </Flex>
+        </Button>
+        <Button disabled={disabled} mode="bleed" padding={1}>
+          <Flex align="center" gap={3} padding={2}>
+            <Box flex={1}>
+              <Text size={1}>Bleed button</Text>
+            </Box>
+            <Box flex="none">
+              <AvatarStack>
+                <Avatar color="blue" initials="AB" />
+                <Avatar color="magenta" initials="CD" />
+                <Avatar color="purple" initials="EF" />
+              </AvatarStack>
+            </Box>
+          </Flex>
+        </Button>
+      </Stack>
+    </Container>
+  )
+}

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

@@ -0,0 +1,70 @@
+import {useBoolean} from '@sanity/ui-workshop'
+
+import {Menu, MenuItem} from '../../../components'
+import {Layer} from '../../../utils'
+import {Box} from '../../box'
+import {Card} from '../../card'
+import {Container} from '../../container'
+import {Flex} from '../../flex'
+import {Text} from '../../text'
+import {Avatar} from '../avatar'
+import {AvatarStack} from '../avatarStack'
+
+export default function WithinMenuItemStory() {
+  const disabled = useBoolean('Disabled', false, 'Props')
+
+  return (
+    <Container width={1}>
+      <Layer>
+        <Box paddingX={4} paddingY={[5, 6, 7]}>
+          <Card radius={3} shadow={3}>
+            <Menu space={1}>
+              <MenuItem disabled={disabled} padding={0}>
+                <Flex align="center" gap={2} padding={2}>
+                  <Box flex={1}>
+                    <Text size={1}>Menu item 1</Text>
+                  </Box>
+                  <Box flex="none">
+                    <AvatarStack>
+                      <Avatar color="blue" initials="AB" />
+                      <Avatar color="magenta" initials="CD" />
+                      <Avatar color="purple" initials="EF" />
+                    </AvatarStack>
+                  </Box>
+                </Flex>
+              </MenuItem>
+              <MenuItem disabled={disabled} padding={0}>
+                <Flex align="center" gap={2} padding={2}>
+                  <Box flex={1}>
+                    <Text size={1}>Menu item 1</Text>
+                  </Box>
+                  <Box flex="none">
+                    <AvatarStack>
+                      <Avatar color="blue" initials="AB" />
+                      <Avatar color="magenta" initials="CD" />
+                      <Avatar color="purple" initials="EF" />
+                    </AvatarStack>
+                  </Box>
+                </Flex>
+              </MenuItem>
+              <MenuItem disabled={disabled} padding={0}>
+                <Flex align="center" gap={2} padding={2}>
+                  <Box flex={1}>
+                    <Text size={1}>Menu item 1</Text>
+                  </Box>
+                  <Box flex="none">
+                    <AvatarStack>
+                      <Avatar color="blue" initials="AB" />
+                      <Avatar color="magenta" initials="CD" />
+                      <Avatar color="purple" initials="EF" />
+                    </AvatarStack>
+                  </Box>
+                </Flex>
+              </MenuItem>
+            </Menu>
+          </Card>
+        </Box>
+      </Layer>
+    </Container>
+  )
+}

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

@@ -0,0 +1,192 @@
+import {ThemeColorAvatarColorKey} from '@sanity/ui/theme'
+import {forwardRef, useCallback, useEffect, useId, useMemo, useState} from 'react'
+import ReactIs from 'react-is'
+import {styled} from 'styled-components'
+
+import {useArrayProp} from '../../hooks'
+import {useTheme_v2} from '../../theme'
+import {AvatarPosition, AvatarSize, AvatarStatus} from '../../types'
+import {Label} from '../label'
+import {avatarStyle, responsiveAvatarSizeStyle} from './styles'
+
+/**
+ * @public
+ */
+export interface AvatarProps {
+  /** @beta */
+  __unstable_hideInnerStroke?: boolean
+  animateArrowFrom?: AvatarPosition
+  arrowPosition?: AvatarPosition
+  as?: React.ElementType | keyof React.JSX.IntrinsicElements
+  color?: ThemeColorAvatarColorKey
+  initials?: string
+  onImageLoadError?: (event: Error) => void
+  size?: AvatarSize | AvatarSize[]
+  src?: string
+  /**
+   * The status of the entity this Avatar represents.
+   * @alpha
+   */
+  status?: AvatarStatus
+  title?: string
+}
+
+const StyledAvatar = styled.div<{$color: ThemeColorAvatarColorKey; $size: AvatarSize[]}>(
+  responsiveAvatarSizeStyle,
+  avatarStyle.root,
+)
+
+const Arrow = styled.div(avatarStyle.arrow)
+
+const BgStroke = styled.ellipse(avatarStyle.bgStroke)
+
+const Stroke = styled.ellipse(avatarStyle.stroke)
+
+const Initials = styled.div(avatarStyle.initials)
+
+const InitialsLabel = styled(Label)({
+  color: 'inherit',
+})
+
+const AvatarImage = styled.svg(avatarStyle.image)
+
+/**
+ * Avatars are used to represent people and other agents (e.g. bots).
+ *
+ * @public
+ */
+export const Avatar = forwardRef(function Avatar(
+  props: AvatarProps & Omit<React.HTMLProps<HTMLDivElement>, 'as' | 'ref'>,
+  ref: React.ForwardedRef<HTMLDivElement>,
+) {
+  const {
+    __unstable_hideInnerStroke,
+    as: asProp,
+    color = 'gray',
+    src,
+    title,
+    initials,
+    onImageLoadError,
+    arrowPosition: arrowPositionProp,
+    animateArrowFrom,
+    status = 'online',
+    size: sizeProp = 1,
+    ...restProps
+  } = props
+  const {avatar} = useTheme_v2()
+  const as = ReactIs.isValidElementType(asProp) ? asProp : 'div'
+  const size = useArrayProp(sizeProp)
+
+  // @todo: remove this
+  const avatarSize = avatar.sizes[size[0]] || avatar.sizes[0]
+  const _sizeRem = avatarSize.size
+  const _radius = _sizeRem / 2
+
+  const elementId = useId()
+  const [arrowPosition, setArrowPosition] = useState<AvatarPosition | undefined>(
+    animateArrowFrom || arrowPositionProp || 'inside',
+  )
+
+  const [imageFailed, setImageFailed] = useState<boolean>(false)
+
+  const imageId = `avatar-image-${elementId}`
+
+  useEffect(() => {
+    if (arrowPosition === arrowPositionProp) return undefined
+
+    // Start animation in the next frame
+    const raf = requestAnimationFrame(() => setArrowPosition(arrowPositionProp))
+
+    return () => cancelAnimationFrame(raf)
+  }, [arrowPosition, arrowPositionProp])
+
+  useEffect(() => {
+    if (src) setImageFailed(false)
+  }, [src])
+
+  const handleImageError = useCallback(() => {
+    setImageFailed(true)
+
+    if (onImageLoadError) {
+      onImageLoadError(new Error('Avatar: the image failed to load'))
+    }
+  }, [onImageLoadError])
+
+  const initialsSize = useMemo(
+    () =>
+      size.map((s) => {
+        if (s === 1) return 1
+        if (s === 2) return 3
+        if (s === 3) return 5
+
+        return 0
+      }),
+    [size],
+  )
+
+  return (
+    <StyledAvatar
+      as={as}
+      data-as={typeof as === 'string' ? as : undefined}
+      data-ui="Avatar"
+      {...restProps}
+      $color={color}
+      $size={size}
+      aria-label={title}
+      data-arrow-position={arrowPosition}
+      data-status={status}
+      ref={ref}
+      title={title}
+    >
+      <Arrow>
+        <svg width="11" height="7" viewBox="0 0 11 7" fill="none">
+          <path
+            d="M6.67948 1.50115L11 7L0 7L4.32052 1.50115C4.92109 0.736796 6.07891 0.736795 6.67948 1.50115Z"
+            fill={color}
+          />
+        </svg>
+      </Arrow>
+
+      {!imageFailed && src && (
+        <AvatarImage viewBox={`0 0 ${_sizeRem} ${_sizeRem}`} fill="none">
+          <defs>
+            <pattern id={imageId} patternContentUnits="objectBoundingBox" width="1" height="1">
+              <image href={src} width="1" height="1" onError={handleImageError} />
+            </pattern>
+          </defs>
+
+          <circle cx={_radius} cy={_radius} r={_radius} fill={`url(#${imageId})`} />
+
+          {!__unstable_hideInnerStroke && (
+            <BgStroke
+              cx={_radius}
+              cy={_radius}
+              rx={_radius}
+              ry={_radius}
+              vectorEffect="non-scaling-stroke"
+            />
+          )}
+
+          <Stroke
+            cx={_radius}
+            cy={_radius}
+            rx={_radius}
+            ry={_radius}
+            vectorEffect="non-scaling-stroke"
+          />
+        </AvatarImage>
+      )}
+
+      {(imageFailed || !src) && initials && (
+        <>
+          <Initials>
+            <InitialsLabel forwardedAs="span" size={initialsSize} weight="medium">
+              {initials}
+            </InitialsLabel>
+          </Initials>
+        </>
+      )}
+    </StyledAvatar>
+  )
+})
+Avatar.displayName = 'ForwardRef(Avatar)'

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

@@ -0,0 +1,94 @@
+import {getTheme_v2} from '@sanity/ui/theme'
+import {forwardRef, useMemo} from 'react'
+import {css, styled} from 'styled-components'
+
+import {EMPTY_RECORD} from '../../constants'
+import {useArrayProp} from '../../hooks'
+import {_responsive, rem, ThemeProps} from '../../styles'
+import {AvatarSize} from '../../types'
+import {Label} from '../label'
+
+function _responsiveAvatarCounterSizeStyle(props: {$size: AvatarSize[]} & ThemeProps) {
+  const {avatar, media} = getTheme_v2(props.theme)
+
+  return _responsive(media, props.$size, (size) => {
+    const avatarSize = avatar.sizes[size]
+
+    if (!avatarSize) return EMPTY_RECORD
+
+    return {
+      borderRadius: rem(avatarSize.size / 2),
+      minWidth: rem(avatarSize.size),
+      height: rem(avatarSize.size),
+    }
+  })
+}
+
+function _avatarCounterBaseStyle(props: ThemeProps) {
+  const {space} = getTheme_v2(props.theme)
+
+  return css`
+    align-items: center;
+    justify-content: center;
+    box-sizing: border-box;
+    user-select: none;
+    color: inherit;
+    color: var(--card-fg-color);
+    background: var(--card-bg-color);
+    box-shadow:
+      0 0 0 1px var(--card-bg-color),
+      inset 0 0 0 1px var(--card-hairline-hard-color);
+    padding: 0 ${rem(space[2])};
+
+    &:not([hidden]) {
+      display: flex;
+    }
+  `
+}
+
+const StyledAvatarCounter = styled.div<{$size: AvatarSize[]}>(
+  _responsiveAvatarCounterSizeStyle,
+  _avatarCounterBaseStyle,
+)
+
+/**
+ * @public
+ */
+export interface AvatarCounterProps {
+  count: number
+  size?: AvatarSize | AvatarSize[]
+  /** @deprecated No longer supported. */
+  tone?: 'navbar'
+}
+
+/**
+ * @public
+ */
+export const AvatarCounter = forwardRef(function AvatarCounter(
+  props: AvatarCounterProps,
+  ref: React.Ref<HTMLDivElement>,
+) {
+  const {count, size: sizeProp = 1} = props
+  const size = useArrayProp(sizeProp)
+
+  const fontSize = useMemo(
+    () =>
+      size.map((s) => {
+        if (s === 1) return 1
+        if (s === 2) return 3
+        if (s === 3) return 5
+
+        return 0
+      }),
+    [size],
+  )
+
+  return (
+    <StyledAvatarCounter $size={size} data-ui="AvatarCounter" ref={ref}>
+      <Label as="span" size={fontSize} weight="medium">
+        {count}
+      </Label>
+    </StyledAvatarCounter>
+  )
+})
+AvatarCounter.displayName = 'ForwardRef(AvatarCounter)'