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

package/src/core/primitives/switch/switch.tsx

@@ -0,0 +1,62 @@
+import {forwardRef, useEffect} from 'react'
+import styled from 'styled-components'
+import {useForwardedRef} from '../../hooks'
+import {
+  switchBaseStyles,
+  switchRepresentationStyles,
+  switchThumbStyles,
+  switchTrackStyles,
+  switchInputStyles,
+} from './styles'
+
+/**
+ * @public
+ */
+export interface SwitchProps {
+  indeterminate?: boolean
+}
+
+const Root = styled.span(switchBaseStyles)
+const Input = styled.input(switchInputStyles)
+const Representation = styled.span(switchRepresentationStyles)
+const Track = styled.span(switchTrackStyles)
+const Thumb = styled.span<{$checked?: boolean; $indeterminate?: boolean}>(switchThumbStyles)
+
+/**
+ * The `Switch` component allows the user to toggle a setting on and off.
+ *
+ * Extends all properties of an `<input type="checkbox" />` element, except type.
+ *
+ * @public
+ */
+export const Switch = forwardRef(function Switch(
+  props: Omit<React.HTMLProps<HTMLInputElement>, 'as' | 'type'> & SwitchProps,
+  forwardedRef: React.ForwardedRef<HTMLInputElement>,
+) {
+  const {checked, className, disabled, indeterminate, readOnly, style, ...restProps} = props
+  const ref = useForwardedRef(forwardedRef)
+
+  useEffect(() => {
+    if (ref.current) {
+      // Set the indeterminate state
+      ref.current.indeterminate = indeterminate || false
+    }
+  }, [indeterminate, ref])
+
+  return (
+    <Root className={className} data-ui="Switch" style={style}>
+      <Input
+        data-read-only={!disabled && readOnly ? '' : undefined}
+        {...restProps}
+        checked={indeterminate !== true && checked}
+        disabled={disabled || readOnly}
+        type="checkbox"
+        ref={ref}
+      />
+      <Representation aria-hidden data-name="representation">
+        <Track />
+        <Thumb $checked={checked} $indeterminate={indeterminate} />
+      </Representation>
+    </Root>
+  )
+})

package/src/core/primitives/text/__workshop__/colored.tsx

@@ -0,0 +1,29 @@
+import {Flex, Text, ThemeProps} from '@sanity/ui'
+import {ThemeColorAvatarColorKey, ThemeColorSpotKey, getTheme_v2} from '@sanity/ui/theme'
+import {useSelect} from '@sanity/ui-workshop'
+import styled, {css} from 'styled-components'
+import {WORKSHOP_SPOT_COLOR_OPTIONS} from '../../../__workshop__/constants'
+
+const ColoredText = styled(Text)<{$color?: ThemeColorSpotKey}>((
+  props: {
+    $color?: ThemeColorAvatarColorKey
+  } & ThemeProps,
+) => {
+  const {color} = getTheme_v2(props.theme)
+
+  return css`
+    color: ${color.avatar[props.$color || 'gray'].bg};
+  `
+})
+
+export default function ColoredTextStory() {
+  const color = useSelect('Color', WORKSHOP_SPOT_COLOR_OPTIONS, 'gray')
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <ColoredText align="center" $color={color} size={4} weight="bold">
+        {color}
+      </ColoredText>
+    </Flex>
+  )
+}

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

@@ -0,0 +1,73 @@
+import {getTheme_v2} from '@sanity/ui/theme'
+import {css} from 'styled-components'
+import {ThemeProps} from '../../styles'
+
+export function textBaseStyle(
+  props: {$accent?: boolean; $muted?: boolean} & ThemeProps,
+): ReturnType<typeof css> {
+  const {$accent, $muted} = props
+  const {font} = getTheme_v2(props.theme)
+
+  return css`
+    color: var(--card-fg-color);
+
+    ${$accent &&
+    css`
+      color: var(--card-accent-fg-color);
+    `}
+
+    ${$muted &&
+    css`
+      color: var(--card-muted-fg-color);
+    `}
+
+    & code {
+      font-family: ${font.code.family};
+      border-radius: 1px;
+      background-color: var(--card-code-bg-color);
+      color: var(--card-code-fg-color);
+    }
+
+    & a {
+      text-decoration: none;
+      border-radius: 1px;
+      color: var(--card-link-color);
+      outline: none;
+
+      @media (hover: hover) {
+        &:hover {
+          text-decoration: underline;
+        }
+      }
+
+      &:focus {
+        box-shadow:
+          0 0 0 1px var(--card-bg-color),
+          0 0 0 3px var(--card-focus-ring-color);
+      }
+
+      &:focus:not(:focus-visible) {
+        box-shadow: none;
+      }
+    }
+
+    & strong {
+      font-weight: ${font.text.weights.bold};
+    }
+
+    & svg {
+      /* Certain popular CSS libraries changes the defaults for SVG display */
+      /* Make sure SVGs are rendered as inline elements */
+      display: inline;
+    }
+
+    & [data-sanity-icon] {
+      vertical-align: baseline;
+      color: var(--card-icon-color);
+
+      & path {
+        vector-effect: non-scaling-stroke !important;
+      }
+    }
+  `
+}

package/src/core/primitives/text/text.tsx

@@ -0,0 +1,86 @@
+import {ThemeFontWeightKey} from '@sanity/ui/theme'
+import {forwardRef} from 'react'
+import styled from 'styled-components'
+import {useArrayProp} from '../../hooks'
+import {
+  ResponsiveFontStyleProps,
+  responsiveTextAlignStyle,
+  responsiveTextFont,
+} from '../../styles/internal'
+import {TextAlign} from '../../types'
+import {textBaseStyle} from './styles'
+
+/**
+ * @public
+ */
+export interface TextProps {
+  accent?: boolean
+  align?: TextAlign | TextAlign[]
+  as?: React.ElementType | keyof JSX.IntrinsicElements
+  /** When `true` the text color will be muted. */
+  muted?: boolean
+  size?: number | number[]
+  /**
+   * Controls how overflowing text is treated.
+   * Use `textOverflow="ellipsis"` to render text as a single line which is concatenated with a `…` symbol.
+   * @beta
+   */
+  textOverflow?: 'ellipsis'
+  weight?: ThemeFontWeightKey
+}
+
+const Root = styled.div<ResponsiveFontStyleProps>(
+  responsiveTextFont,
+  responsiveTextAlignStyle,
+  textBaseStyle,
+)
+
+const SpanWithTextOverflow = styled.span`
+  display: block;
+  white-space: nowrap;
+  text-overflow: ellipsis;
+  overflow: hidden;
+  overflow: clip;
+`
+
+/**
+ * The `Text` component is an agile, themed typographic element.
+ *
+ * @public
+ */
+export const Text = forwardRef(function Text(
+  props: TextProps & Omit<React.HTMLProps<HTMLDivElement>, 'as' | 'size'>,
+  ref: React.ForwardedRef<HTMLDivElement>,
+) {
+  const {
+    accent = false,
+    align,
+    children: childrenProp,
+    muted = false,
+    size = 2,
+    textOverflow,
+    weight,
+    ...restProps
+  } = props
+
+  let children = childrenProp
+
+  if (textOverflow === 'ellipsis') {
+    children = <SpanWithTextOverflow>{children}</SpanWithTextOverflow>
+  }
+
+  return (
+    <Root
+      data-ui="Text"
+      {...restProps}
+      $accent={accent}
+      $align={useArrayProp(align)}
+      $muted={muted}
+      ref={ref}
+      $size={useArrayProp(size)}
+      $weight={weight}
+    >
+      <span>{children}</span>
+    </Root>
+  )
+})

package/src/core/primitives/textArea/__workshop__/plain.tsx

@@ -0,0 +1,49 @@
+import {Card, Container, Flex, Stack, Text, TextArea} from '@sanity/ui'
+import {useBoolean, useSelect, useText} from '@sanity/ui-workshop'
+import {
+  WORKSHOP_CARD_TONE_OPTIONS,
+  WORKSHOP_FONT_WEIGHT_OPTIONS,
+  WORKSHOP_RADIUS_OPTIONS,
+  WORKSHOP_SPACE_OPTIONS,
+  WORKSHOP_TEXT_FONT_SIZE_OPTIONS,
+} from '../../../__workshop__/constants'
+
+export default function PlainStory() {
+  const tone = useSelect('Tone', WORKSHOP_CARD_TONE_OPTIONS)
+
+  const border = useBoolean('Border', true, 'Props')
+  const customValidity = useText('Custom validity', '', 'Props') || undefined
+  const disabled = useBoolean('Disabled', false, 'Props')
+  const fontSize = useSelect('Font size', WORKSHOP_TEXT_FONT_SIZE_OPTIONS, 2, 'Props')
+  const padding = useSelect('Padding', WORKSHOP_SPACE_OPTIONS, 3, 'Props')
+  const placeholder = useText('Placeholder', '', 'Props') || undefined
+  const radius = useSelect('Radius', WORKSHOP_RADIUS_OPTIONS, 0, 'Props')
+  const readOnly = useBoolean('Read only', false, 'Props')
+  const weight = useSelect('Weight', WORKSHOP_FONT_WEIGHT_OPTIONS, undefined, 'Props')
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Container width={0}>
+        <Card padding={3} tone={tone}>
+          <Stack space={3}>
+            <Text as="label" htmlFor="text-area-example" size={1} weight="medium">
+              TextArea
+            </Text>
+            <TextArea
+              border={border}
+              customValidity={customValidity}
+              disabled={disabled}
+              fontSize={fontSize}
+              id="text-area-example"
+              padding={padding}
+              placeholder={placeholder}
+              radius={radius}
+              readOnly={readOnly}
+              weight={weight}
+            />
+          </Stack>
+        </Card>
+      </Container>
+    </Flex>
+  )
+}

package/src/core/primitives/textArea/textArea.tsx

@@ -0,0 +1,106 @@
+import {ThemeFontWeightKey} from '@sanity/ui/theme'
+import {forwardRef} from 'react'
+import styled from 'styled-components'
+import {useForwardedRef, useCustomValidity, useArrayProp} from '../../hooks'
+import {
+  responsiveInputPaddingStyle,
+  responsiveRadiusStyle,
+  ResponsiveRadiusStyleProps,
+  TextInputResponsivePaddingStyleProps,
+  TextInputInputStyleProps,
+  TextInputRepresentationStyleProps,
+  textInputRootStyle,
+  textInputBaseStyle,
+  textInputFontSizeStyle,
+  textInputRepresentationStyle,
+} from '../../styles/internal'
+import {useRootTheme} from '../../theme'
+import {ResponsiveRadiusProps} from '../types'
+
+/**
+ * @public
+ */
+export interface TextAreaProps extends ResponsiveRadiusProps {
+  border?: boolean
+  customValidity?: string
+  fontSize?: number | number[]
+  padding?: number | number[]
+  weight?: ThemeFontWeightKey
+}
+
+const Root = styled.span(textInputRootStyle)
+
+const InputRoot = styled.span`
+  flex: 1;
+  min-width: 0;
+  display: block;
+  position: relative;
+`
+
+const Input = styled.textarea<TextInputResponsivePaddingStyleProps & TextInputInputStyleProps>(
+  responsiveInputPaddingStyle,
+  textInputBaseStyle,
+  textInputFontSizeStyle,
+)
+
+const Presentation = styled.div<ResponsiveRadiusStyleProps & TextInputRepresentationStyleProps>(
+  responsiveRadiusStyle,
+  textInputRepresentationStyle,
+)
+
+/**
+ * A multiline text input.
+ *
+
+ * @public
+ */
+export const TextArea = forwardRef(function TextArea(
+  props: TextAreaProps & Omit<React.HTMLProps<HTMLTextAreaElement>, 'as'>,
+  forwardedRef: React.ForwardedRef<HTMLTextAreaElement>,
+) {
+  const {
+    border = true,
+    customValidity,
+    disabled = false,
+    fontSize = 2,
+    padding = 3,
+    radius = 2,
+    weight,
+    ...restProps
+  } = props
+
+  const ref = useForwardedRef(forwardedRef)
+
+  const rootTheme = useRootTheme()
+
+  useCustomValidity(ref, customValidity)
+
+  return (
+    <Root data-ui="TextArea">
+      <InputRoot>
+        <Input
+          data-as="textarea"
+          data-scheme={rootTheme.scheme}
+          data-tone={rootTheme.tone}
+          {...restProps}
+          $fontSize={useArrayProp(fontSize)}
+          $padding={useArrayProp(padding)}
+          $scheme={rootTheme.scheme}
+          $space={useArrayProp(0)}
+          $tone={rootTheme.tone}
+          $weight={weight}
+          disabled={disabled}
+          ref={ref}
+        />
+        <Presentation
+          $radius={useArrayProp(radius)}
+          $scheme={rootTheme.scheme}
+          $tone={rootTheme.tone}
+          data-border={border ? '' : undefined}
+          data-scheme={rootTheme.scheme}
+          data-tone={rootTheme.tone}
+        />
+      </InputRoot>
+    </Root>
+  )
+})

package/src/core/primitives/textInput/__workshop__/plain.tsx

@@ -0,0 +1,98 @@
+import {icons, IconSymbol} from '@sanity/icons'
+import {Container, Flex, Stack, Text, TextInput} from '@sanity/ui'
+import {useBoolean, useSelect, useText} from '@sanity/ui-workshop'
+import {PerfTestProps, usePerfTest} from '@sanity/ui-workshop/plugin-perf'
+import {fireEvent} from '@testing-library/dom'
+import {useCallback, useState} from 'react'
+import {
+  WORKSHOP_TEXT_FONT_SIZE_OPTIONS,
+  WORKSHOP_FONT_WEIGHT_OPTIONS,
+  WORKSHOP_ICON_SYMBOL_OPTIONS,
+  WORKSHOP_RADIUS_OPTIONS,
+  WORKSHOP_SPACE_OPTIONS,
+} from '../../../__workshop__/constants'
+
+const typingPerfTest: PerfTestProps<HTMLInputElement> = {
+  name: 'typing',
+  title: 'Typing',
+  description: 'This test types one character at a time',
+  run({target}) {
+    const text = 'Hello, world & Hello, world & Hello, world'
+    const len = text.length
+
+    for (let i = 0; i < len; i += 1) {
+      const value = text.slice(0, i + 1)
+
+      fireEvent.change(target, {target: {value}})
+    }
+  },
+}
+
+export default function PlainStory() {
+  const {ref, Wrapper} = usePerfTest(typingPerfTest)
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Container width={0}>
+        <Stack space={3}>
+          <Text as="label" htmlFor="text-input-example" size={1} weight="medium">
+            TextInput
+          </Text>
+          <Wrapper>
+            <TextInputTest inputRef={ref} />
+          </Wrapper>
+        </Stack>
+      </Container>
+    </Flex>
+  )
+}
+
+function TextInputTest(props: {inputRef: React.Ref<HTMLInputElement>}) {
+  const {inputRef: ref} = props
+  const border = useBoolean('Border', true, 'Props')
+  const customValidity = useText('Custom validity', '', 'Props') || undefined
+  const disabled = useBoolean('Disabled', false, 'Props')
+  const fontSize = useSelect('Font size', WORKSHOP_TEXT_FONT_SIZE_OPTIONS, 2, 'Props')
+  const icon = useSelect('Icon', WORKSHOP_ICON_SYMBOL_OPTIONS, 'search', 'Props') as IconSymbol
+  const iconRight = useSelect(
+    'Icon (right)',
+    WORKSHOP_ICON_SYMBOL_OPTIONS,
+    'close',
+    'Props',
+  ) as IconSymbol
+  const padding = useSelect('Padding', WORKSHOP_SPACE_OPTIONS, 3, 'Props')
+  const placeholder = useText('Placeholder', '', 'Props') || undefined
+  const radius = useSelect('Radius', WORKSHOP_RADIUS_OPTIONS, 0, 'Props')
+  const readOnly = useBoolean('Read only', false, 'Props')
+  const space = useSelect('Space', WORKSHOP_SPACE_OPTIONS, 3, 'Props')
+  const weight = useSelect('Weight', WORKSHOP_FONT_WEIGHT_OPTIONS, '', 'Props') || undefined
+
+  const [value, setValue] = useState('')
+
+  const handleChange = useCallback(
+    (event: React.ChangeEvent<HTMLInputElement>) => setValue(event.currentTarget.value),
+    [],
+  )
+
+  return (
+    <TextInput
+      border={border}
+      customValidity={customValidity}
+      disabled={disabled}
+      fontSize={fontSize}
+      icon={icon && icons[icon]}
+      iconRight={iconRight && icons[iconRight]}
+      id="text-input-example"
+      name="email"
+      onChange={handleChange}
+      padding={padding}
+      placeholder={placeholder}
+      radius={radius}
+      readOnly={readOnly}
+      ref={ref}
+      space={space}
+      value={value}
+      weight={weight}
+    />
+  )
+}

package/src/core/primitives/textInput/__workshop__/states.tsx

@@ -0,0 +1,45 @@
+import {Container, Flex, Stack, Text, TextInput} from '@sanity/ui'
+import {useAction} from '@sanity/ui-workshop'
+
+export default function StatesStory() {
+  const onChange = useAction('onChange')
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Container width={1}>
+        <Stack space={5}>
+          <Stack space={3}>
+            <Text size={1} weight="medium">
+              <label htmlFor="enabled-example">Enabled (default)</label>
+            </Text>
+            <TextInput id="enabled-example" onChange={onChange} value="This is some text" />
+          </Stack>
+
+          <Stack space={3}>
+            <Text size={1} weight="medium">
+              <label htmlFor="disabled-example">Disabled</label>
+            </Text>
+            <TextInput
+              disabled
+              id="disabled-example"
+              onChange={onChange}
+              value="This is some text"
+            />
+          </Stack>
+
+          <Stack space={3}>
+            <Text size={1} weight="medium">
+              <label htmlFor="read-only-example">Read-only</label>
+            </Text>
+            <TextInput
+              id="read-only-example"
+              readOnly
+              onChange={onChange}
+              value="This is some text"
+            />
+          </Stack>
+        </Stack>
+      </Container>
+    </Flex>
+  )
+}