@sanity/ui 1.0.0-beta.9 → 1.0.0

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

@@ -0,0 +1,97 @@
+import {EditIcon, PublishIcon} from '@sanity/icons'
+import {
+  Box,
+  Card,
+  Container,
+  Flex,
+  Inline,
+  Stack,
+  Text,
+  Theme,
+  ThemeColorToneKey,
+  useRootTheme,
+} from '@sanity/ui'
+import {useBoolean} from '@sanity/ui-workshop'
+import styled, {css} from 'styled-components'
+
+const TextWithTone = styled(Text)<{$tone: ThemeColorToneKey}>(
+  ({$tone, theme}: {$tone: ThemeColorToneKey; theme: Theme}) => {
+    const tone = theme.sanity.color.solid[$tone]
+
+    return css`
+      &:not([data-selected]) {
+        --card-fg-color: ${tone ? tone.enabled.bg : undefined};
+        --card-muted-fg-color: ${tone ? tone.enabled.bg : undefined};
+      }
+
+      [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 theme = useRootTheme()
+
+  return (
+    <Flex>
+      <Box flex={1}>
+        <Text>Title</Text>
+      </Box>
+      <Inline space={3}>
+        <TextWithTone
+          data-selected={selected ? '' : undefined}
+          muted
+          $tone={theme.tone === 'default' ? 'caution' : 'default'}
+        >
+          <EditIcon />
+        </TextWithTone>
+        <TextWithTone
+          data-selected={selected ? '' : undefined}
+          muted
+          $tone={theme.tone === 'default' ? 'positive' : 'default'}
+        >
+          <PublishIcon />
+        </TextWithTone>
+      </Inline>
+    </Flex>
+  )
+}

package/src/primitives/card/__workshop__/styled.tsx

@@ -0,0 +1,14 @@
+import {Card, Flex, Text} from '@sanity/ui'
+import styled from 'styled-components'
+
+const StyledCard = styled(Card).attrs({forwardedAs: 'ol'})``
+
+export default function StyledCardStory() {
+  return (
+    <Flex align="center" height="fill" justify="center">
+      <StyledCard>
+        <Text as="li">Styled</Text>
+      </StyledCard>
+    </Flex>
+  )
+}

package/src/primitives/card/card.tsx

@@ -0,0 +1,106 @@
+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, ThemeColorSchemeKey, 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)
+
+/**
+ * @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
+
+  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>
+  )
+})

package/src/primitives/card/index.ts

@@ -0,0 +1,2 @@
+export * from './card'
+export * from './types'

package/src/primitives/card/styles.ts

@@ -0,0 +1,150 @@
+import {css, FlattenSimpleInterpolation} from 'styled-components'
+import {ThemeProps} from '../../styles'
+import {_colorVarsStyle} from '../../styles/colorVars'
+import {focusRingBorderStyle, focusRingStyle} from '../../styles/focusRing'
+import {CardStyleProps} from './types'
+
+export function cardStyle(
+  props: CardStyleProps & ThemeProps
+): Array<FlattenSimpleInterpolation | (() => FlattenSimpleInterpolation)> {
+  return [cardBaseStyle(props), cardColorStyle(props)]
+}
+
+export function cardBaseStyle(props: CardStyleProps & ThemeProps): FlattenSimpleInterpolation {
+  const {$checkered, theme} = props
+  const space = theme.sanity.space
+
+  return css`
+    ${$checkered &&
+    css`
+      background-size: ${space[3]}px ${space[3]}px;
+      background-position: 50% 50%;
+      background-image: var(--card-bg-image);
+    `}
+
+    &[data-as='button'] {
+      -webkit-font-smoothing: inherit;
+      appearance: none;
+      outline: none;
+      font: inherit;
+      text-align: inherit;
+      border: 0;
+      width: stretch;
+    }
+
+    /* &:is(a) */
+    &[data-as='a'] {
+      outline: none;
+      text-decoration: none;
+    }
+
+    /* &:is(pre) */
+    &[data-as='pre'] {
+      font: inherit;
+    }
+  `
+}
+
+export function cardColorStyle(props: CardStyleProps & ThemeProps): FlattenSimpleInterpolation {
+  const {$checkered, $focusRing, theme} = props
+  const {focusRing} = theme.sanity
+  const {base, card, dark} = theme.sanity.color
+  const border = {width: 0, color: 'var(--card-border-color)'}
+
+  return css`
+    color-scheme: ${dark ? 'dark' : 'light'};
+
+    ${_colorVarsStyle(base, card.enabled, $checkered)}
+
+    background-color: var(--card-bg-color);
+    color: var(--card-fg-color);
+
+    /* &:is(button) */
+    &[data-as='button'] {
+      --card-focus-ring-box-shadow: none;
+
+      cursor: default;
+      box-shadow: var(--card-focus-ring-box-shadow);
+
+      &:disabled {
+        ${_colorVarsStyle(base, card.disabled, $checkered)}
+      }
+
+      &:not(:disabled) {
+        &[data-pressed] {
+          ${_colorVarsStyle(base, card.pressed, $checkered)}
+        }
+
+        &[data-selected] {
+          ${_colorVarsStyle(base, card.selected, $checkered)}
+        }
+
+        @media (hover: hover) {
+          &:not([data-pressed]):not([data-selected]) {
+            &:hover {
+              ${_colorVarsStyle(base, card.hovered, $checkered)}
+            }
+
+            &:active {
+              ${_colorVarsStyle(base, card.pressed, $checkered)}
+            }
+          }
+        }
+
+        &:focus {
+          --card-focus-ring-box-shadow: ${$focusRing
+            ? focusRingStyle({base, border, focusRing})
+            : undefined};
+        }
+
+        &:focus:not(:focus-visible) {
+          --card-focus-ring-box-shadow: ${$focusRing ? focusRingBorderStyle(border) : undefined};
+        }
+      }
+    }
+
+    /* &:is(a) */
+    &[data-as='a'] {
+      cursor: pointer;
+      box-shadow: var(--card-focus-ring-box-shadow);
+
+      &[data-disabled] {
+        ${_colorVarsStyle(base, card.disabled, $checkered)}
+      }
+
+      &:not([data-disabled]) {
+        &[data-pressed] {
+          ${_colorVarsStyle(base, card.pressed, $checkered)}
+        }
+
+        &[data-selected] {
+          ${_colorVarsStyle(base, card.selected, $checkered)}
+        }
+
+        @media (hover: hover) {
+          &:not([data-pressed]):not([data-selected]) {
+            &:hover {
+              ${_colorVarsStyle(base, card.hovered, $checkered)}
+            }
+
+            &:active {
+              ${_colorVarsStyle(base, card.pressed, $checkered)}
+            }
+          }
+        }
+
+        &:focus {
+          --card-focus-ring-box-shadow: ${$focusRing
+            ? focusRingStyle({base, border, focusRing})
+            : undefined};
+        }
+
+        &:focus:not(:focus-visible) {
+          --card-focus-ring-box-shadow: ${$focusRing ? focusRingBorderStyle(border) : undefined};
+        }
+      }
+    }
+
+    ${theme.sanity.styles?.card?.root}
+  `
+}

package/src/primitives/card/types.ts

@@ -0,0 +1,10 @@
+import {ThemeColorToneKey} from '../../theme'
+
+/**
+ * @internal
+ */
+export interface CardStyleProps {
+  $checkered: boolean
+  $focusRing: boolean
+  $tone: ThemeColorToneKey
+}

package/src/primitives/checkbox/__workshop__/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "@typescript-eslint/explicit-module-boundary-types": "off"
+  }
+}

package/src/primitives/checkbox/__workshop__/example.tsx

@@ -0,0 +1,25 @@
+import {Box, Checkbox, Flex, Text} from '@sanity/ui'
+import {useCallback, useState} from 'react'
+
+export default function ExampleStory() {
+  const [checked, setChecked] = useState<boolean | undefined>(undefined)
+  const [indeterminate] = useState(checked === undefined)
+  const handleChange = useCallback(() => setChecked((val) => !val), [])
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Flex align="center" as="label">
+        <Checkbox
+          checked={checked || false}
+          indeterminate={indeterminate}
+          onChange={handleChange}
+        />
+        <Box marginLeft={2}>
+          <Text size={1} weight="semibold">
+            Toggle
+          </Text>
+        </Box>
+      </Flex>
+    </Flex>
+  )
+}

package/src/primitives/checkbox/__workshop__/index.ts

@@ -0,0 +1,13 @@
+import {defineScope} from '@sanity/ui-workshop'
+import {lazy} from 'react'
+
+export default defineScope({
+  name: 'primitives/checkbox',
+  title: 'Checkbox',
+  stories: [
+    {name: 'props', title: 'Props', component: lazy(() => import('./props'))},
+    {name: 'example', title: 'Example', component: lazy(() => import('./example'))},
+    {name: 'read-only', title: 'Read-only', component: lazy(() => import('./readOnly'))},
+    {name: 'multiple-tones', title: 'Multiple tones', component: lazy(() => import('./tones'))},
+  ],
+})

package/src/primitives/checkbox/__workshop__/props.tsx

@@ -0,0 +1,33 @@
+import {Box, Checkbox, Flex, Text} from '@sanity/ui'
+import {useAction, useBoolean} from '@sanity/ui-workshop'
+
+export default function PropsStory() {
+  const checked = useBoolean('Checked', false, 'Props')
+  const disabled = useBoolean('Disabled', false, 'Props')
+  const indeterminate = useBoolean('Indeterminate', false, 'Props')
+  const onChange = useAction('onChange')
+  const onFocus = useAction('onFocus')
+  const onBlur = useAction('onBlur')
+  const readOnly = useBoolean('Read only', false, 'Props')
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Flex align="center" as="label">
+        <Checkbox
+          checked={checked}
+          disabled={disabled}
+          indeterminate={indeterminate}
+          onChange={onChange}
+          onFocus={onFocus}
+          onBlur={onBlur}
+          readOnly={readOnly}
+        />
+        <Box marginLeft={2}>
+          <Text size={1} weight="semibold">
+            Toggle
+          </Text>
+        </Box>
+      </Flex>
+    </Flex>
+  )
+}

package/src/primitives/checkbox/__workshop__/readOnly.tsx

@@ -0,0 +1,16 @@
+import {Box, Checkbox, Flex, Text} from '@sanity/ui'
+
+export default function ReadOnlyStory() {
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Flex align="center" as="label">
+        <Checkbox id="checkbox-example" readOnly />
+        <Box marginLeft={2}>
+          <Text size={1} weight="semibold">
+            Toggle
+          </Text>
+        </Box>
+      </Flex>
+    </Flex>
+  )
+}

package/src/primitives/checkbox/__workshop__/tones.tsx

@@ -0,0 +1,22 @@
+import {Card, Checkbox, Flex, Stack} from '@sanity/ui'
+
+export default function MultipleTonesStory() {
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Stack>
+        <Card padding={3} tone="primary">
+          <Checkbox />
+        </Card>
+        <Card padding={3} tone="positive">
+          <Checkbox />
+        </Card>
+        <Card padding={3} tone="caution">
+          <Checkbox />
+        </Card>
+        <Card padding={3} tone="critical">
+          <Checkbox />
+        </Card>
+      </Stack>
+    </Flex>
+  )
+}

package/src/primitives/checkbox/checkbox.tsx

@@ -0,0 +1,63 @@
+import {CheckmarkIcon, RemoveIcon} from '@sanity/icons'
+import {forwardRef, useEffect} from 'react'
+import styled from 'styled-components'
+import {useForwardedRef, useCustomValidity} from '../../hooks'
+import {checkboxBaseStyles, inputElementStyles} from './styles'
+
+/**
+ * @public
+ */
+export interface CheckboxProps {
+  indeterminate?: boolean
+  customValidity?: string
+}
+
+const Root = styled.div(checkboxBaseStyles)
+const Input = styled.input(inputElementStyles)
+
+/**
+ * @public
+ */
+export const Checkbox = forwardRef(function Checkbox(
+  props: Omit<React.HTMLProps<HTMLInputElement>, 'as' | 'type'> & CheckboxProps,
+  forwardedRef: React.ForwardedRef<HTMLInputElement>
+) {
+  const {
+    checked,
+    className,
+    disabled,
+    indeterminate,
+    customValidity,
+    readOnly,
+    style,
+    ...restProps
+  } = props
+  const ref = useForwardedRef(forwardedRef)
+
+  useCustomValidity(ref, customValidity)
+
+  useEffect(() => {
+    if (ref.current) {
+      // Set the indeterminate state
+      ref.current.indeterminate = indeterminate || false
+    }
+  }, [indeterminate, ref])
+
+  return (
+    <Root className={className} data-ui="Checkbox" style={style}>
+      <Input
+        data-read-only={!disabled && readOnly ? '' : undefined}
+        {...restProps}
+        checked={checked}
+        disabled={disabled || readOnly}
+        type="checkbox"
+        readOnly={readOnly}
+        ref={ref}
+      />
+      <span>
+        <CheckmarkIcon />
+        <RemoveIcon />
+      </span>
+    </Root>
+  )
+})

package/src/primitives/checkbox/index.ts

@@ -0,0 +1 @@
+export * from './checkbox'

package/src/primitives/checkbox/styles.ts

@@ -0,0 +1,97 @@
+import {css, FlattenSimpleInterpolation} from 'styled-components'
+import {rem, ThemeProps} from '../../styles'
+import {focusRingBorderStyle, focusRingStyle} from '../../styles/internal'
+
+export function checkboxBaseStyles(): FlattenSimpleInterpolation {
+  return css`
+    position: relative;
+    display: inline-block;
+  `
+}
+
+export function inputElementStyles(props: ThemeProps): FlattenSimpleInterpolation {
+  const {theme} = props
+  const color = theme.sanity.color.input
+  const {focusRing, input, radius} = theme.sanity
+
+  return css`
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    outline: none;
+    opacity: 0;
+    z-index: 1;
+    padding: 0;
+    margin: 0;
+
+    & + span {
+      position: relative;
+      display: block;
+      height: ${rem(input.checkbox.size)};
+      width: ${rem(input.checkbox.size)};
+      box-sizing: border-box;
+      box-shadow: ${focusRingBorderStyle({
+        color: color.default.enabled.border,
+        width: input.border.width,
+      })};
+      border-radius: ${rem(radius[2])};
+      line-height: 1;
+      background-color: ${color.default.enabled.bg};
+
+      & > svg {
+        display: block;
+        position: absolute;
+        opacity: 0;
+        height: 100%;
+        width: 100%;
+
+        & > path {
+          vector-effect: non-scaling-stroke;
+          stroke-width: 2 !important;
+        }
+      }
+    }
+
+    &:not(:disabled):focus + span {
+      box-shadow: ${focusRingStyle({
+        border: {width: input.border.width, color: color.default.enabled.border},
+        focusRing,
+      })};
+    }
+
+    &:not(:disabled):focus:not(:focus-visible) + span {
+      box-shadow: ${focusRingBorderStyle({
+        color: color.default.enabled.border,
+        width: input.border.width,
+      })};
+    }
+
+    &:checked + span > svg:first-child {
+      opacity: 1;
+    }
+
+    &[data-read-only] + span {
+      background-color: ${color.default.readOnly.bg};
+      box-shadow: ${focusRingBorderStyle({
+        width: input.border.width,
+        color: color.default.readOnly.border,
+      })};
+      color: ${color.default.readOnly.fg};
+    }
+
+    &:not([data-read-only]):disabled + span {
+      background-color: ${color.default.disabled.bg};
+      box-shadow: ${focusRingBorderStyle({
+        width: input.border.width,
+        color: color.default.disabled.border,
+      })};
+      color: ${color.default.disabled.fg};
+    }
+
+    &:indeterminate + span > svg:last-child {
+      opacity: 1;
+    }
+  `
+}

package/src/primitives/code/__workshop__/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "@typescript-eslint/explicit-module-boundary-types": "off"
+  }
+}

package/src/primitives/code/__workshop__/index.ts

@@ -0,0 +1,19 @@
+import {defineScope} from '@sanity/ui-workshop'
+import {lazy} from 'react'
+
+export default defineScope({
+  name: 'primitives/code',
+  title: 'Code',
+  stories: [
+    {
+      name: 'props',
+      title: 'Props',
+      component: lazy(() => import('./props')),
+    },
+    {
+      name: 'optical-alignment',
+      title: 'Optical alignment',
+      component: lazy(() => import('./opticalAlignment')),
+    },
+  ],
+})