@sanity/ui 2.0.0-alpha.9 → 2.0.0-beta.10

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

@@ -0,0 +1,43 @@
+/** @jest-environment jsdom */
+
+import {AddIcon} from '@sanity/icons'
+import {screen} from '@testing-library/react'
+import {axe} from 'jest-axe'
+import {render} from '../../../../test'
+import {Button, ButtonProps} from './button'
+
+describe('atoms/button', () => {
+  it('Axe: should have no violations', async () => {
+    const lightResult = render(<Button icon={AddIcon} text="Label" tone="positive" />, {
+      scheme: 'light',
+    })
+
+    expect(await axe(lightResult.container.outerHTML)).toHaveNoViolations()
+
+    const darkResult = render(<Button icon={AddIcon} text="Label" tone="positive" />, {
+      scheme: 'dark',
+    })
+
+    expect(await axe(darkResult.container.outerHTML)).toHaveNoViolations()
+  })
+
+  it('should render text', () => {
+    render(<Button text="Button text" />)
+
+    expect(screen.getByText('Button text')).toBeInTheDocument()
+  })
+
+  it('should wrap button', () => {
+    function WrappedButton({button: buttonProps}: {button: ButtonProps}) {
+      return <Button {...buttonProps} />
+    }
+
+    const buttonProps: ButtonProps = {
+      text: 'Button text',
+    }
+
+    render(<WrappedButton button={buttonProps} />)
+
+    expect(screen.getByText('Button text')).toBeInTheDocument()
+  })
+})

package/src/core/primitives/button/button.tsx

@@ -0,0 +1,182 @@
+import {createElement, forwardRef, isValidElement, useMemo} from 'react'
+import {isValidElementType} from 'react-is'
+import styled from 'styled-components'
+import {useArrayProp} from '../../hooks'
+import {ThemeProps} from '../../styles'
+import {responsiveRadiusStyle, ResponsiveRadiusStyleProps} from '../../styles/internal'
+import {useTheme_v2} from '../../theme'
+import {ButtonMode, ButtonTextAlign, ButtonTone, ButtonWidth, FlexJustify} from '../../types'
+import {Box} from '../box'
+import {Flex} from '../flex'
+import {Spinner} from '../spinner'
+import {Text} from '../text'
+import {ResponsivePaddingProps, ResponsiveRadiusProps} from '../types'
+import {buttonBaseStyles, buttonColorStyles} from './styles'
+
+/**
+ * @public
+ */
+export interface ButtonProps extends ResponsivePaddingProps, ResponsiveRadiusProps {
+  as?: React.ElementType | keyof JSX.IntrinsicElements
+  fontSize?: number | number[]
+  mode?: ButtonMode
+  icon?: React.ElementType | React.ReactNode
+  iconRight?: React.ElementType | React.ReactNode
+  justify?: FlexJustify | FlexJustify[]
+  /**
+   * @beta Do not use in production, as this might change.
+   */
+  loading?: boolean
+  selected?: boolean
+  space?: number | number[]
+  textAlign?: ButtonTextAlign
+  muted?: boolean
+  text?: React.ReactNode
+  tone?: ButtonTone
+  type?: 'button' | 'reset' | 'submit'
+  width?: ButtonWidth
+}
+
+const Root = styled.button<
+  {$mode: ButtonMode; $tone: ButtonTone; $width?: ButtonWidth} & ResponsiveRadiusStyleProps &
+    ThemeProps
+>(responsiveRadiusStyle, buttonBaseStyles, buttonColorStyles)
+
+const LoadingBox = styled.div`
+  position: absolute;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  background-color: var(--card-bg-color);
+  border-radius: inherit;
+  z-index: 1;
+  box-shadow: inherit;
+`
+
+/**
+ * @public
+ */
+export const Button = forwardRef(function Button(
+  props: ButtonProps & Omit<React.HTMLProps<HTMLButtonElement>, 'as' | 'width'>,
+  ref: React.ForwardedRef<HTMLButtonElement>,
+) {
+  const {
+    children,
+    disabled,
+    fontSize = 1,
+    icon,
+    iconRight,
+    justify: justifyProp = 'center',
+    loading,
+    mode = 'ghost',
+    padding: paddingProp = 3,
+    paddingX: paddingXProp,
+    paddingY: paddingYProp,
+    paddingTop: paddingTopProp,
+    paddingBottom: paddingBottomProp,
+    paddingLeft: paddingLeftProp,
+    paddingRight: paddingRightProp,
+    radius: radiusProp = 2,
+    selected,
+    space: spaceProp = 3,
+    text,
+    textAlign,
+    tone = 'default',
+    type = 'button',
+    muted = false,
+    width,
+    ...restProps
+  } = props
+  const {button} = useTheme_v2()
+
+  const justify = useArrayProp(justifyProp)
+  const padding = useArrayProp(paddingProp)
+  const paddingX = useArrayProp(paddingXProp)
+  const paddingY = useArrayProp(paddingYProp)
+  const paddingTop = useArrayProp(paddingTopProp)
+  const paddingBottom = useArrayProp(paddingBottomProp)
+  const paddingLeft = useArrayProp(paddingLeftProp)
+  const paddingRight = useArrayProp(paddingRightProp)
+  const radius = useArrayProp(radiusProp)
+  const space = useArrayProp(spaceProp)
+
+  const boxProps = useMemo(
+    () => ({
+      // flex: 1,
+      padding,
+      paddingX,
+      paddingY,
+      paddingTop,
+      paddingBottom,
+      paddingLeft,
+      paddingRight,
+    }),
+    [padding, paddingX, paddingY, paddingTop, paddingBottom, paddingLeft, paddingRight],
+  )
+
+  return (
+    <Root
+      data-ui="Button"
+      {...restProps}
+      $mode={mode}
+      $radius={radius}
+      $tone={tone}
+      data-disabled={Boolean(loading || disabled)}
+      data-selected={selected ? '' : undefined}
+      disabled={Boolean(loading || disabled)}
+      ref={ref}
+      type={type}
+      $width={width}
+    >
+      {Boolean(loading) && (
+        <LoadingBox>
+          <Spinner />
+        </LoadingBox>
+      )}
+
+      {(icon || text || iconRight) && (
+        <Box as="span" {...boxProps}>
+          <Flex as="span" justify={justify} gap={space}>
+            {icon && (
+              <Text size={fontSize}>
+                {isValidElement(icon) && icon}
+                {isValidElementType(icon) && createElement(icon)}
+              </Text>
+            )}
+
+            {text && (
+              <Box flex={iconRight ? 1 : undefined}>
+                <Text
+                  muted={muted}
+                  align={textAlign}
+                  size={fontSize}
+                  textOverflow="ellipsis"
+                  weight={button.textWeight}
+                >
+                  {text}
+                </Text>
+              </Box>
+            )}
+
+            {iconRight && (
+              <Text size={fontSize}>
+                {isValidElement(iconRight) && iconRight}
+                {isValidElementType(iconRight) && createElement(iconRight)}
+              </Text>
+            )}
+          </Flex>
+        </Box>
+      )}
+
+      {children && (
+        <Box as="span" {...boxProps}>
+          {children}
+        </Box>
+      )}
+    </Root>
+  )
+})

package/src/core/primitives/button/styles.ts

@@ -0,0 +1,116 @@
+import {CSSObject, getTheme_v2} from '@sanity/ui/theme'
+import {css} from 'styled-components'
+import {ThemeProps} from '../../styles'
+import {_cardColorStyle} from '../../styles/card'
+import {focusRingBorderStyle, focusRingStyle} from '../../styles/internal'
+import {ButtonMode, ButtonTone, ButtonWidth} from '../../types'
+
+/**
+ * @internal
+ */
+export function buttonBaseStyles(
+  props: {$width?: ButtonWidth} & ThemeProps,
+): ReturnType<typeof css> {
+  const {$width} = props
+  const {style} = getTheme_v2(props.theme)
+
+  return css`
+    ${style?.button};
+
+    -webkit-font-smoothing: inherit;
+    appearance: none;
+    display: inline-flex;
+    align-items: center;
+    font: inherit;
+    border: 0;
+    outline: none;
+    user-select: none;
+    text-decoration: none;
+    border: 0;
+    box-sizing: border-box;
+    padding: 0;
+    margin: 0;
+    white-space: nowrap;
+    text-align: left;
+    position: relative;
+    vertical-align: top;
+
+    ${$width === 'fill' &&
+    css`
+      width: -moz-available;
+      width: -webkit-fill-available;
+      width: stretch;
+    `}
+
+    & > span {
+      display: block;
+      flex: 1;
+      min-width: 0;
+      border-radius: inherit;
+    }
+
+    &::-moz-focus-inner {
+      border: 0;
+      padding: 0;
+    }
+  `
+}
+
+function combineBoxShadow(...boxShadows: (string | undefined)[]): string {
+  return boxShadows.filter(Boolean).join(',')
+}
+
+/**
+ * @internal
+ */
+export function buttonColorStyles(
+  props: {$mode: ButtonMode; $tone: ButtonTone} & ThemeProps,
+): CSSObject[] {
+  const {$mode} = props
+  const {button, color: baseColor, style} = getTheme_v2(props.theme)
+  const shadow = props.$mode === 'ghost'
+  const mode = baseColor.button[$mode] || baseColor.button.default
+  const color = mode[props.$tone] || mode.default
+  const border = {
+    width: button.border.width,
+    color: 'var(--card-border-color)',
+  }
+  // const defaultBoxShadow = `inset 0px -1.5px 0px ${buttonTheme.border.width}px color-mix(in srgb, var(--card-border-color) 25%, var(--card-bg-color))`
+  const defaultBoxShadow = undefined
+
+  return [
+    _cardColorStyle(baseColor, color.enabled),
+    {
+      backgroundColor: 'var(--card-bg-color)',
+      color: 'var(--card-fg-color)',
+      boxShadow: focusRingBorderStyle(border),
+      '&:disabled, &[data-disabled="true"]': _cardColorStyle(baseColor, color.disabled),
+      "&:not([data-disabled='true'])": {
+        boxShadow: combineBoxShadow(
+          focusRingBorderStyle(border),
+          shadow ? defaultBoxShadow : undefined,
+        ),
+        '&:focus': {
+          boxShadow: focusRingStyle({
+            base: baseColor,
+            border: {width: 2, color: baseColor.bg},
+            focusRing: button.focusRing,
+          }),
+        },
+        '&:focus:not(:focus-visible)': {
+          boxShadow: combineBoxShadow(
+            focusRingBorderStyle(border),
+            shadow ? defaultBoxShadow : undefined,
+          ),
+        },
+        '@media (hover: hover)': {
+          '&:hover': _cardColorStyle(baseColor, color.hovered),
+          '&:active': _cardColorStyle(baseColor, color.pressed),
+          '&[data-hovered]': _cardColorStyle(baseColor, color.hovered),
+        },
+        '&[data-selected]': _cardColorStyle(baseColor, color.pressed),
+      },
+    },
+    style?.button?.root,
+  ].filter(Boolean) as CSSObject[]
+}

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

@@ -0,0 +1,88 @@
+import {Box, Card, Container, Flex, Grid, Stack, Text} from '@sanity/ui'
+import {WORKSHOP_CARD_TONE_OPTIONS} from '../../../__workshop__/constants'
+
+export default function AsButtonStory() {
+  const tones = Object.entries(WORKSHOP_CARD_TONE_OPTIONS)
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Container>
+        <Grid columns={3} gap={2}>
+          <Box>
+            <Text align="center" size={1} weight="medium">
+              Enabled
+            </Text>
+            <Stack marginTop={3} space={2}>
+              {tones.map(([title, tone]) => (
+                <Card
+                  __unstable_focusRing
+                  as="button"
+                  key={tone}
+                  padding={4}
+                  style={{textAlign: 'center'}}
+                  tone={tone}
+                >
+                  <Stack space={2}>
+                    <Text weight="medium">{title}</Text>
+                    <Text muted>Muted</Text>
+                    <Text accent>Accent</Text>
+                  </Stack>
+                </Card>
+              ))}
+            </Stack>
+          </Box>
+
+          <Box>
+            <Text align="center" size={1} weight="medium">
+              Disabled
+            </Text>
+            <Stack marginTop={3} space={2}>
+              {tones.map(([title, tone]) => (
+                <Card
+                  __unstable_focusRing
+                  as="button"
+                  disabled
+                  key={tone}
+                  padding={4}
+                  style={{textAlign: 'center'}}
+                  tone={tone}
+                >
+                  <Stack space={2}>
+                    <Text weight="medium">{title}</Text>
+                    <Text muted>Muted</Text>
+                    <Text accent>Accent</Text>
+                  </Stack>
+                </Card>
+              ))}
+            </Stack>
+          </Box>
+
+          <Box>
+            <Text align="center" size={1} weight="medium">
+              Selected
+            </Text>
+            <Stack marginTop={3} space={2}>
+              {tones.map(([title, tone]) => (
+                <div aria-selected key={tone}>
+                  <Card
+                    __unstable_focusRing
+                    as="button"
+                    padding={4}
+                    style={{textAlign: 'center'}}
+                    tone={tone}
+                  >
+                    <Stack space={2}>
+                      <Text weight="medium">{title}</Text>
+                      <Text muted>Muted</Text>
+                      <Text accent>Accent</Text>
+                    </Stack>
+                  </Card>
+                </div>
+              ))}
+            </Stack>
+          </Box>
+        </Grid>
+      </Container>
+    </Flex>
+  )
+}

package/src/core/primitives/card/__workshop__/asComponent.tsx

@@ -0,0 +1,27 @@
+import {Card, Flex, Text} from '@sanity/ui'
+import {forwardRef} from 'react'
+
+const CustomLink = forwardRef(function CustomLink(
+  props: {req: string} & Omit<React.HTMLProps<HTMLAnchorElement>, 'as' | 'href'>,
+  ref: React.ForwardedRef<HTMLAnchorElement>,
+): React.ReactElement {
+  const {children, req, ...restProps} = props
+
+  return (
+    <a data-required={req} {...restProps} ref={ref}>
+      {children}
+    </a>
+  )
+})
+
+export default function AsComponentStory() {
+  const props = {href: '#'}
+
+  return (
+    <Flex align="center" height="fill" justify="center">
+      <Card as={CustomLink} data-as="a" {...props} padding={3}>
+        <Text>As component</Text>
+      </Card>
+    </Flex>
+  )
+}

package/src/core/primitives/card/__workshop__/selected.tsx

@@ -0,0 +1,91 @@
+import {EditIcon, PublishIcon} from '@sanity/icons'
+import {Box, Card, Container, Flex, Inline, Stack, Text, ThemeProps, useRootTheme} from '@sanity/ui'
+import {ThemeColorStateToneKey, getTheme_v2} from '@sanity/ui/theme'
+import {useBoolean} from '@sanity/ui-workshop'
+import styled, {css} from 'styled-components'
+
+const TextWithTone = styled(Text)<{$tone: ThemeColorStateToneKey}>((
+  props: {
+    $tone: ThemeColorStateToneKey
+  } & ThemeProps,
+) => {
+  const {$tone} = props
+  const {color} = getTheme_v2(props.theme)
+  const tone = color.button.default[$tone]
+
+  return css`
+    &:not([data-selected]) {
+      --card-fg-color: ${tone.enabled.bg};
+      --card-muted-fg-color: ${tone.enabled.bg};
+    }
+
+    [data-ui='Card']:disabled & {
+      --card-fg-color: inherit;
+      --card-muted-fg-color: inherit;
+    }
+  `
+})
+
+export default function SelectedStory() {
+  const disabled = useBoolean('Disabled', false) || false
+  const selected = useBoolean('Selected', false) || false
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={4} sizing="border">
+      <Container width={0}>
+        <Stack space={1}>
+          <Card
+            __unstable_focusRing
+            as="button"
+            disabled={disabled}
+            padding={3}
+            radius={2}
+            selected={selected}
+          >
+            <Preview selected={selected} />
+          </Card>
+
+          <Card
+            __unstable_focusRing
+            as="button"
+            disabled={disabled}
+            padding={3}
+            radius={2}
+            selected={selected}
+            tone="critical"
+          >
+            <Preview selected={selected} />
+          </Card>
+        </Stack>
+      </Container>
+    </Flex>
+  )
+}
+
+function Preview({selected}: {selected: boolean}) {
+  const rootTheme = useRootTheme()
+
+  return (
+    <Flex>
+      <Box flex={1}>
+        <Text>Title</Text>
+      </Box>
+      <Inline space={3}>
+        <TextWithTone
+          data-selected={selected ? '' : undefined}
+          muted
+          $tone={rootTheme.tone === 'default' ? 'caution' : 'default'}
+        >
+          <EditIcon />
+        </TextWithTone>
+        <TextWithTone
+          data-selected={selected ? '' : undefined}
+          muted
+          $tone={rootTheme.tone === 'default' ? 'positive' : 'default'}
+        >
+          <PublishIcon />
+        </TextWithTone>
+      </Inline>
+    </Flex>
+  )
+}

package/src/core/primitives/card/card.tsx

@@ -0,0 +1,111 @@
+import {ThemeColorSchemeKey} from '@sanity/ui/theme'
+import {forwardRef} from 'react'
+import {isValidElementType} from 'react-is'
+import styled from 'styled-components'
+import {useArrayProp} from '../../hooks'
+import {
+  responsiveBorderStyle,
+  ResponsiveBorderStyleProps,
+  responsiveRadiusStyle,
+  ResponsiveRadiusStyleProps,
+  responsiveShadowStyle,
+  ResponsiveShadowStyleProps,
+} from '../../styles/internal'
+import {ThemeColorProvider, useRootTheme} from '../../theme'
+import {CardTone} from '../../types'
+import {Box, BoxProps} from '../box'
+import {ResponsiveBorderProps, ResponsiveRadiusProps, ResponsiveShadowProps} from '../types'
+import {cardStyle} from './styles'
+import {CardStyleProps} from './types'
+
+/**
+ * @public
+ */
+export interface CardProps
+  extends BoxProps,
+    ResponsiveBorderProps,
+    ResponsiveRadiusProps,
+    ResponsiveShadowProps {
+  /**
+   * Do not use in production.
+   * @beta
+   */
+  __unstable_checkered?: boolean
+  /**
+   * Do not use in production.
+   * @beta
+   */
+  __unstable_focusRing?: boolean
+  pressed?: boolean
+  scheme?: ThemeColorSchemeKey
+  tone?: CardTone
+}
+
+const Root = styled(Box)<
+  CardStyleProps &
+    ResponsiveRadiusStyleProps &
+    ResponsiveBorderStyleProps &
+    ResponsiveShadowStyleProps
+>(responsiveBorderStyle, responsiveRadiusStyle, responsiveShadowStyle, cardStyle)
+
+/**
+ * The `Card` component acts much like a `Box`, but with a background and foreground color.
+ * Components within a `Card` inherit its colors.
+ *
+ * @public
+ */
+export const Card = forwardRef(function Card(
+  props: CardProps & Omit<React.HTMLProps<HTMLDivElement>, 'as' | 'height'>,
+  ref: React.ForwardedRef<HTMLDivElement>,
+) {
+  const {
+    __unstable_checkered: checkered = false,
+    __unstable_focusRing: focusRing = false,
+    as: asProp,
+    border,
+    borderTop,
+    borderRight,
+    borderBottom,
+    borderLeft,
+    pressed,
+    radius = 0,
+    scheme,
+    selected,
+    shadow,
+    tone: toneProp = 'default',
+    ...restProps
+  } = props
+
+  const as = isValidElementType(asProp) ? asProp : 'div'
+  const rootTheme = useRootTheme()
+  const tone = toneProp === 'inherit' ? rootTheme.tone : toneProp
+
+  // todo: Consider adding the wrapper approach for nested cards in which the tones are not changing, avoid unnecessary ThemeColorProvider
+  return (
+    <ThemeColorProvider scheme={scheme} tone={tone}>
+      <Root
+        data-as={typeof as === 'string' ? as : undefined}
+        data-scheme={rootTheme.scheme}
+        data-ui="Card"
+        data-tone={tone}
+        {...restProps}
+        $border={useArrayProp(border)}
+        $borderTop={useArrayProp(borderTop)}
+        $borderRight={useArrayProp(borderRight)}
+        $borderBottom={useArrayProp(borderBottom)}
+        $borderLeft={useArrayProp(borderLeft)}
+        $checkered={checkered}
+        $focusRing={focusRing}
+        $radius={useArrayProp(radius)}
+        $shadow={useArrayProp(shadow)}
+        $tone={tone}
+        data-checkered={checkered ? '' : undefined}
+        data-pressed={pressed ? '' : undefined}
+        data-selected={selected ? '' : undefined}
+        forwardedAs={as}
+        ref={ref}
+        selected={selected}
+      />
+    </ThemeColorProvider>
+  )
+})