@primer/components 29.1.1 → 30.0.0-rc.48fd5c94

package/src/stories/AnchoredOverlay.stories.tsx

@@ -0,0 +1,117 @@
+import React, {useEffect, useRef, useState} from 'react'
+import {Meta} from '@storybook/react'
+
+import {BaseStyles, Box, ThemeProvider} from '..'
+import Heading from '../Heading'
+import DropdownButton from '../Button'
+import {AnchoredOverlay} from '../AnchoredOverlay'
+import {registerPortalRoot} from '../Portal'
+
+export default {
+  title: 'Generic behaviors/AnchoredOverlay',
+  decorators: [
+    Story => {
+      return (
+        <ThemeProvider>
+          <BaseStyles>
+            <Story />
+          </BaseStyles>
+        </ThemeProvider>
+      )
+    }
+  ]
+} as Meta
+
+const HeaderAndLayout = ({children}: {children: JSX.Element}) => {
+  const scrollingElementRef = useRef<HTMLDivElement>(null)
+  useEffect(() => {
+    if (scrollingElementRef.current) {
+      registerPortalRoot(scrollingElementRef.current, 'scrollingPortal')
+    }
+  }, [scrollingElementRef])
+  return (
+    <Box position="absolute" top={0} right={0} bottom={0} left={0} padding={4} backgroundColor="lavenderblush">
+      <Heading>Header or some such</Heading>
+      <Box position="absolute" top={10} right={4} bottom={4} left={4} overflow="scroll" backgroundColor="powderblue">
+        {children}
+        <Box ref={scrollingElementRef} position="absolute" top={0} left={0} />
+      </Box>
+    </Box>
+  )
+}
+
+const ButtonWithAnchoredOverlay = ({portalContainerName}: {portalContainerName?: string}) => {
+  const [open, setOpen] = useState(false)
+
+  return (
+    <AnchoredOverlay
+      open={open}
+      onOpen={() => setOpen(true)}
+      onClose={() => setOpen(false)}
+      width="small"
+      height="auto"
+      renderAnchor={props => <DropdownButton {...props}>Kitten, please</DropdownButton>}
+      overlayProps={{portalContainerName}}
+    >
+      <Box width="100%" height="100%" backgroundColor="thistle" display="flex" flexDirection="column">
+        <img src={`//placekitten.com/200/300`} alt="kitten" />
+      </Box>
+    </AnchoredOverlay>
+  )
+}
+
+export const DefaultPortal = () => {
+  const rows = 40
+  const columns = 20
+  return (
+    <HeaderAndLayout>
+      <table>
+        <tbody>
+          {Array(rows)
+            .fill(null)
+            .map((_, i) => (
+              <tr key={i}>
+                {Array(columns)
+                  .fill(null)
+                  .map((_1, j) => (
+                    <td key={`${i}${j}`}>
+                      <Box m={2}>
+                        <ButtonWithAnchoredOverlay />
+                      </Box>
+                    </td>
+                  ))}
+              </tr>
+            ))}
+        </tbody>
+      </table>
+    </HeaderAndLayout>
+  )
+}
+
+export const PortalInsideScrollingElement = () => {
+  const rows = 40
+  const columns = 20
+  return (
+    <HeaderAndLayout>
+      <table>
+        <tbody>
+          {Array(rows)
+            .fill(null)
+            .map((_, i) => (
+              <tr key={i}>
+                {Array(columns)
+                  .fill(null)
+                  .map((_1, j) => (
+                    <td key={`${i}${j}`}>
+                      <Box m={2}>
+                        <ButtonWithAnchoredOverlay portalContainerName="scrollingPortal" />
+                      </Box>
+                    </td>
+                  ))}
+              </tr>
+            ))}
+        </tbody>
+      </table>
+    </HeaderAndLayout>
+  )
+}

package/src/stories/AvatarStack.stories.tsx

@@ -0,0 +1,37 @@
+import AvatarStack from '../AvatarStack'
+import {Meta} from '@storybook/react'
+import React from 'react'
+import {ThemeProvider} from '..'
+import BaseStyles from '../BaseStyles'
+
+const meta: Meta = {
+  title: 'Composite components/AvatarStack',
+  component: AvatarStack,
+  decorators: [
+    (Story: React.ComponentType): JSX.Element => (
+      <ThemeProvider>
+        <BaseStyles>
+          <Story />
+        </BaseStyles>
+      </ThemeProvider>
+    )
+  ],
+  parameters: {
+    controls: {
+      disabled: true
+    }
+  }
+}
+export default meta
+
+export function AvatarStackStory(): JSX.Element {
+  return (
+    <AvatarStack>
+      <img src="https://avatars.githubusercontent.com/primer" alt="" />
+      <img src="https://avatars.githubusercontent.com/github" alt="" />
+      <img src="https://avatars.githubusercontent.com/primer" alt="" />
+      <img src="https://avatars.githubusercontent.com/github" alt="" />
+    </AvatarStack>
+  )
+}
+AvatarStackStory.storyName = 'AvatarStack'

package/src/stories/Button.stories.tsx

@@ -0,0 +1,88 @@
+import React from 'react'
+import {Meta} from '@storybook/react'
+
+import {
+  BaseStyles,
+  Button,
+  ButtonClose,
+  ButtonDanger,
+  ButtonGroup,
+  ButtonInvisible,
+  ButtonOutline,
+  ButtonPrimary,
+  ButtonTableList,
+  ThemeProvider
+} from '..'
+import {ButtonStyleProps} from 'styled-system'
+import {ButtonBaseProps} from '../Button/ButtonBase'
+type StrictButtonStyleProps = ButtonStyleProps & {variant: ButtonBaseProps['variant']}
+
+export default {
+  title: 'Composite components/Button',
+
+  decorators: [
+    Story => {
+      return (
+        <ThemeProvider>
+          <BaseStyles>
+            <Story />
+          </BaseStyles>
+        </ThemeProvider>
+      )
+    }
+  ],
+  argTypes: {
+    as: {
+      table: {
+        disable: true
+      }
+    },
+    theme: {
+      table: {
+        disable: true
+      }
+    },
+    sx: {
+      table: {
+        disable: true
+      }
+    },
+    variant: {
+      control: {
+        type: 'radio',
+        options: ['small', 'medium', 'large']
+      }
+    }
+  }
+} as Meta
+
+export const defaultButton = (args: StrictButtonStyleProps) => <Button {...args}>Default Button</Button>
+export const dangerButton = (args: StrictButtonStyleProps) => <ButtonDanger {...args}>Danger Button</ButtonDanger>
+export const outlineButton = (args: StrictButtonStyleProps) => <ButtonOutline {...args}>Outline Button</ButtonOutline>
+export const primaryButton = (args: StrictButtonStyleProps) => <ButtonPrimary {...args}>Primary Button</ButtonPrimary>
+export const invisibleButton = (args: StrictButtonStyleProps) => (
+  <ButtonInvisible {...args}>Invisible Button</ButtonInvisible>
+)
+
+export const closeButton = (args: ButtonStyleProps) => (
+  <ButtonClose {...args} onClick={() => alert('button clicked.')} />
+)
+export const buttonGroup = (args: StrictButtonStyleProps) => (
+  <ButtonGroup display="block" my={2}>
+    <Button {...args}>Button 1</Button>
+    <Button {...args}>Button 2</Button>
+    <Button {...args}>Button 3</Button>
+  </ButtonGroup>
+)
+export const buttonTableList = (args: ButtonStyleProps) => (
+  <ButtonTableList {...args}>Button Table List</ButtonTableList>
+)
+
+defaultButton.args = {variant: 'medium'}
+dangerButton.args = {variant: 'medium'}
+outlineButton.args = {variant: 'medium'}
+primaryButton.args = {variant: 'medium'}
+invisibleButton.args = {variant: 'medium'}
+closeButton.args = {variant: 'medium'}
+buttonGroup.args = {variant: 'medium'}
+buttonTableList.args = {variant: 'medium'}

package/src/stories/ConfirmationDialog.stories.tsx

@@ -0,0 +1,105 @@
+import React, {useState, useRef, useCallback} from 'react'
+import {Meta} from '@storybook/react'
+
+import {BaseStyles, Button, Box, ThemeProvider, useTheme} from '..'
+import {ConfirmationDialog, useConfirm} from '../Dialog/ConfirmationDialog'
+import {ActionMenu} from '../ActionMenu'
+
+export default {
+  title: 'Internal components/ConfirmationDialog',
+  component: ConfirmationDialog,
+  decorators: [
+    Story => {
+      // Since portal roots are registered globally, we need this line so that each storybook
+      // story works in isolation.
+      return (
+        <ThemeProvider>
+          <BaseStyles>
+            <Story />
+          </BaseStyles>
+        </ThemeProvider>
+      )
+    }
+  ]
+} as Meta
+
+export const BasicConfirmationDialog = () => {
+  const [isOpen, setIsOpen] = useState(false)
+  const buttonRef = useRef<HTMLButtonElement>(null)
+  const onDialogClose = useCallback(() => setIsOpen(false), [])
+  return (
+    <>
+      <Button ref={buttonRef} onClick={() => setIsOpen(!isOpen)}>
+        Show dialog
+      </Button>
+      {isOpen && (
+        <ConfirmationDialog
+          title="Delete universe?"
+          onClose={onDialogClose}
+          confirmButtonContent="Delete it!"
+          confirmButtonType="danger"
+        >
+          Deleting the universe could have disastrous effects, including but not limited to destroying all life on
+          Earth.
+        </ConfirmationDialog>
+      )}
+    </>
+  )
+}
+
+export const ShorthandHook = () => {
+  const confirm = useConfirm()
+  const {theme} = useTheme()
+  const onButtonClick = useCallback(
+    async (event: React.MouseEvent) => {
+      if (
+        (await confirm({title: 'Are you sure?', content: 'Do you really want to turn this button green?'})) &&
+        event.target instanceof HTMLElement
+      ) {
+        event.target.style.backgroundColor = theme?.colors.auto.green[3] ?? 'green'
+        event.target.textContent = "I'm green!"
+      }
+    },
+    [confirm, theme]
+  )
+  return (
+    <Box display="flex" flexDirection="column" alignItems="flex-start">
+      <Button mb={2} onClick={onButtonClick}>
+        Turn me green!
+      </Button>
+      <Button mb={2} onClick={onButtonClick}>
+        Turn me green!
+      </Button>
+      <Button mb={2} onClick={onButtonClick}>
+        Turn me green!
+      </Button>
+      <Button mb={2} onClick={onButtonClick}>
+        Turn me green!
+      </Button>
+    </Box>
+  )
+}
+
+export const ShorthandHookFromActionMenu = () => {
+  const confirm = useConfirm()
+  const [text, setText] = useState('open me')
+  const onButtonClick = useCallback(async () => {
+    if (await confirm({title: 'Are you sure?', content: 'Do you really want to do a trick?'})) {
+      setText('tada!')
+    }
+  }, [confirm])
+
+  return (
+    <Box display="flex" flexDirection="column" alignItems="flex-start">
+      <ActionMenu
+        renderAnchor={props => <Button {...props}>{text}</Button>}
+        items={[
+          {
+            text: 'Do a trick!',
+            onAction: onButtonClick
+          }
+        ]}
+      />
+    </Box>
+  )
+}

package/src/stories/Dialog.stories.tsx

@@ -0,0 +1,240 @@
+import React, {useState, useRef, useCallback} from 'react'
+import {Meta} from '@storybook/react'
+
+import {BaseStyles, Button, ThemeProvider, Box} from '..'
+import {Dialog, DialogProps, DialogWidth, DialogHeight} from '../Dialog/Dialog'
+
+export default {
+  title: 'Internal components/Dialog',
+  component: Dialog,
+  decorators: [
+    Story => {
+      // Since portal roots are registered globally, we need this line so that each storybook
+      // story works in isolation.
+      return (
+        <ThemeProvider>
+          <BaseStyles>
+            <Story />
+          </BaseStyles>
+        </ThemeProvider>
+      )
+    }
+  ],
+  argTypes: {
+    width: {
+      defaultValue: 'xlarge',
+      control: {
+        type: 'radio',
+        options: ['small', 'medium', 'large', 'xlarge']
+      }
+    },
+    height: {
+      defaultValue: 'auto',
+      control: {
+        type: 'radio',
+        options: ['small', 'large', 'auto']
+      }
+    },
+    subtitle: {
+      name: 'show subtitle',
+      defaultValue: true,
+      control: {
+        type: 'boolean'
+      }
+    },
+    title: {table: {disable: true}},
+
+    renderHeader: {table: {disable: true}},
+    renderBody: {table: {disable: true}},
+    renderFooter: {table: {disable: true}},
+    onClose: {table: {disable: true}},
+    role: {table: {disable: true}},
+    ref: {table: {disable: true}},
+    key: {table: {disable: true}},
+    footerButtons: {table: {disable: true}}
+  }
+} as Meta
+
+const lipsum = (
+  <div style={{fontSize: '14px'}}>
+    <p style={{marginBlockStart: 0}}>
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sollicitudin mauris maximus elit sagittis, nec
+      lobortis ligula elementum. Nam iaculis, urna nec lobortis posuere, eros urna venenatis eros, vel accumsan turpis
+      nunc vitae enim. Maecenas et lorem lectus. Vivamus iaculis tortor eget ante placerat, nec posuere nisl tincidunt.
+      Cras condimentum ante in accumsan ultricies. Morbi quis porta est, sit amet congue augue. Lorem ipsum dolor sit
+      amet, consectetur adipiscing elit. Ut consequat nunc id quam tempus, id tincidunt neque venenatis. Mauris
+      fringilla tempor est, vitae fermentum enim elementum vitae. Nullam eleifend odio ut porta efficitur. Phasellus
+      luctus tempus posuere.
+    </p>
+
+    <p>
+      Curabitur scelerisque bibendum faucibus. Duis rhoncus nunc est, at pharetra eros tristique a. Nam sodales turpis
+      lectus, quis faucibus felis fermentum in. Curabitur vel velit vel eros laoreet pharetra. Aenean in facilisis
+      sapien, eu porttitor ex. Donec ultrices ac arcu ut lobortis. Pellentesque vitae rutrum orci. Etiam pretium et enim
+      sit amet scelerisque. Nulla sed odio nec lorem dapibus condimentum at sagittis quam. Sed in ornare ex, sed luctus
+      sem. Mauris a est tellus.
+    </p>
+
+    <p>
+      Sed fringilla est ac urna aliquet, eget condimentum felis vulputate. Sed sagittis eros non mauris sodales
+      molestie. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Nullam ante leo,
+      condimentum sed lectus non, rutrum octopodes urna. Mauris neque ante, interdum molestie tellus pharetra, eleifend
+      dapibus justo. Sed at diam ligula. Donec dapibus ipsum quis elit euismod, sed suscipit eros euismod. Aliquam
+      pretium felis quis risus luctus fringilla. Ut purus lacus, mattis a turpis eget, sollicitudin pellentesque neque.
+    </p>
+
+    <p>
+      Nunc sodales quis ante quis porttitor. Vestibulum ornare lacinia ante. Donec a nisi nec arcu aliquam pretium in
+      nec nunc. Donec fringilla erat vitae viverra feugiat. Sed non odio vel ipsum porttitor maximus. Donec id eleifend
+      lectus. Proin varius felis sit amet neque eleifend, vitae porttitor ligula commodo.
+    </p>
+
+    <p>
+      Vivamus felis quam, porttitor a justo sit amet, placerat ultricies nisl. Suspendisse potenti. Maecenas non
+      consequat lorem, eu porta ante. Pellentesque elementum diam sapien, nec ultrices risus convallis eget. Nam
+      pharetra dolor at dictum tempor. Quisque ut est a ligula hendrerit sodales. Curabitur ornare a nulla in laoreet.
+      Maecenas semper mi egestas, dignissim nisi et, elementum neque.
+    </p>
+  </div>
+)
+interface DialogStoryProps {
+  width: DialogWidth
+  height: DialogHeight
+  subtitle: boolean
+}
+export const BasicDialog = ({width, height, subtitle}: DialogStoryProps) => {
+  const [isOpen, setIsOpen] = useState(false)
+  const [secondOpen, setSecondOpen] = useState(false)
+  const buttonRef = useRef<HTMLButtonElement>(null)
+  const onDialogClose = useCallback(() => setIsOpen(false), [])
+  const onSecondDialogClose = useCallback(() => setSecondOpen(false), [])
+  const openSecondDialog = useCallback(() => setSecondOpen(true), [])
+  return (
+    <>
+      <Button ref={buttonRef} onClick={() => setIsOpen(!isOpen)}>
+        Show dialog
+      </Button>
+      {isOpen && (
+        <Dialog
+          title="My Dialog"
+          subtitle={subtitle ? 'This is a subtitle!' : undefined}
+          onClose={onDialogClose}
+          width={width}
+          height={height}
+          footerButtons={[
+            {buttonType: 'danger', content: 'Delete the universe', onClick: onDialogClose},
+            {buttonType: 'primary', content: 'Proceed', onClick: openSecondDialog, autoFocus: true}
+          ]}
+        >
+          {lipsum}
+          {secondOpen && (
+            <Dialog title="Inner dialog!" onClose={onSecondDialogClose} width="small">
+              Hello world
+            </Dialog>
+          )}
+        </Dialog>
+      )}
+    </>
+  )
+}
+
+function CustomHeader({
+  title,
+  subtitle,
+  dialogLabelId,
+  dialogDescriptionId,
+  onClose
+}: React.PropsWithChildren<DialogProps & {dialogLabelId: string; dialogDescriptionId: string}>) {
+  const onCloseClick = useCallback(() => {
+    onClose('close-button')
+  }, [onClose])
+  if (typeof title === 'string' && typeof subtitle === 'string') {
+    return (
+      <Box bg="auto.blue.3">
+        <h1 id={dialogLabelId}>{title.toUpperCase()}</h1>
+        <h2 id={dialogDescriptionId}>{subtitle.toLowerCase()}</h2>
+        <Dialog.CloseButton onClose={onCloseClick} />
+      </Box>
+    )
+  }
+  return null
+}
+function CustomBody({children}: React.PropsWithChildren<DialogProps>) {
+  return <Dialog.Body bg="auto.red.3">{children}</Dialog.Body>
+}
+function CustomFooter({footerButtons}: React.PropsWithChildren<DialogProps>) {
+  return (
+    <Dialog.Footer bg="auto.yellow.3">
+      {footerButtons ? <Dialog.Buttons buttons={footerButtons} /> : null}
+    </Dialog.Footer>
+  )
+}
+export const WithCustomRenderers = ({width, height, subtitle}: DialogStoryProps) => {
+  const [isOpen, setIsOpen] = useState(false)
+  const onDialogClose = useCallback(() => setIsOpen(false), [])
+  return (
+    <>
+      <Button onClick={() => setIsOpen(!isOpen)}>Show dialog</Button>
+      {isOpen && (
+        <Dialog
+          title="My Dialog"
+          subtitle={subtitle ? 'This is a subtitle!' : undefined}
+          width={width}
+          height={height}
+          renderHeader={CustomHeader}
+          renderBody={CustomBody}
+          renderFooter={CustomFooter}
+          onClose={onDialogClose}
+          footerButtons={[
+            {buttonType: 'danger', content: 'Delete the universe', onClick: onDialogClose},
+            {buttonType: 'primary', content: 'Proceed'}
+          ]}
+        >
+          {lipsum}
+        </Dialog>
+      )}
+    </>
+  )
+}
+
+export const StressTest = ({width, height, subtitle}: DialogStoryProps) => {
+  const [isOpen, setIsOpen] = useState(false)
+  const [secondOpen, setSecondOpen] = useState(false)
+  const buttonRef = useRef<HTMLButtonElement>(null)
+  const onDialogClose = useCallback(() => setIsOpen(false), [])
+  const onSecondDialogClose = useCallback(() => setSecondOpen(false), [])
+  const openSecondDialog = useCallback(() => setSecondOpen(true), [])
+  const manyButtons = new Array(10).fill(undefined).map((_, i) => ({content: `Button ${i}`}))
+  return (
+    <>
+      <Button ref={buttonRef} onClick={() => setIsOpen(!isOpen)}>
+        Show dialog
+      </Button>
+      {isOpen && (
+        <Dialog
+          title="This dialog has a really long title. So long, in fact, that it should cause wrapping, going to multiple lines!."
+          subtitle={
+            subtitle
+              ? "It's not a common scenario, sure, but what if the subtitle is generated from a really long value? Do we just break the dialog? Or do we handle it because we are pros?"
+              : undefined
+          }
+          onClose={onDialogClose}
+          width={width}
+          height={height}
+          footerButtons={[
+            ...manyButtons,
+            {buttonType: 'danger', content: 'Delete the universe', onClick: onDialogClose},
+            {buttonType: 'primary', content: 'Proceed', onClick: openSecondDialog, autoFocus: true}
+          ]}
+        >
+          {lipsum}
+          {secondOpen && (
+            <Dialog title="Inner dialog!" onClose={onSecondDialogClose} width="small">
+              Hello world
+            </Dialog>
+          )}
+        </Dialog>
+      )}
+    </>
+  )
+}

package/src/stories/DropdownMenu.stories.tsx

@@ -0,0 +1,84 @@
+import {Meta} from '@storybook/react'
+import React from 'react'
+import {theme, ThemeProvider} from '..'
+import {ItemInput} from '../ActionList/List'
+import BaseStyles from '../BaseStyles'
+import Box from '../Box'
+import {DropdownMenu, DropdownButton} from '../DropdownMenu'
+import TextInput from '../TextInput'
+
+const meta: Meta = {
+  title: 'Composite components/DropdownMenu',
+  component: DropdownMenu,
+  decorators: [
+    (Story: React.ComponentType): JSX.Element => {
+      return (
+        <ThemeProvider theme={theme}>
+          <BaseStyles>
+            <Story />
+          </BaseStyles>
+        </ThemeProvider>
+      )
+    }
+  ],
+  parameters: {
+    controls: {
+      disable: true
+    }
+  }
+}
+export default meta
+
+export function FavoriteColorStory(): JSX.Element {
+  const items = React.useMemo(() => [{text: '🔵 Cyan'}, {text: '🔴 Magenta'}, {text: '🟡 Yellow'}], [])
+  const [selectedItem, setSelectedItem] = React.useState<ItemInput | undefined>()
+
+  return (
+    <>
+      <h1>Favorite Color</h1>
+      <TextInput placeholder="Input for focus testing" sx={{mb: 2}} />
+      <div id="favorite-color-label">Please select your favorite color:</div>
+      <DropdownMenu
+        renderAnchor={({children, 'aria-labelledby': ariaLabelledBy, ...anchorProps}) => (
+          <DropdownButton aria-labelledby={`favorite-color-label ${ariaLabelledBy}`} {...anchorProps}>
+            {children}
+          </DropdownButton>
+        )}
+        placeholder="🎨"
+        items={items}
+        selectedItem={selectedItem}
+        onChange={setSelectedItem}
+      />
+    </>
+  )
+}
+FavoriteColorStory.storyName = 'Favorite Color'
+
+export function ExternalAnchorStory(): JSX.Element {
+  const items = React.useMemo(() => [{text: '🔵 Cyan'}, {text: '🔴 Magenta'}, {text: '🟡 Yellow'}], [])
+  const [selectedItem, setSelectedItem] = React.useState<ItemInput | undefined>()
+  const anchorRef = React.useRef<HTMLDivElement>(null)
+  const [open, setOpen] = React.useState(false)
+
+  return (
+    <Box display="flex" flexDirection="column" alignItems="flex-start">
+      <Box display="flex" flexDirection="row">
+        <DropdownButton onClick={() => setOpen(true)}>Click me to open the dropdown</DropdownButton>
+        <Box ref={anchorRef} bg="papayawhip" p={4} ml={40} borderRadius={2} display="inline-block">
+          Anchored on me!
+        </Box>
+      </Box>
+      <DropdownMenu
+        renderAnchor={null}
+        anchorRef={anchorRef}
+        open={open}
+        onOpenChange={setOpen}
+        placeholder="🎨"
+        items={items}
+        selectedItem={selectedItem}
+        onChange={setSelectedItem}
+      />
+    </Box>
+  )
+}
+ExternalAnchorStory.storyName = 'DropdownMenu with External Anchor'