@sanity/ui 3.0.0-static.9 → 3.0.0

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

@@ -0,0 +1,107 @@
+import {Button, Card, Flex, Stack, Text, Tooltip, TooltipDelayGroupProvider} from '@sanity/ui'
+import {useBoolean, useNumber, useSelect, useText} 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>
+  )
+}

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

@@ -0,0 +1,86 @@
+import {BoundaryElementProvider, Button, Card, Code, Flex, Text, Tooltip} from '@sanity/ui'
+import {useBoolean, useSelect, useText} from '@sanity/ui-workshop'
+import {useState} from 'react'
+
+import {WORKSHOP_PLACEMENT_OPTIONS} from '../../../__workshop__/constants'
+
+export default function ResizableBoundaryStory() {
+  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, 'right')
+  const portal = useBoolean('Portal', true)
+  const useBoundaryElement = useBoolean('Use boundary element', true)
+
+  const [boundaryElement, setBoundaryElement] = useState<HTMLDivElement | null>(null)
+
+  return (
+    <Flex align="center" height="fill" justify="center">
+      <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">
+              <Code size={1}>Placement: {placement}</Code>
+            </Flex>
+          </Flex>
+
+          <Tooltip
+            content={<Text size={1}>{content}</Text>}
+            padding={2}
+            placement={placement}
+            portal={portal}
+          >
+            <Button mode="bleed" style={{position: 'absolute', top: 10, left: 10}} text="Tooltip" />
+          </Tooltip>
+          <Tooltip
+            content={<Text size={1}>{content}</Text>}
+            padding={2}
+            placement={placement}
+            portal={portal}
+          >
+            <Button
+              mode="bleed"
+              style={{position: 'absolute', top: 10, right: 10}}
+              text="Tooltip"
+            />
+          </Tooltip>
+          <Tooltip
+            content={<Text size={1}>{content}</Text>}
+            padding={2}
+            placement={placement}
+            portal={portal}
+          >
+            <Button
+              mode="bleed"
+              style={{position: 'absolute', bottom: 10, left: 10}}
+              text="Tooltip"
+            />
+          </Tooltip>
+          <Tooltip
+            content={<Text size={1}>{content}</Text>}
+            padding={2}
+            placement={placement}
+            portal={portal}
+          >
+            <Button
+              mode="bleed"
+              style={{position: 'absolute', bottom: 10, right: 10}}
+              text="Tooltip"
+            />
+          </Tooltip>
+        </Card>
+      </BoundaryElementProvider>
+    </Flex>
+  )
+}

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

@@ -0,0 +1,452 @@
+/** @jest-environment jsdom */
+import '../../../../test/mocks/resizeObserver.mock'
+import '../../../../test/mocks/matchMedia.mock'
+
+import {act, fireEvent, screen} from '@testing-library/react'
+
+import {render} from '../../../../test'
+import {Button, Text} from '../../primitives'
+import {Tooltip, TooltipDelayGroupProvider} from '../tooltip'
+
+// Fake timers using Jest
+beforeEach(() => {
+  jest.useFakeTimers()
+})
+
+// Running all pending timers and switching to real timers using Jest
+afterEach(() => {
+  jest.runOnlyPendingTimers()
+  jest.useRealTimers()
+})
+
+describe('Tooltip', () => {
+  describe('Using same delay for open and close', () => {
+    it('should hide and show the tooltip content when hovered, with no delay', () => {
+      render(
+        <Tooltip content={<Text size={1}>{'Tooltip content'}</Text>} placement={'top'}>
+          <Button mode="bleed" text="Hover me" />
+        </Tooltip>,
+      )
+
+      const button = screen.getByText('Hover me')
+
+      // Validate tooltip content is not rendered
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+
+      fireEvent.mouseEnter(button)
+
+      // Validate tooltip content is rendered
+      screen.getByText('Tooltip content')
+
+      fireEvent.mouseOut(button)
+      // Validate tooltip content is not rendered anymore
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+    })
+    it('should support delays to show and hide the tooltip.', () => {
+      jest.useFakeTimers()
+      const delay = 200
+
+      render(
+        <Tooltip
+          content={<Text size={1}>{'Tooltip content'}</Text>}
+          placement={'top'}
+          delay={delay}
+        >
+          <Button mode="bleed" text="Hover me" />
+        </Tooltip>,
+      )
+
+      const button = screen.getByText('Hover me')
+
+      // Validate tooltip content is not rendered
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+
+      fireEvent.mouseEnter(button)
+
+      act(() => jest.advanceTimersByTime(delay / 2))
+      // Content should not be rendered yet
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+      act(() => jest.advanceTimersByTime(delay / 2))
+
+      // Validate tooltip content is rendered
+      screen.getByText('Tooltip content')
+
+      fireEvent.mouseOut(button)
+      // Validate tooltip content is still showing.
+      screen.getByText('Tooltip content')
+      act(() => jest.advanceTimersByTime(delay))
+      // Validate tooltip content is not rendered anymore
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+    })
+    it('should support different open and close delays to show and hide the tooltip.', () => {
+      jest.useFakeTimers()
+      const openDelay = 200
+      const closeDelay = 150
+
+      render(
+        <Tooltip
+          content={<Text size={1}>{'Tooltip content'}</Text>}
+          placement={'top'}
+          delay={{
+            open: openDelay,
+            close: closeDelay,
+          }}
+        >
+          <Button mode="bleed" text="Hover me" />
+        </Tooltip>,
+      )
+
+      const button = screen.getByText('Hover me')
+
+      // Validate tooltip content is not rendered
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+
+      fireEvent.mouseEnter(button)
+
+      act(() => jest.advanceTimersByTime(openDelay / 2))
+      // Content should not be rendered yet
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+      act(() => jest.advanceTimersByTime(openDelay / 2))
+
+      // Validate tooltip content is rendered
+      screen.getByText('Tooltip content')
+
+      fireEvent.mouseOut(button)
+      // Validate tooltip content is still showing.
+      screen.getByText('Tooltip content')
+      act(() => jest.advanceTimersByTime(closeDelay))
+      // Validate tooltip content is not rendered anymore
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+    })
+  })
+
+  describe('Using the <TooltipDelayGroupProvider />', () => {
+    it('should support groups with the same delay to open and close.', () => {
+      const delay = 150
+
+      jest.useFakeTimers()
+      render(
+        <TooltipDelayGroupProvider delay={delay}>
+          <Tooltip content={<Text size={1}>{'Tooltip 1'}</Text>} placement={'top'} delay={400}>
+            <Button mode="bleed" text="Button 1" />
+          </Tooltip>
+          <Tooltip
+            content={<Text size={1}>{'Tooltip 2'}</Text>}
+            placement={'top'}
+            delay={400} // This should be overridden by the group delay
+          >
+            <Button mode="bleed" text="Button 2" />
+          </Tooltip>
+        </TooltipDelayGroupProvider>,
+      )
+
+      const button1 = screen.getByText('Button 1')
+      const button2 = screen.getByText('Button 2')
+
+      // Validate tooltip content is not rendered
+      expect(screen.queryByText('Tooltip 1')).not.toBeInTheDocument()
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+
+      // Hovers on first button, it should show first tooltip only
+      fireEvent.mouseEnter(button1)
+      act(() => jest.advanceTimersByTime(delay / 2))
+      // Content should not be rendered yet, we have a delay of 150ms
+      expect(screen.queryByText('Tooltip 1')).not.toBeInTheDocument()
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+      act(() => jest.advanceTimersByTime(delay / 2))
+
+      // Validate Tooltip 1 is rendered
+      screen.getByText('Tooltip 1')
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+
+      // Hovers on second button.
+      fireEvent.mouseOut(button1)
+      fireEvent.mouseEnter(button2)
+
+      // Validate Tooltip 1 is not rendered, now tooltip 2 is open.
+      act(() => jest.advanceTimersByTime(1))
+      expect(screen.queryByText('Tooltip 1')).not.toBeInTheDocument()
+      screen.getByText('Tooltip 2')
+
+      // Validate tooltip content is not rendered anymore
+      fireEvent.mouseOut(button2)
+      act(() => jest.advanceTimersByTime(delay + 1))
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+
+      // Hovering again, should trigger the tooltip to show immediately, as the group is not deactivated yet
+      fireEvent.mouseEnter(button2)
+      act(() => jest.advanceTimersByTime(1))
+      screen.getByText('Tooltip 2')
+
+      // Validate tooltip content is not rendered anymore
+      fireEvent.mouseOut(button2)
+      act(() => jest.advanceTimersByTime(delay + 1))
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+
+      // Wait 200ms, the group is deactivated, hovering again should trigger the delay
+      act(() => jest.advanceTimersByTime(200))
+      fireEvent.mouseEnter(button2)
+      act(() => jest.advanceTimersByTime(delay / 2))
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+      act(() => jest.advanceTimersByTime(delay / 2))
+      screen.getByText('Tooltip 2')
+    })
+    it('should support groups with different open and close delay.', () => {
+      const openDelay = 250
+      const closeDelay = 150
+
+      jest.useFakeTimers()
+      render(
+        <TooltipDelayGroupProvider
+          delay={{
+            open: openDelay,
+            close: closeDelay,
+          }}
+        >
+          <Tooltip content={<Text size={1}>{'Tooltip 1'}</Text>} placement={'top'} delay={400}>
+            <Button mode="bleed" text="Button 1" />
+          </Tooltip>
+          <Tooltip
+            content={<Text size={1}>{'Tooltip 2'}</Text>}
+            placement={'top'}
+            delay={400} // This should be overridden by the group delay
+          >
+            <Button mode="bleed" text="Button 2" />
+          </Tooltip>
+        </TooltipDelayGroupProvider>,
+      )
+
+      const button1 = screen.getByText('Button 1')
+      const button2 = screen.getByText('Button 2')
+
+      // Validate tooltip content is not rendered
+      expect(screen.queryByText('Tooltip 1')).not.toBeInTheDocument()
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+
+      // Hovers on first button, it should show first tooltip only
+      fireEvent.mouseEnter(button1)
+      act(() => jest.advanceTimersByTime(openDelay / 2))
+      // Content should not be rendered yet, we have a delay of2150ms
+      expect(screen.queryByText('Tooltip 1')).not.toBeInTheDocument()
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+      act(() => jest.advanceTimersByTime(openDelay / 2))
+
+      // Validate Tooltip 1 is rendered
+      screen.getByText('Tooltip 1')
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+
+      // Hovers on second button.
+      fireEvent.mouseOut(button1)
+      fireEvent.mouseEnter(button2)
+
+      // Validate Tooltip 1 is not rendered, now tooltip 2 is open.
+      act(() => jest.advanceTimersByTime(1))
+      expect(screen.queryByText('Tooltip 1')).not.toBeInTheDocument()
+      screen.getByText('Tooltip 2')
+
+      // Validate tooltip content is not rendered anymore
+      fireEvent.mouseOut(button2)
+      act(() => jest.advanceTimersByTime(closeDelay + 1))
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+
+      // Hovering again, should trigger the tooltip to show immediately, as the group is not deactivated yet
+      fireEvent.mouseEnter(button2)
+      act(() => jest.advanceTimersByTime(1))
+      screen.getByText('Tooltip 2')
+
+      // Validate tooltip content is not rendered anymore
+      fireEvent.mouseOut(button2)
+      act(() => jest.advanceTimersByTime(closeDelay + 1))
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+
+      // Wait 200ms, the group is deactivated, hovering again should trigger the delay
+      act(() => jest.advanceTimersByTime(200))
+      fireEvent.mouseEnter(button2)
+      act(() => jest.advanceTimersByTime(openDelay / 2))
+      expect(screen.queryByText('Tooltip 2')).not.toBeInTheDocument()
+      act(() => jest.advanceTimersByTime(openDelay / 2))
+      screen.getByText('Tooltip 2')
+    })
+  })
+
+  describe('Closing the <Tooltip /> with the Escape key', () => {
+    it('Standalone tooltip closes immediately with Escape key', () => {
+      const delay = 150
+
+      jest.useFakeTimers()
+
+      render(
+        <Tooltip
+          content={<Text size={1}>{'Tooltip content'}</Text>}
+          placement={'top'}
+          delay={delay}
+        >
+          <Button mode="bleed" text="Hover me" />
+        </Tooltip>,
+      )
+
+      const button = screen.getByText('Hover me')
+
+      // Validate tooltip content is not rendered
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+      fireEvent.focus(button)
+      act(() => jest.advanceTimersByTime(delay))
+
+      // Validate tooltip content is rendered
+      screen.getByText('Tooltip content')
+
+      act(() => {
+        fireEvent.keyDown(button, {key: 'Escape', code: 'Escape'})
+      })
+      // Validate tooltip content is not rendered anymore
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+    })
+    it('With <TooltipDelayGroupProvider />  closes immediately with Escape key', () => {
+      const delay = 150
+
+      jest.useFakeTimers()
+
+      render(
+        <TooltipDelayGroupProvider delay={{close: delay}}>
+          <Tooltip
+            content={<Text size={1}>{'Tooltip content'}</Text>}
+            placement={'top'}
+            delay={{close: delay}}
+          >
+            <Button mode="bleed" text="Hover me" />
+          </Tooltip>
+        </TooltipDelayGroupProvider>,
+      )
+
+      const button = screen.getByText('Hover me')
+
+      // Validate tooltip content is not rendered
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+      fireEvent.focus(button)
+
+      act(() => jest.advanceTimersByTime(delay))
+
+      // Validate tooltip content is rendered
+      screen.getByText('Tooltip content')
+
+      act(() => {
+        fireEvent.keyDown(button, {key: 'Escape', code: 'Escape'})
+      })
+      // Validate tooltip content is not rendered anymore
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+    })
+  })
+
+  describe('Clicking the <Tooltip /> child should close the tooltip', () => {
+    it('Should close the tooltip when clicked', () => {
+      const delay = 150
+
+      render(
+        <Tooltip content={<Text size={1}>{'Tooltip content'}</Text>} delay={delay}>
+          <Button mode="bleed" text="Hover me" />
+        </Tooltip>,
+      )
+
+      const button = screen.getByText('Hover me')
+
+      // Assertion: tooltip does not exist in the document
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+      fireEvent.focus(button)
+
+      act(() => jest.advanceTimersByTime(delay))
+
+      // Assertion: the tooltip is not visible
+      expect(screen.queryByText('Tooltip content')).toBeVisible()
+
+      act(() => fireEvent.click(button))
+
+      // Assertion: tooltip does not exist in the document
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+    })
+
+    it('Should close the tooltip when the context menu is opened (right click)', () => {
+      const delay = 150
+
+      render(
+        <Tooltip content={<Text size={1}>{'Tooltip content'}</Text>} delay={delay}>
+          <Button mode="bleed" text="Hover me" />
+        </Tooltip>,
+      )
+
+      const button = screen.getByText('Hover me')
+
+      // Assertion: tooltip does not exist in the document
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+      fireEvent.focus(button)
+
+      act(() => jest.advanceTimersByTime(delay))
+
+      // Assertion: the tooltip is not visible
+      expect(screen.queryByText('Tooltip content')).toBeVisible()
+
+      act(() => fireEvent.contextMenu(button))
+
+      // Assertion: tooltip does not exist in the document
+      expect(screen.queryByText('Tooltip content')).not.toBeInTheDocument()
+    })
+  })
+
+  describe('Used defined events on <Tooltip /> child should fire correctly', () => {
+    const handleBlur = jest.fn()
+    const handleClick = jest.fn()
+    const handleContextMenu = jest.fn()
+    const handleFocus = jest.fn()
+    const handleMouseEnter = jest.fn()
+    const handleMouseLeave = jest.fn()
+
+    beforeEach(() => {
+      render(
+        <Tooltip content={<Text size={1}>{'Tooltip content'}</Text>}>
+          <Button
+            data-testid="btn"
+            mode="bleed"
+            onBlur={handleBlur}
+            onClick={handleClick}
+            onContextMenu={handleContextMenu}
+            onFocus={handleFocus}
+            onMouseEnter={handleMouseEnter}
+            onMouseLeave={handleMouseLeave}
+            text="Hover me"
+          />
+        </Tooltip>,
+      )
+    })
+
+    afterEach(() => jest.clearAllMocks())
+
+    it('should fire the onBlur event', () => {
+      fireEvent.blur(screen.getByTestId('btn'))
+      expect(handleBlur).toHaveBeenCalledTimes(1)
+    })
+
+    it('should fire the onClick event', () => {
+      fireEvent.click(screen.getByTestId('btn'))
+      expect(handleClick).toHaveBeenCalledTimes(1)
+    })
+
+    it('should fire the onContextMenu event', () => {
+      fireEvent.contextMenu(screen.getByTestId('btn'))
+      expect(handleContextMenu).toHaveBeenCalledTimes(1)
+    })
+
+    it('should fire the onFocus event', () => {
+      fireEvent.focus(screen.getByTestId('btn'))
+      expect(handleFocus).toHaveBeenCalledTimes(1)
+    })
+
+    it('should fire the onMouseEnter event', () => {
+      fireEvent.mouseEnter(screen.getByTestId('btn'))
+      expect(handleMouseEnter).toHaveBeenCalledTimes(1)
+    })
+
+    it('should fire the onMouseLeave event', () => {
+      fireEvent.mouseLeave(screen.getByTestId('btn'))
+      expect(handleMouseLeave).toHaveBeenCalledTimes(1)
+    })
+  })
+})