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

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

@@ -0,0 +1,382 @@
+import {CloseIcon} from '@sanity/icons'
+import {ThemeFontWeightKey} from '@sanity/ui/theme'
+import {createElement, forwardRef, isValidElement, useCallback, useMemo} from 'react'
+import {isValidElementType} from 'react-is'
+import styled from 'styled-components'
+import {EMPTY_RECORD} from '../../constants'
+import {useArrayProp, useForwardedRef, useCustomValidity} from '../../hooks'
+import {
+  responsiveRadiusStyle,
+  ResponsiveRadiusStyleProps,
+  responsiveInputPaddingStyle,
+  TextInputInputStyleProps,
+  TextInputRepresentationStyleProps,
+  TextInputResponsivePaddingStyleProps,
+  textInputBaseStyle,
+  textInputFontSizeStyle,
+  textInputRepresentationStyle,
+  textInputRootStyle,
+} from '../../styles/internal'
+import {useRootTheme} from '../../theme'
+import {Radius} from '../../types'
+import {Box} from '../box'
+import {Button, ButtonProps} from '../button'
+import {Card} from '../card'
+import {Text} from '../text'
+
+/**
+ * @public
+ */
+export type TextInputClearButtonProps = Omit<ButtonProps, 'as'> &
+  Omit<React.HTMLProps<HTMLButtonElement>, 'as' | 'onClick' | 'onMouseDown' | 'ref'>
+
+/**
+ * @public
+ */
+export type TextInputType =
+  | 'date'
+  | 'datetime-local'
+  | 'email'
+  | 'url'
+  | 'month'
+  | 'number'
+  | 'password'
+  | 'tel'
+  | 'time'
+  | 'text'
+  | 'week'
+  | 'color'
+
+/**
+ * @public
+ */
+export interface TextInputProps {
+  /**
+   * @beta
+   */
+  __unstable_disableFocusRing?: boolean
+  border?: boolean
+  /**
+   * @beta
+   */
+  clearButton?: boolean | TextInputClearButtonProps
+  customValidity?: string
+  fontSize?: number | number[]
+  icon?: React.ElementType | React.ReactNode
+  iconRight?: React.ElementType | React.ReactNode
+  /**
+   * @beta
+   */
+  onClear?: () => void
+  padding?: number | number[]
+  prefix?: React.ReactNode
+  radius?: Radius | Radius[]
+  space?: number | number[]
+  suffix?: React.ReactNode
+  type?: TextInputType
+  weight?: ThemeFontWeightKey
+}
+
+const CLEAR_BUTTON_BOX_STYLE: React.CSSProperties = {zIndex: 2}
+
+const Root = styled(Card).attrs({forwardedAs: 'span'})(textInputRootStyle)
+
+const InputRoot = styled.span`
+  flex: 1;
+  min-width: 0;
+  display: block;
+  position: relative;
+`
+
+const Prefix = styled(Card).attrs({forwardedAs: 'span'})`
+  border-top-right-radius: 0;
+  border-bottom-right-radius: 0;
+
+  & > span {
+    display: block;
+    margin: -1px;
+  }
+`
+
+const Suffix = styled(Card).attrs({forwardedAs: 'span'})`
+  border-top-left-radius: 0;
+  border-bottom-left-radius: 0;
+
+  & > span {
+    display: block;
+    margin: -1px;
+  }
+`
+
+const Input = styled.input<TextInputResponsivePaddingStyleProps & TextInputInputStyleProps>(
+  responsiveInputPaddingStyle,
+  textInputBaseStyle,
+  textInputFontSizeStyle,
+)
+
+const Presentation = styled.span<ResponsiveRadiusStyleProps & TextInputRepresentationStyleProps>(
+  responsiveRadiusStyle,
+  textInputRepresentationStyle,
+)
+
+const LeftBox = styled(Box)`
+  position: absolute;
+  top: 0;
+  left: 0;
+`
+
+const RightBox = styled(Box)`
+  position: absolute;
+  top: 0;
+  right: 0;
+`
+
+const RightCard = styled(Card)`
+  background-color: transparent;
+  position: absolute;
+  top: 0;
+  right: 0;
+`
+
+const TextInputClearButton = styled(Button)({
+  '&:not([hidden])': {
+    display: 'block',
+  },
+})
+
+/**
+ * Single line text input.
+ *
+ * @public
+ */
+export const TextInput = forwardRef(function TextInput(
+  props: TextInputProps & Omit<React.HTMLProps<HTMLInputElement>, 'as' | 'prefix' | 'type'>,
+  forwardedRef: React.Ref<HTMLInputElement>,
+) {
+  const {
+    __unstable_disableFocusRing,
+    border = true,
+    clearButton,
+    disabled = false,
+    fontSize: fontSizeProp = 2,
+    icon,
+    iconRight,
+    onClear,
+    padding: paddingProp = 3,
+    prefix,
+    radius: radiusProp = 2,
+    readOnly,
+    space: spaceProp = 3,
+    suffix,
+    customValidity,
+    type = 'text',
+    weight,
+    ...restProps
+  } = props
+
+  const ref = useForwardedRef(forwardedRef)
+
+  const rootTheme = useRootTheme()
+
+  const fontSize = useArrayProp(fontSizeProp)
+  const padding = useArrayProp(paddingProp)
+  const radius = useArrayProp(radiusProp)
+  const space = useArrayProp(spaceProp)
+
+  // Transient properties
+  const $hasClearButton = Boolean(clearButton)
+  const $hasIcon = Boolean(icon)
+  const $hasIconRight = Boolean(iconRight)
+  const $hasSuffix = Boolean(suffix)
+  const $hasPrefix = Boolean(prefix)
+
+  useCustomValidity(ref, customValidity)
+
+  // Prevent the clear button from taking the focus away from the input
+  const handleClearMouseDown = useCallback((event: React.MouseEvent<HTMLButtonElement>) => {
+    event.preventDefault()
+    event.stopPropagation()
+  }, [])
+
+  const handleClearClick = useCallback(
+    (event: React.MouseEvent<HTMLButtonElement>) => {
+      event.preventDefault()
+      event.stopPropagation()
+
+      if (onClear) onClear()
+
+      // Focus the input, in case focus has been lost when clicking the clear button
+      ref.current?.focus()
+    },
+    [onClear, ref],
+  )
+
+  // Render prefix (memoized)
+  const prefixNode = useMemo(
+    () =>
+      prefix && (
+        <Prefix borderTop borderLeft borderBottom radius={radius} sizing="border" tone="inherit">
+          <span>{prefix}</span>
+        </Prefix>
+      ),
+    [prefix, radius],
+  )
+
+  // Render presentation (memoized)
+  const presentationNode = useMemo(
+    () => (
+      <Presentation
+        $hasPrefix={$hasPrefix}
+        $unstableDisableFocusRing={__unstable_disableFocusRing}
+        $hasSuffix={$hasSuffix}
+        $radius={radius}
+        $scheme={rootTheme.scheme}
+        $tone={rootTheme.tone}
+        data-border={border ? '' : undefined}
+        data-scheme={rootTheme.scheme}
+        data-tone={rootTheme.tone}
+      >
+        {icon && (
+          <LeftBox padding={padding}>
+            <Text size={fontSize}>
+              {isValidElement(icon) && icon}
+              {isValidElementType(icon) && createElement(icon)}
+            </Text>
+          </LeftBox>
+        )}
+
+        {!$hasClearButton && iconRight && (
+          <RightBox padding={padding}>
+            <Text size={fontSize}>
+              {isValidElement(iconRight) && iconRight}
+              {isValidElementType(iconRight) && createElement(iconRight)}
+            </Text>
+          </RightBox>
+        )}
+      </Presentation>
+    ),
+    [
+      __unstable_disableFocusRing,
+      border,
+      fontSize,
+      icon,
+      iconRight,
+      padding,
+      radius,
+      rootTheme,
+      $hasClearButton,
+      $hasPrefix,
+      $hasSuffix,
+    ],
+  )
+
+  // Render clear button (memoized)
+  const clearButtonBoxPadding = useMemo(
+    () =>
+      padding.map((v) => {
+        if (v === 0) return 0
+        if (v === 1) return 1
+        if (v === 2) return 1
+
+        return v - 2
+      }),
+    [padding],
+  )
+  const clearButtonPadding = useMemo(
+    () =>
+      padding.map((v) => {
+        if (v === 0) return 0
+        if (v === 1) return 0
+        if (v === 2) return 1
+
+        return v - 1
+      }),
+    [padding],
+  )
+  const clearButtonProps: TextInputClearButtonProps = useMemo(
+    () => (typeof clearButton === 'object' ? clearButton : EMPTY_RECORD),
+    [clearButton],
+  )
+  const clearButtonNode = useMemo(
+    () =>
+      !disabled &&
+      !readOnly &&
+      clearButton && (
+        <RightCard
+          forwardedAs="span"
+          padding={clearButtonBoxPadding}
+          style={CLEAR_BUTTON_BOX_STYLE}
+          tone={customValidity ? 'critical' : 'inherit'}
+        >
+          <TextInputClearButton
+            aria-label="Clear"
+            data-qa="clear-button"
+            fontSize={fontSize}
+            icon={CloseIcon}
+            mode="bleed"
+            padding={clearButtonPadding}
+            radius={radius}
+            {...clearButtonProps}
+            onClick={handleClearClick}
+            onMouseDown={handleClearMouseDown}
+          />
+        </RightCard>
+      ),
+    [
+      clearButton,
+      clearButtonBoxPadding,
+      clearButtonPadding,
+      clearButtonProps,
+      customValidity,
+      disabled,
+      fontSize,
+      handleClearClick,
+      handleClearMouseDown,
+      radius,
+      readOnly,
+    ],
+  )
+
+  // Render suffix (memoized)
+  const suffixNode = useMemo(
+    () =>
+      suffix && (
+        <Suffix borderTop borderRight borderBottom radius={radius} sizing="border" tone="inherit">
+          <span>{suffix}</span>
+        </Suffix>
+      ),
+    [radius, suffix],
+  )
+
+  return (
+    <Root data-ui="TextInput" tone={rootTheme.tone}>
+      {prefixNode}
+
+      <InputRoot>
+        <Input
+          data-as="input"
+          data-scheme={rootTheme.scheme}
+          data-tone={rootTheme.tone}
+          {...restProps}
+          $fontSize={fontSize}
+          $iconLeft={$hasIcon}
+          $iconRight={$hasIconRight || $hasClearButton}
+          $padding={padding}
+          $scheme={rootTheme.scheme}
+          $space={space}
+          $tone={rootTheme.tone}
+          $weight={weight}
+          disabled={disabled}
+          readOnly={readOnly}
+          ref={ref}
+          type={type}
+        />
+
+        {presentationNode}
+        {clearButtonNode}
+      </InputRoot>
+
+      {suffixNode}
+    </Root>
+  )
+})

package/src/core/primitives/tooltip/__workshop__/customPortal.tsx

@@ -0,0 +1,99 @@
+import {
+  BoundaryElementProvider,
+  Button,
+  Card,
+  Flex,
+  Portal,
+  PortalProvider,
+  Stack,
+  Text,
+  Tooltip,
+} from '@sanity/ui'
+import {useBoolean, useSelect, useText} from '@sanity/ui-workshop'
+import {useState} from 'react'
+import {WORKSHOP_PLACEMENT_OPTIONS} from '../../../__workshop__/constants'
+
+const PORTAL_OPTIONS = {
+  '(true)': true,
+  '(false)': false,
+  portal1: 'portal1',
+}
+
+export default function CustomPortalStory() {
+  const content = useText(
+    'Content',
+    'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut mollis consectetur malesuada. Sed lobortis est dolor, eget imperdiet velit placerat et. Aenean posuere mi non aliquet iaculis. Donec fermentum pulvinar purus at sagittis. Ut tincidunt massa odio, sed finibus justo ullamcorper id. Nam venenatis justo non ligula elementum cursus. Pellentesque laoreet justo in mollis sagittis. In lacinia ornare ultrices. Suspendisse potenti.',
+  )
+  const placement = useSelect('Placement', WORKSHOP_PLACEMENT_OPTIONS, 'top')
+  const portal = useSelect('Portal', PORTAL_OPTIONS, undefined, 'Props')
+  const useBoundaryElement = useBoolean('Use boundary element', true)
+
+  const [portal1Element, setPortal1Element] = useState<HTMLDivElement | null>(null)
+  const [boundaryElement, setBoundaryElement] = useState<HTMLDivElement | null>(null)
+
+  return (
+    <PortalProvider
+      __unstable_elements={{
+        portal1: portal1Element,
+      }}
+    >
+      <Flex align="center" height="fill" justify="center">
+        <BoundaryElementProvider element={useBoundaryElement ? boundaryElement : null}>
+          <Card
+            border
+            padding={4}
+            ref={setBoundaryElement}
+            style={{
+              height: 'calc(100vh - 100px)',
+              position: 'relative',
+              width: '500px',
+            }}
+          >
+            <Text>Boundary element</Text>
+            <Flex align="center" height="fill" justify="center">
+              <Flex justify="center">
+                <Stack space={2}>
+                  <Tooltip
+                    boundaryElement={useBoundaryElement ? boundaryElement : null}
+                    content={<Text size={1}>{content}</Text>}
+                    padding={2}
+                    placement={placement}
+                    portal={portal}
+                  >
+                    <Button mode="bleed" text="Tooltip" />
+                  </Tooltip>
+                </Stack>
+              </Flex>
+            </Flex>
+          </Card>
+        </BoundaryElementProvider>
+      </Flex>
+
+      <Card
+        border
+        margin={4}
+        padding={4}
+        ref={setPortal1Element}
+        style={{
+          left: 0,
+          position: 'absolute',
+          top: 0,
+          width: '175px',
+        }}
+        tone="critical"
+      />
+
+      <Portal __unstable_name="portal1">
+        <Stack space={4}>
+          <Text size={1} weight="medium">
+            Portal 1 content
+          </Text>
+          <Text size={1}>
+            The tooltip's max-width should not exceed this container's width (minus padding) if it's
+            set to use this portal
+          </Text>
+        </Stack>
+      </Portal>
+    </PortalProvider>
+  )
+}

package/src/core/primitives/tooltip/__workshop__/index.ts

@@ -0,0 +1,29 @@
+import {defineScope} from '@sanity/ui-workshop'
+import {lazy} from 'react'
+
+export default defineScope({
+  name: 'primitives/tooltip',
+  title: 'Tooltip',
+  stories: [
+    {
+      name: 'props',
+      title: 'Props',
+      component: lazy(() => import('./props')),
+    },
+    {
+      name: 'resizableBoundary',
+      title: 'Resizable Boundary',
+      component: lazy(() => import('./resizableBoundary')),
+    },
+    {
+      name: 'overflowBoundary',
+      title: 'Overflowing Boundary',
+      component: lazy(() => import('./overflowingBoundary')),
+    },
+    {
+      name: 'customPortalStory',
+      title: 'Custom Portal',
+      component: lazy(() => import('./customPortal')),
+    },
+  ],
+})

package/src/core/primitives/tooltip/__workshop__/overflowingBoundary.tsx

@@ -0,0 +1,73 @@
+import {BoundaryElementProvider, Button, Card, Code, Flex, Stack, Text, Tooltip} from '@sanity/ui'
+import {useBoolean, useSelect, useText} from '@sanity/ui-workshop'
+import {useCallback, useState} from 'react'
+import {WORKSHOP_PLACEMENT_OPTIONS} from '../../../__workshop__/constants'
+
+export default function OverflowingBoundaryStory() {
+  const content = useText(
+    'Content',
+    'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut mollis consectetur malesuada. Sed lobortis est dolor, eget imperdiet velit placerat et. Aenean posuere mi non aliquet iaculis. Donec fermentum pulvinar purus at sagittis. Ut tincidunt massa odio, sed finibus justo ullamcorper id. Nam venenatis justo non ligula elementum cursus. Pellentesque laoreet justo in mollis sagittis. In lacinia ornare ultrices. Suspendisse potenti.',
+  )
+  const placement = useSelect('Placement', WORKSHOP_PLACEMENT_OPTIONS, 'top')
+  const portal = useBoolean('Portal', false)
+  const useBoundaryElement = useBoolean('Use boundary element', true)
+
+  const [boundaryElement, setBoundaryElement] = useState<HTMLDivElement | null>(null)
+  const [buttonsVisible, setButtonsVisible] = useState(true)
+
+  const handleHideButtons = useCallback(() => {
+    setButtonsVisible(false)
+  }, [])
+
+  const handleShowButtons = useCallback(() => {
+    setButtonsVisible(true)
+  }, [])
+
+  return (
+    <Flex align="center" height="fill" justify="center" style={{height: '200vh'}}>
+      <BoundaryElementProvider element={useBoundaryElement ? boundaryElement : null}>
+        <Card
+          border
+          ref={setBoundaryElement}
+          style={{
+            height: 'calc(100vh - 100px)',
+            overflow: 'hidden',
+            position: 'relative',
+            resize: 'both',
+            width: '500px',
+          }}
+        >
+          <Flex align="center" height="fill" justify="center">
+            <Flex justify="center">
+              <Stack space={2}>
+                <Code size={1}>Placement: {placement}</Code>
+                <Button
+                  disabled={buttonsVisible}
+                  fontSize={1}
+                  onClick={handleShowButtons}
+                  text="Show buttons"
+                />
+              </Stack>
+            </Flex>
+          </Flex>
+
+          {buttonsVisible && (
+            <Tooltip
+              content={<Text size={1}>{content}</Text>}
+              padding={2}
+              placement={placement}
+              portal={portal}
+            >
+              <Button
+                mode="bleed"
+                onClick={handleHideButtons}
+                style={{position: 'absolute', top: 10, right: 10}}
+                text="Tooltip"
+              />
+            </Tooltip>
+          )}
+        </Card>
+      </BoundaryElementProvider>
+    </Flex>
+  )
+}

package/src/core/primitives/tooltip/__workshop__/props.tsx

@@ -0,0 +1,106 @@
+import {Button, Card, Flex, Text, Tooltip, TooltipDelayGroupProvider, Stack} from '@sanity/ui'
+import {useBoolean, useSelect, useText, useNumber} from '@sanity/ui-workshop'
+import {
+  WORKSHOP_PLACEMENT_OPTIONS,
+  WORKSHOP_SHADOW_OPTIONS,
+  WORKSHOP_SPACE_OPTIONS,
+} from '../../../__workshop__/constants'
+
+export default function PropsStory() {
+  const content = useText('Content', 'Tooltip content')
+  const padding = useSelect('Padding', WORKSHOP_SPACE_OPTIONS, 2, 'Props')
+  const placement = useSelect('Placement', WORKSHOP_PLACEMENT_OPTIONS, 'top')
+  const portal = useBoolean('Portal', true)
+  const openDelay = useNumber('Open Delay', 200) || 0
+  const closeDelay = useNumber('Close Delay', 200) || 0
+  const shadow = useSelect('Shadow', WORKSHOP_SHADOW_OPTIONS, 2)
+
+  return (
+    <Card height="fill">
+      <Flex
+        height="fill"
+        align="center"
+        justify="center"
+        padding={8}
+        sizing="border"
+        direction="column"
+        gap={4}
+      >
+        <Stack
+          padding={4}
+          style={{outline: '1px solid var(--card-border-color)', width: '100%', maxWidth: '640px'}}
+          space={4}
+        >
+          <Text align="center" size={3}>
+            Standalone tooltip
+          </Text>
+          <Flex align="center" justify="center" padding={4} sizing="border">
+            <Tooltip
+              content={<Text size={1}>{content}</Text>}
+              padding={padding}
+              placement={placement}
+              portal={portal}
+              shadow={shadow}
+              delay={{
+                open: openDelay,
+                close: closeDelay,
+              }}
+            >
+              <Button mode="bleed" text="Hover me" />
+            </Tooltip>
+          </Flex>
+        </Stack>
+        <Stack
+          padding={4}
+          style={{outline: '1px solid var(--card-border-color)', width: '100%', maxWidth: '640px'}}
+          space={4}
+        >
+          <Text align="center" size={3}>
+            Grouped tooltips
+          </Text>
+          <Text align="center" size={1}>
+            All tooltip delays are set to 1ms after the first tooltip within a DelayGroupProvider
+            opens.
+          </Text>
+          <Flex align="center" justify="center" padding={4} sizing="border" gap={4}>
+            <TooltipDelayGroupProvider
+              delay={{
+                open: openDelay,
+                close: closeDelay,
+              }}
+            >
+              <Tooltip
+                // This is overridden by the group delay, kept here intentionally for testing purposes.
+                delay={{
+                  open: 100,
+                  close: 100,
+                }}
+                content={<Text size={1}>{content}</Text>}
+                padding={padding}
+                placement={placement}
+                portal={portal}
+                shadow={shadow}
+              >
+                <Button mode="bleed" text="Hover me" />
+              </Tooltip>
+              <Tooltip
+                // This is overridden by the group delay, kept here intentionally for testing purposes.
+                delay={{
+                  open: 100,
+                  close: 100,
+                }}
+                content={<Text size={1}>{content}</Text>}
+                padding={padding}
+                placement={placement}
+                portal={portal}
+                shadow={shadow}
+              >
+                <Button mode="bleed" text="Or me" />
+              </Tooltip>
+            </TooltipDelayGroupProvider>
+          </Flex>
+        </Stack>
+      </Flex>
+    </Card>
+  )
+}