@sanity/ui 1.8.3 → 2.0.0-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/ui",
-  "version": "1.8.3",
+  "version": "2.0.0-alpha.10",
   "sideEffects": false,
   "types": "./dist/index.d.ts",
   "source": "./src/index.ts",
@@ -46,11 +46,13 @@
     "watch": "pkg watch --strict",
     "workshop:build": "node -r esbuild-register -r tsconfig-paths/register scripts/build",
     "workshop:dev": "node -r esbuild-register -r tsconfig-paths/register scripts/dev",
-    "workshop:start": "http-server -a localhost -c-0 -p 1337 -s -P http://localhost:1337/index.html? dist"
+    "workshop:start": "http-server -a localhost -c-0 -p 1337 -s -P http://localhost:1337/index.html? dist",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
   },
   "dependencies": {
     "@floating-ui/react-dom": "2.0.0",
-    "@sanity/color": "^2.2.5",
+    "@sanity/color": "3.0.0-beta.5",
     "@sanity/icons": "^2.4.1",
     "csstype": "^3.1.2",
     "framer-motion": "^10.16.2",
@@ -67,6 +69,20 @@
     "@sanity/pkg-utils": "^2.4.8",
     "@sanity/semantic-release-preset": "^4.1.4",
     "@sanity/ui-workshop": "^1.2.11",
+    "@storybook/addon-a11y": "^7.4.5",
+    "@storybook/addon-docs": "^7.4.5",
+    "@storybook/addon-essentials": "^7.4.5",
+    "@storybook/addon-interactions": "^7.4.5",
+    "@storybook/addon-links": "^7.4.5",
+    "@storybook/addon-storysource": "^7.4.5",
+    "@storybook/addon-themes": "^7.4.5",
+    "@storybook/blocks": "^7.4.5",
+    "@storybook/jest": "^0.2.2",
+    "@storybook/manager-api": "^7.4.5",
+    "@storybook/react": "^7.4.5",
+    "@storybook/react-vite": "^7.4.5",
+    "@storybook/testing-library": "^0.2.1",
+    "@storybook/theming": "^7.4.5",
     "@testing-library/dom": "^9.3.1",
     "@testing-library/jest-dom": "^5.17.0",
     "@testing-library/react": "^14.0.0",
@@ -93,6 +109,7 @@
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-storybook": "^0.6.14",
     "http-server": "^14.1.1",
     "husky": "^8.0.3",
     "jest": "^29.6.4",
@@ -109,6 +126,7 @@
     "rimraf": "^5.0.1",
     "semantic-release": "^21.1.1",
     "start-server-and-test": "^2.0.0",
+    "storybook": "^7.4.5",
     "styled-components": "^6.0.7",
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5.2.2"

package/src/components/autocomplete/autocomplete.tsx

@@ -31,6 +31,7 @@ import {
   Text,
   TextInput,
 } from '../../primitives'
+import {Radius} from '../../types'
 import {AnimatedSpinnerIcon, ListBox, Root} from './autocomplete.styles'
 import {AutocompleteOption} from './autocompleteOption'
 import {autocompleteReducer} from './autocompleteReducer'
@@ -64,7 +65,7 @@ export interface AutocompleteProps<Option extends BaseAutocompleteOption = BaseA
   popover?: Omit<PopoverProps, 'content' | 'onMouseEnter' | 'onMouseLeave' | 'open'> &
     Omit<HTMLProps<HTMLDivElement>, 'as' | 'children' | 'content' | 'ref' | 'width'>
   prefix?: ReactNode
-  radius?: number | number[]
+  radius?: Radius | Radius[]
   /** @beta */
   relatedElements?: HTMLElement[]
   renderOption?: (option: Option) => ReactElement

package/src/components/dialog/constants.ts

@@ -0,0 +1,4 @@
+/**
+ * Left/right border offsets for header + footer components (in px).
+ */
+export const BORDER_OFFSET_X: number = 12

package/src/components/dialog/dialog.tsx

@@ -8,12 +8,13 @@ import {
   isHTMLElement,
 } from '../../helpers'
 import {useArrayProp, useClickOutside, useForwardedRef, useGlobalKeyDown} from '../../hooks'
-import {Box, Button, Card, Container, Flex, Text} from '../../primitives'
+import {Box, Button, Card, CardProps, Container, Flex, Text} from '../../primitives'
 import {ResponsivePaddingProps, ResponsiveWidthProps} from '../../primitives/types'
 import {responsivePaddingStyle, ResponsivePaddingStyleProps} from '../../styles/internal'
-import {ThemeColorSchemeKey, useTheme} from '../../theme'
-import {DialogPosition} from '../../types'
+import {ThemeColorSchemeKey, cssVars, useTheme} from '../../theme'
+import {DialogPosition, Radius} from '../../types'
 import {Layer, LayerProps, Portal, useBoundaryElement, useLayer, usePortal} from '../../utils'
+import {BORDER_OFFSET_X} from './constants'
 import {
   dialogStyle,
   responsiveDialogPositionStyle,
@@ -33,7 +34,7 @@ export interface DialogProps extends ResponsivePaddingProps, ResponsiveWidthProp
    * @beta
    */
   __unstable_hideCloseButton?: boolean
-  cardRadius?: number | number[]
+  cardRadius?: Radius | Radius[]
   cardShadow?: number | number[]
   contentRef?: React.ForwardedRef<HTMLDivElement>
   footer?: React.ReactNode
@@ -66,11 +67,20 @@ interface DialogCardProps extends ResponsiveWidthProps {
   onClickOutside?: () => void
   onClose?: () => void
   portal?: string
-  radius: number | number[]
+  radius: Radius | Radius[]
   scheme?: ThemeColorSchemeKey
   shadow: number | number[]
 }
 
+interface DialogHeaderProps extends CardProps {
+  $hasScrolledFromTop: boolean
+  $isContentScrollable: boolean
+}
+interface DialogFooterProps extends CardProps {
+  $hasScrolledToBottom: boolean
+  $isContentScrollable: boolean
+}
+
 function isTargetWithinScope(
   boundaryElement: HTMLElement | null,
   portalElement: HTMLElement | null,
@@ -118,7 +128,7 @@ const DialogLayout = styled(Flex)`
   width: 100%;
 `
 
-const DialogHeader = styled(Card)`
+const DialogHeader = styled(Box)<DialogHeaderProps>`
   position: relative;
   z-index: 2;
 
@@ -126,10 +136,13 @@ const DialogHeader = styled(Card)`
     content: '';
     display: block;
     position: absolute;
-    left: 0;
-    right: 0;
+    left: ${BORDER_OFFSET_X}px;
+    right: ${BORDER_OFFSET_X}px;
     bottom: -1px;
-    border-bottom: 1px solid var(--card-hairline-soft-color);
+    border-bottom: 1px solid ${cssVars.default['border-base']};
+    width: auto;
+    opacity: ${(props) => (props.$isContentScrollable && props.$hasScrolledFromTop ? 1 : 0)};
+    transition: opacity 200ms ease-in;
   }
 `
 
@@ -140,10 +153,22 @@ const DialogContent = styled(Box)`
   outline: none;
 `
 
-const DialogFooter = styled(Box)`
+const DialogFooter = styled(Box)<DialogFooterProps>`
   position: relative;
   z-index: 3;
-  border-top: 1px solid var(--card-hairline-soft-color);
+
+  &:before {
+    content: '';
+    display: block;
+    position: absolute;
+    left: ${BORDER_OFFSET_X}px;
+    right: ${BORDER_OFFSET_X}px;
+    top: -1px;
+    border-top: 1px solid ${cssVars.default['border-base']};
+    width: auto;
+    opacity: ${(props) => (props.$isContentScrollable && !props.$hasScrolledToBottom ? 1 : 0)};
+    transition: opacity 200ms ease-in;
+  }
 `
 
 const DialogCard = forwardRef(function DialogCard(
@@ -180,6 +205,9 @@ const DialogCard = forwardRef(function DialogCard(
   const labelId = `${id}_label`
   const showCloseButton = Boolean(onClose) && hideCloseButton === false
   const showHeader = Boolean(header) || showCloseButton
+  const [isContentScrollable, setIsContentScrollable] = useState(false)
+  const [hasScrolledFromTop, setHasScrolledFromTop] = useState(false)
+  const [hasScrolledToBottom, setHasScrolledToBottom] = useState(false)
 
   useEffect(() => {
     if (!autoFocus) return
@@ -248,41 +276,75 @@ const DialogCard = forwardRef(function DialogCard(
     [contentRef],
   )
 
+  const handleContentUpdate = useCallback(() => {
+    if (localContentRef.current) {
+      setIsContentScrollable(
+        localContentRef.current.clientHeight < localContentRef.current.scrollHeight,
+      )
+      setHasScrolledFromTop(localContentRef.current.scrollTop > 0)
+      setHasScrolledToBottom(
+        localContentRef.current.scrollTop >=
+          localContentRef.current.scrollHeight - localContentRef.current.clientHeight,
+      )
+    }
+  }, [])
+
+  useEffect(() => {
+    const resizeObserver = new ResizeObserver(handleContentUpdate)
+
+    if (localContentRef.current) {
+      resizeObserver.observe(localContentRef.current)
+    }
+
+    return () => {
+      resizeObserver.disconnect()
+    }
+  }, [contentRef, handleContentUpdate])
+
   return (
     <DialogContainer data-ui="DialogCard" width={width}>
       <DialogCardRoot radius={radius} ref={setRef} scheme={scheme} shadow={shadow}>
         <DialogLayout direction="column">
           {showHeader && (
-            <DialogHeader>
-              <Flex>
-                <Box flex={1} padding={4}>
+            <DialogHeader
+              $isContentScrollable={isContentScrollable}
+              $hasScrolledFromTop={hasScrolledFromTop}
+              padding={3}
+            >
+              <Flex align="center">
+                <Box flex={1} padding={3}>
                   {header && (
-                    <Text id={labelId} weight="semibold">
+                    <Text id={labelId} size={1} weight="medium">
                       {header}
                     </Text>
                   )}
                 </Box>
                 {showCloseButton && (
-                  <Box padding={2}>
-                    <Button
-                      aria-label="Close dialog"
-                      disabled={!onClose}
-                      icon={CloseIcon}
-                      mode="bleed"
-                      onClick={onClose}
-                      padding={3}
-                    />
-                  </Box>
+                  <Button
+                    aria-label="Close dialog"
+                    disabled={!onClose}
+                    icon={CloseIcon}
+                    mode="bleed"
+                    onClick={onClose}
+                    padding={3}
+                  />
                 )}
               </Flex>
             </DialogHeader>
           )}
 
-          <DialogContent flex={1} ref={setContentRef} tabIndex={-1}>
+          <DialogContent flex={1} ref={setContentRef} tabIndex={-1} onScroll={handleContentUpdate}>
             {children}
           </DialogContent>
 
-          {footer && <DialogFooter>{footer}</DialogFooter>}
+          {footer && (
+            <DialogFooter
+              $isContentScrollable={isContentScrollable}
+              $hasScrolledToBottom={hasScrolledToBottom}
+            >
+              {footer}
+            </DialogFooter>
+          )}
         </DialogLayout>
       </DialogCardRoot>
     </DialogContainer>

package/src/components/dialog/styles.ts

@@ -1,4 +1,5 @@
 import {_responsive, ThemeProps} from '../../styles'
+import {cssVars} from '../../theme'
 import {DialogPosition} from '../../types'
 import {CSSObject} from '../../types/styled'
 
@@ -9,9 +10,7 @@ export interface ResponsiveDialogPositionStyleProps {
   $position: DialogPosition[]
 }
 
-export function dialogStyle({theme}: ThemeProps): CSSObject {
-  const color = theme.sanity.color.base
-
+export function dialogStyle(): CSSObject {
   return {
     '&:not([hidden])': {
       display: 'flex',
@@ -24,7 +23,7 @@ export function dialogStyle({theme}: ThemeProps): CSSObject {
     alignItems: 'center',
     justifyContent: 'center',
     outline: 'none',
-    background: color.shadow.umbra,
+    background: cssVars.default['base-shadow-umbra-color'],
   }
 }
 

package/src/components/hotkeys/hotkeys.tsx

@@ -2,6 +2,7 @@ import {forwardRef} from 'react'
 import styled from 'styled-components'
 import {useArrayProp} from '../../hooks'
 import {Inline, KBD} from '../../primitives'
+import {Radius} from '../../types'
 
 /**
  * @public
@@ -9,7 +10,7 @@ import {Inline, KBD} from '../../primitives'
 export interface HotkeysProps {
   fontSize?: number | number[]
   padding?: number | number[]
-  radius?: number | number[]
+  radius?: Radius | Radius[]
   space?: number | number[]
   keys?: string[]
 }

package/src/components/menu/__workshop__/closableMenuButton.tsx

@@ -1,5 +1,5 @@
 import {AddIcon} from '@sanity/icons'
-import {Box, Button, Menu, MenuButton, MenuButtonProps, MenuItem, Stack} from '@sanity/ui'
+import {Box, Button, Menu, MenuButton, MenuButtonProps, MenuItem, Stack, cssVars} from '@sanity/ui'
 import {useRef} from 'react'
 
 const POPOVER_PROPS: MenuButtonProps['popover'] = {
@@ -23,7 +23,7 @@ export default function ClosableMenuButtonStory() {
                 <MenuItem text="Item 3" />
                 <MenuItem text="Item 4" />
               </Stack>
-              <Stack padding={1} style={{borderTop: '1px solid var(--card-border-color)'}}>
+              <Stack padding={1} style={{borderTop: `1px solid ${cssVars.default['border-base']}`}}>
                 <Button
                   icon={AddIcon}
                   onClick={() => {

package/src/components/menu/menuButton.tsx

@@ -2,7 +2,7 @@ import {cloneElement, forwardRef, useCallback, useMemo, useState, useEffect, use
 import {isElement} from 'react-is'
 import {Popover, PopoverProps} from '../../primitives'
 import {ThemeColorSchemeKey} from '../../theme'
-import {Placement} from '../../types'
+import {Placement, Radius} from '../../types'
 import {MenuProps} from './menu'
 
 /**
@@ -34,7 +34,7 @@ export interface MenuButtonProps {
   /**
    * @deprecated Use `popover={{radius: 2}}` instead.
    */
-  popoverRadius?: number | number[]
+  popoverRadius?: Radius | Radius[]
   /**
    * @beta Do not use in production.
    * @deprecated Use `popover={{portal: true}}` instead.

package/src/components/menu/menuDivider.ts

@@ -1,4 +1,5 @@
 import styled from 'styled-components'
+import {cssVars} from '../../theme'
 
 /**
  * @public
@@ -6,6 +7,6 @@ import styled from 'styled-components'
 export const MenuDivider = styled.hr`
   height: 1px;
   border: 0;
-  background: var(--card-hairline-soft-color);
+  background: ${cssVars.default['border-base']};
   margin: 0;
 `

package/src/components/menu/menuGroup.tsx

@@ -4,7 +4,8 @@ import {isValidElementType} from 'react-is'
 import {useArrayProp} from '../../hooks'
 import {Box, Flex, Popover, PopoverProps, Text} from '../../primitives'
 import {Selectable} from '../../primitives/_selectable'
-import {SelectableTone} from '../../types/selectable'
+import {useToneContext} from '../../theme/toneContext/useToneContext'
+import {Radius, SelectableTone} from '../../types'
 import {Menu} from './menu'
 import {useMenu} from './useMenu'
 
@@ -17,7 +18,7 @@ export interface MenuGroupProps {
   icon?: React.ElementType | React.ReactNode
   padding?: number | number[]
   popover?: Omit<PopoverProps, 'content' | 'open'>
-  radius?: number | number[]
+  radius?: Radius | Radius[]
   space?: number | number[]
   text: React.ReactNode
   tone?: SelectableTone
@@ -33,7 +34,7 @@ export function MenuGroup(
   const {
     as = 'button',
     children,
-    fontSize,
+    fontSize = 1,
     icon,
     onClick,
     padding = 3,
@@ -44,6 +45,7 @@ export function MenuGroup(
     tone = 'default',
     ...restProps
   } = props
+  const {scheme} = useToneContext()
   const menu = useMenu()
   const {
     activeElement,
@@ -166,6 +168,7 @@ export function MenuGroup(
         data-selected={!withinMenu && active ? '' : undefined}
         $radius={useArrayProp(radius)}
         $tone={tone}
+        $scheme={scheme}
         onClick={handleClick}
         onKeyDown={handleKeyDown}
         onMouseEnter={handleMouseEnter}
@@ -173,28 +176,24 @@ export function MenuGroup(
         tabIndex={-1}
         type={as === 'button' ? 'button' : undefined}
       >
-        <Box padding={padding}>
-          <Flex>
-            {icon && (
-              <Text size={fontSize}>
-                {isValidElement(icon) && icon}
-                {isValidElementType(icon) && createElement(icon)}
-              </Text>
-            )}
-
-            <Box flex={1} marginLeft={icon ? space : undefined}>
-              <Text size={fontSize} textOverflow="ellipsis">
-                {text}
-              </Text>
-            </Box>
-
-            <Box marginLeft={space}>
-              <Text size={fontSize}>
-                <ChevronRightIcon />
-              </Text>
-            </Box>
-          </Flex>
-        </Box>
+        <Flex gap={space} padding={padding}>
+          {icon && (
+            <Text size={fontSize}>
+              {isValidElement(icon) && icon}
+              {isValidElementType(icon) && createElement(icon)}
+            </Text>
+          )}
+
+          <Box flex={1}>
+            <Text size={fontSize} textOverflow="ellipsis" weight="medium">
+              {text}
+            </Text>
+          </Box>
+
+          <Text size={fontSize}>
+            <ChevronRightIcon />
+          </Text>
+        </Flex>
       </Selectable>
     </Popover>
   )

package/src/components/menu/menuItem.tsx

@@ -12,7 +12,8 @@ import {useArrayProp, useForwardedRef} from '../../hooks'
 import {Box, Flex, Text} from '../../primitives'
 import {Selectable} from '../../primitives/_selectable'
 import {ResponsivePaddingProps, ResponsiveRadiusProps} from '../../primitives/types'
-import {SelectableTone} from '../../types/selectable'
+import {ThemeColorToneKey} from '../../theme'
+import {useToneContext} from '../../theme/toneContext/useToneContext'
 import {Hotkeys} from '../hotkeys'
 import {useMenu} from './useMenu'
 
@@ -29,7 +30,7 @@ export interface MenuItemProps extends ResponsivePaddingProps, ResponsiveRadiusP
   selected?: boolean
   space?: number | number[]
   text?: React.ReactNode
-  tone?: SelectableTone
+  tone?: ThemeColorToneKey
 }
 
 /**
@@ -44,7 +45,7 @@ export const MenuItem = forwardRef(function MenuItem(
     as = 'button',
     children,
     disabled,
-    fontSize = 2,
+    fontSize = 1,
     hotkeys,
     icon,
     iconRight,
@@ -64,6 +65,7 @@ export const MenuItem = forwardRef(function MenuItem(
     tone = 'default',
     ...restProps
   } = props
+  const {scheme} = useToneContext()
   const menu = useMenu()
   const {
     activeElement,
@@ -120,7 +122,8 @@ export const MenuItem = forwardRef(function MenuItem(
       forwardedAs={as}
       $radius={useArrayProp(radius)}
       $padding={useArrayProp(0)}
-      $tone={tone}
+      $tone={disabled ? 'default' : tone}
+      $scheme={scheme}
       disabled={disabled}
       onClick={handleClick}
       onMouseEnter={onItemMouseEnter}
@@ -131,43 +134,34 @@ export const MenuItem = forwardRef(function MenuItem(
       type={as === 'button' ? 'button' : undefined}
     >
       {(icon || text || iconRight) && (
-        <Box as="span" {...paddingProps}>
-          <Flex as="span">
-            {icon && (
-              <Text size={fontSize}>
-                {isValidElement(icon) && icon}
-                {isValidElementType(icon) && createElement(icon)}
-              </Text>
-            )}
+        <Flex as="span" gap={space} align="center" {...paddingProps}>
+          {icon && (
+            <Text size={fontSize}>
+              {isValidElement(icon) && icon}
+              {isValidElementType(icon) && createElement(icon)}
+            </Text>
+          )}
 
-            {text && (
-              <Box
-                flex={1}
-                marginLeft={icon ? space : undefined}
-                marginRight={iconRight ? space : undefined}
-              >
-                <Text size={fontSize} textOverflow="ellipsis">
-                  {text}
-                </Text>
-              </Box>
-            )}
+          {text && (
+            <Box flex={1}>
+              <Text size={fontSize} textOverflow="ellipsis" weight="medium">
+                {text}
+              </Text>
+            </Box>
+          )}
 
-            {hotkeys && (
-              <Box marginLeft={space} style={{marginTop: -4, marginBottom: -4}}>
-                <Hotkeys fontSize={fontSize} keys={hotkeys} />
-              </Box>
-            )}
+          {hotkeys && (
+            <Hotkeys fontSize={fontSize} keys={hotkeys} style={{marginTop: -4, marginBottom: -4}} />
+          )}
 
-            {iconRight && (
-              <Text size={fontSize}>
-                {isValidElement(iconRight) && iconRight}
-                {isValidElementType(iconRight) && createElement(iconRight)}
-              </Text>
-            )}
-          </Flex>
-        </Box>
+          {iconRight && (
+            <Text size={fontSize}>
+              {isValidElement(iconRight) && iconRight}
+              {isValidElementType(iconRight) && createElement(iconRight)}
+            </Text>
+          )}
+        </Flex>
       )}
-
       {children && (
         <Box as="span" {...paddingProps}>
           {children}

package/src/components/skeleton/styles.ts

@@ -1,4 +1,5 @@
 import {css, keyframes} from 'styled-components'
+import {cssVars} from '../../theme'
 
 const keyframe = keyframes`
   0% {
@@ -12,11 +13,11 @@ const keyframe = keyframes`
 const animation = css`
   background-image: linear-gradient(
     to right,
-    var(--card-skeleton-color-from),
-    var(--card-skeleton-color-to),
-    var(--card-skeleton-color-from),
-    var(--card-skeleton-color-from),
-    var(--card-skeleton-color-from)
+    ${cssVars.default['skeleton-from']},
+    ${cssVars.default['skeleton-to']},
+    ${cssVars.default['skeleton-from']},
+    ${cssVars.default['skeleton-from']},
+    ${cssVars.default['skeleton-from']}
   );
   background-position: 100%;
   background-size: 200% 100%;
@@ -40,11 +41,11 @@ export const skeletonStyle = css<{$animated: boolean; $visible: boolean}>`
       $animated
         ? animation
         : css`
-            background-color: var(--card-skeleton-color-from);
+            background-color: ${cssVars.default['skeleton-from']};
           `}
   }
 
   @media screen and (prefers-reduced-motion: reduce) {
-    background-color: var(--card-skeleton-color-from);
+    background-color: ${cssVars.default['skeleton-from']};
   }
 `

package/src/components/tab/tab.tsx

@@ -38,7 +38,7 @@ export const Tab = forwardRef(function Tab(
     icon,
     id,
     focused,
-    fontSize,
+    fontSize = 1,
     label,
     onClick,
     onFocus,
@@ -88,6 +88,7 @@ export const Tab = forwardRef(function Tab(
       onBlur={handleBlur}
       onFocus={handleFocus}
       padding={padding}
+      radius="full"
       ref={setRef}
       role="tab"
       selected={selected}