@sanity/ui 1.0.0-beta.9 → 1.0.0

package/src/primitives/popover/__workshop__/AlignedStory.tsx

@@ -0,0 +1,73 @@
+import {EllipsisVerticalIcon} from '@sanity/icons'
+import {Button, Card, Flex, Popover, Text, useClickOutside} from '@sanity/ui'
+import {useBoolean, useSelect} from '@sanity/ui-workshop'
+import {useCallback, useState} from 'react'
+import {
+  WORKSHOP_FLEX_ALIGN_OPTIONS,
+  WORKSHOP_FLEX_JUSTIFY_OPTIONS,
+  WORKSHOP_PLACEMENT_OPTIONS,
+  WORKSHOP_WIDTH_OPTIONS,
+} from '../../../__workshop__/constants'
+
+export default function AlignedStory() {
+  const constrainSize = useBoolean('Constrain size', false)
+  const placement = useSelect('Placement', WORKSHOP_PLACEMENT_OPTIONS, 'bottom')
+  const portal = useBoolean('Portal', true)
+  const width = useSelect('Width', WORKSHOP_WIDTH_OPTIONS, 'auto')
+
+  const flexAlign = useSelect('Align', WORKSHOP_FLEX_ALIGN_OPTIONS, 'flex-start')
+  const flexJustify = useSelect('Justify', WORKSHOP_FLEX_JUSTIFY_OPTIONS, 'flex-end')
+
+  const [open, setOpen] = useState(false)
+  const [boundaryElement, setBoundaryElement] = useState<HTMLDivElement | null>(null)
+  const [buttonElement, setButtonElement] = useState<HTMLButtonElement | null>(null)
+  const [popoverElement, setPopoverElement] = useState<HTMLDivElement | null>(null)
+
+  const content = (
+    <Text>
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque at nisl at sem tempor
+      hendrerit scelerisque ut libero. Maecenas iaculis efficitur lorem, ac faucibus mi imperdiet
+      quis. Cras a consectetur erat. Fusce imperdiet, dolor et pellentesque iaculis, ex quam luctus
+      felis, non ultrices enim sem vitae quam. Duis lorem velit, lacinia at rhoncus a, tempus vel
+      neque. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae;
+      Sed id mauris quam. Nam finibus sapien non lacinia ultricies. Integer fermentum tortor at
+      pellentesque faucibus. In venenatis commodo placerat. Curabitur commodo tortor libero, vel
+      pellentesque elit luctus sodales. Donec mattis tristique nunc ac lacinia. Vestibulum non
+      pulvinar turpis, posuere consequat arcu. Fusce ut urna blandit, finibus nisi a, molestie elit.
+      Nulla sed eleifend mi.
+    </Text>
+  )
+
+  const handleToggleOpen = useCallback(() => setOpen((v) => !v), [])
+  const handleClose = useCallback(() => setOpen(false), [])
+
+  useClickOutside(handleClose, [buttonElement, popoverElement])
+
+  return (
+    <Card height="fill" padding={[4, 5, 6]} sizing="border" tone="transparent">
+      <Card height="fill" padding={2} ref={setBoundaryElement} shadow={1} sizing="border">
+        <Flex align={flexAlign} height="fill" justify={flexJustify}>
+          <Popover
+            boundaryElement={boundaryElement}
+            constrainSize={constrainSize}
+            content={content}
+            open={open}
+            padding={3}
+            portal={portal}
+            placement={placement}
+            ref={setPopoverElement}
+            width={width}
+          >
+            <Button
+              icon={EllipsisVerticalIcon}
+              mode="bleed"
+              onClick={handleToggleOpen}
+              ref={setButtonElement}
+              selected={open}
+            />
+          </Popover>
+        </Flex>
+      </Card>
+    </Card>
+  )
+}

package/src/primitives/popover/__workshop__/MarginsStory.tsx

@@ -0,0 +1,31 @@
+import {Box, Card, Container, Flex, Popover, Text} from '@sanity/ui'
+
+export default function MarginsStory() {
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Popover
+        __unstable_margins={[-8, 8, -8, 8]}
+        arrow={false}
+        content={
+          <Box padding={2}>
+            <Text align="center" muted size={1}>
+              Popover
+            </Text>
+          </Box>
+        }
+        matchReferenceWidth
+        open
+        placement="bottom-start"
+        // radius={0}
+      >
+        <Container width={0}>
+          <Card padding={2} muted shadow={1}>
+            <Text align="center" muted size={1}>
+              Reference
+            </Text>
+          </Card>
+        </Container>
+      </Popover>
+    </Flex>
+  )
+}

package/src/primitives/popover/__workshop__/MatchReferenceWidthStory.tsx

@@ -0,0 +1,31 @@
+import {Box, Button, Container, Flex, Popover, Stack, Text} from '@sanity/ui'
+import {useBoolean, useSelect} from '@sanity/ui-workshop'
+import {WORKSHOP_PLACEMENT_OPTIONS} from '../../../__workshop__/constants'
+
+export default function MatchReferenceWidthStory() {
+  const arrow = useBoolean('Arrow', true, 'Props')
+  const placement = useSelect('Placement', WORKSHOP_PLACEMENT_OPTIONS, 'bottom', 'Props')
+
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <Popover
+        arrow={arrow}
+        content={
+          <Box padding={2}>
+            <Text>Content</Text>
+          </Box>
+        }
+        matchReferenceWidth
+        open
+        placement={placement}
+        radius={2}
+      >
+        <Container width={0}>
+          <Stack>
+            <Button fontSize={3} text="Button" />
+          </Stack>
+        </Container>
+      </Popover>
+    </Flex>
+  )
+}

package/src/primitives/popover/__workshop__/PlainStory.tsx

@@ -0,0 +1,70 @@
+import {Button, Card, Popover, PortalProvider, Text} from '@sanity/ui'
+import {useBoolean, useSelect} from '@sanity/ui-workshop'
+import {useState} from 'react'
+import {
+  WORKSHOP_CONTAINER_WIDTH_OPTIONS,
+  WORKSHOP_PLACEMENT_OPTIONS,
+  WORKSHOP_RADIUS_OPTIONS,
+  WORKSHOP_SPACE_OPTIONS,
+} from '../../../__workshop__/constants'
+
+export default function PlainStory() {
+  const arrow = useBoolean('Arrow', true)
+  const boundaryElementFlag = useBoolean('Boundary element', true)
+  const constrainSize = useBoolean('Constrain size', true)
+  const matchReferenceWidth = useBoolean('Match reference width', false)
+  const open = useBoolean('Open', true)
+  const padding = useSelect('Padding', WORKSHOP_SPACE_OPTIONS, 3)
+  const placement = useSelect('Placement', WORKSHOP_PLACEMENT_OPTIONS, 'bottom')
+  const portal = useBoolean('Portal', true)
+  const preventOverflow = useBoolean('Prevent overflow', true)
+  const radius = useSelect('Radius', WORKSHOP_RADIUS_OPTIONS, 2)
+  const width = useSelect('Width', WORKSHOP_CONTAINER_WIDTH_OPTIONS, 'auto')
+  const [portalElement, setPortalElement] = useState<HTMLDivElement | null>(null)
+  const [boundaryElement, setBoundaryElement] = useState<HTMLDivElement | null>(null)
+
+  return (
+    <Card height="fill" padding={3} sizing="border">
+      <PortalProvider element={portalElement}>
+        <Text align="center" muted size={1}>
+          Scroll this box to reveal the popover
+        </Text>
+        <div
+          ref={setBoundaryElement}
+          style={{
+            height: 'calc(100vh - 120px)',
+            position: 'absolute',
+            top: 0,
+            left: 0,
+            margin: 60,
+            overflow: 'auto',
+            outline: '1px solid red',
+            width: 'calc(100vw - 120px)',
+          }}
+        >
+          <div style={{padding: '150vh 0', textAlign: 'center'}}>
+            <Popover
+              __unstable_margins={[1, 1, 1, 1]}
+              arrow={arrow}
+              boundaryElement={boundaryElementFlag ? boundaryElement : undefined}
+              constrainSize={constrainSize}
+              content={<Text>popover content</Text>}
+              fallbackPlacements={['top', 'bottom']}
+              matchReferenceWidth={matchReferenceWidth}
+              open={open}
+              padding={padding}
+              placement={placement}
+              portal={portal}
+              preventOverflow={preventOverflow}
+              radius={radius}
+              width={width}
+            >
+              <Button text="This button is the popover reference" />
+            </Popover>
+          </div>
+        </div>
+        <div ref={setPortalElement} />
+      </PortalProvider>
+    </Card>
+  )
+}

package/src/primitives/popover/__workshop__/RecursiveStory.tsx

@@ -0,0 +1,78 @@
+import {
+  Button,
+  Flex,
+  LayerProvider,
+  Placement,
+  Popover,
+  ThemeColorToneKey,
+  useLayer,
+} from '@sanity/ui'
+import {useCallback, useEffect, useMemo, useRef, useState} from 'react'
+
+export default function RecursiveStory() {
+  return (
+    <Flex align="center" height="fill" justify="center" padding={[4, 5, 6]} sizing="border">
+      <LayerProvider>
+        <RecursiveExample />
+      </LayerProvider>
+    </Flex>
+  )
+}
+
+const placements: Placement[] = ['top', 'right', 'bottom', 'left']
+const tones: ThemeColorToneKey[] = ['primary', 'positive', 'caution', 'critical']
+
+function RecursiveExample({onClose}: {onClose?: () => void}) {
+  const [open, setOpen] = useState(false)
+  const buttonRef = useRef<HTMLButtonElement | null>(null)
+  const {isTopLayer} = useLayer()
+  const [seed] = useState(() => Math.floor(Math.random() * 4))
+  const fallbackPlacements = useMemo(() => {
+    const before = placements.slice(seed)
+    const after = placements.slice(0, seed)
+
+    return before.concat(after)
+  }, [seed])
+
+  useEffect(() => {
+    if (open === false) buttonRef.current?.focus()
+  }, [open])
+
+  useEffect(() => {
+    setTimeout(() => {
+      buttonRef.current?.focus()
+    }, 0)
+  }, [])
+
+  const handleOpen = useCallback(() => setOpen(true), [])
+  const handleClose = useCallback(() => setOpen(false), [])
+
+  const handleKeyDown = useCallback(
+    (event: React.KeyboardEvent<HTMLButtonElement>) => {
+      if (!isTopLayer) return
+      if (event.key === 'Escape' && onClose) onClose()
+    },
+    [isTopLayer, onClose]
+  )
+
+  return (
+    <Popover
+      fallbackPlacements={fallbackPlacements}
+      content={<RecursiveExample onClose={handleClose} />}
+      open={open}
+      padding={1}
+      placement={fallbackPlacements[3]}
+      portal
+      tone={tones[seed]}
+    >
+      <Button
+        mode="bleed"
+        onKeyDown={handleKeyDown}
+        onClick={handleOpen}
+        radius={3}
+        ref={buttonRef}
+        text="Open"
+      />
+    </Popover>
+  )
+}

package/src/primitives/popover/__workshop__/TestStory.tsx

@@ -0,0 +1,81 @@
+import {useBoolean, useSelect, useText} from '@sanity/ui-workshop'
+import {ReactElement, useState} from 'react'
+import {
+  WORKSHOP_CONTAINER_WIDTH_OPTIONS,
+  WORKSHOP_PLACEMENT_OPTIONS,
+  WORKSHOP_RADIUS_OPTIONS,
+} from '../../../__workshop__/constants'
+import {BoundaryElementProvider, PortalProvider} from '../../../utils'
+import {Button} from '../../button'
+import {Card} from '../../card'
+import {Text} from '../../text'
+import {Popover} from '../popover'
+
+export default function TestStory(): ReactElement {
+  const [portalElement, setPortalElement] = useState<HTMLDivElement | null>(null)
+  const [boundaryElement, setBoundaryElement] = useState<HTMLDivElement | null>(null)
+  const arrow = useBoolean('Arrow', true)
+  const constrainSize = useBoolean('Constrain size', true)
+  const matchReferenceWidth = useBoolean('Match reference width', false)
+  const open = useBoolean('Open', true)
+  const placement = useSelect('Placement', WORKSHOP_PLACEMENT_OPTIONS, 'bottom')
+  const preventOverflow = useBoolean('Prevent overflow', true)
+  const radius = useSelect('Radius', WORKSHOP_RADIUS_OPTIONS, 2)
+  const referenceWide = useBoolean('Reference wide?', false)
+  const width = useSelect('Width', WORKSHOP_CONTAINER_WIDTH_OPTIONS, 'auto')
+
+  const text = useText('Text', 'Test')
+
+  return (
+    <Card
+      ref={setBoundaryElement}
+      shadow={2}
+      style={{
+        position: 'absolute',
+        top: 50,
+        right: 50,
+        bottom: 50,
+        left: 50,
+      }}
+    >
+      <div
+        data-portal=""
+        ref={setPortalElement}
+        style={{
+          position: 'absolute',
+          top: 0,
+          right: 0,
+          bottom: 0,
+          left: 0,
+          overflow: 'hidden',
+          pointerEvents: 'none',
+        }}
+      />
+
+      <div style={{width: '100%', height: '100%', overflow: 'auto'}}>
+        <div style={{padding: '150vh'}}>
+          <PortalProvider element={portalElement}>
+            <BoundaryElementProvider element={boundaryElement}>
+              <Popover
+                arrow={arrow}
+                content={<Text size={1}>{text}</Text>}
+                constrainSize={constrainSize}
+                fallbackPlacements={['left', 'bottom', 'right', 'top']}
+                matchReferenceWidth={matchReferenceWidth}
+                open={open}
+                padding={3}
+                placement={placement}
+                portal
+                preventOverflow={preventOverflow}
+                radius={radius}
+                width={width}
+              >
+                <Button text="reference" style={{width: referenceWide ? 300 : undefined}} />
+              </Popover>
+            </BoundaryElementProvider>
+          </PortalProvider>
+        </div>
+      </div>
+    </Card>
+  )
+}

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

@@ -0,0 +1,39 @@
+import {defineScope} from '@sanity/ui-workshop'
+import {lazy} from 'react'
+
+export default defineScope({
+  name: 'primitives/popover',
+  title: 'Popover',
+  stories: [
+    {
+      name: 'test',
+      title: 'Test',
+      component: lazy(() => import('./TestStory')),
+    },
+    {
+      name: 'plain',
+      title: 'Plain',
+      component: lazy(() => import('./PlainStory')),
+    },
+    {
+      name: 'recursive',
+      title: 'Recursive',
+      component: lazy(() => import('./RecursiveStory')),
+    },
+    {
+      name: 'match-ref-width',
+      title: 'Match reference width',
+      component: lazy(() => import('./MatchReferenceWidthStory')),
+    },
+    {
+      name: 'margins',
+      title: 'Margins',
+      component: lazy(() => import('./MarginsStory')),
+    },
+    {
+      name: 'aligned',
+      title: 'Aligned',
+      component: lazy(() => import('./AlignedStory')),
+    },
+  ],
+})

package/src/primitives/popover/constants.ts

@@ -0,0 +1,7 @@
+import {PopoverMargins} from '../../types'
+
+export const DEFAULT_POPOVER_DISTANCE = 4
+export const DEFAULT_POPOVER_PADDING = 4
+export const DEFAULT_POPOVER_ARROW_WIDTH = 27
+export const DEFAULT_POPOVER_ARROW_HEIGHT = 11
+export const DEFAULT_POPOVER_MARGINS: PopoverMargins = [0, 0, 0, 0]

package/src/primitives/popover/floating-ui/size.ts

@@ -0,0 +1,82 @@
+import {Elements, Middleware, detectOverflow} from '@floating-ui/react-dom'
+import {PopoverMargins} from '../../../types'
+
+export interface SizeMiddlewareApplyOptions {
+  availableWidth: number
+  availableHeight: number
+  elements: Elements
+  referenceWidth: number
+}
+
+export function size(options: {
+  apply: (args: SizeMiddlewareApplyOptions) => void
+  boundaryElement?: HTMLElement | null
+  constrainSize: boolean
+  margins: PopoverMargins
+  matchReferenceWidth?: boolean
+  padding?: number
+}): Middleware {
+  const {apply, margins, padding = 0} = options
+
+  return {
+    name: '@sanity/ui/size',
+    async fn(args) {
+      const {elements, placement, platform, rects} = args
+      const {floating, reference} = rects
+
+      const overflow = await detectOverflow(args, {
+        altBoundary: true,
+        boundary: options.boundaryElement || undefined,
+        elementContext: 'floating',
+        padding,
+        rootBoundary: 'viewport',
+      })
+
+      let maxWidth = Infinity
+      let maxHeight = Infinity
+
+      const floatingW = floating.width
+      const floatingH = floating.height
+
+      if (placement.includes('top')) {
+        maxWidth = floatingW - (overflow.left + overflow.right)
+        maxHeight = floatingH - overflow.top
+      }
+
+      if (placement.includes('right')) {
+        maxWidth = floatingW - overflow.right
+        maxHeight = floatingH - (overflow.top + overflow.bottom)
+      }
+
+      if (placement.includes('bottom')) {
+        maxWidth = floatingW - (overflow.left + overflow.right)
+        maxHeight = floatingH - overflow.bottom
+      }
+
+      if (placement.includes('left')) {
+        maxWidth = floatingW - overflow.left
+        maxHeight = floatingH - (overflow.top + overflow.bottom)
+      }
+
+      // IMPORTANT – APPLY ELEMENT STYLES HERE
+      // Elements need to be resized BEFORE the `platform.getDimensions` call below
+      apply({
+        availableWidth: maxWidth - margins[1] - margins[3],
+        availableHeight: maxHeight - margins[0] - margins[2],
+        elements,
+        referenceWidth: reference.width - margins[1] - margins[3],
+      })
+
+      const nextDimensions = await platform.getDimensions(elements.floating)
+
+      const targetH = nextDimensions.height
+      const targetW = nextDimensions.width
+
+      if (floatingW !== targetW || floatingH !== targetH) {
+        return {reset: {rects: true}}
+      }
+
+      return {}
+    },
+  }
+}

package/src/primitives/popover/index.ts

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