@primer/components 31.2.1-rc.a088bdc0 → 32.0.0

package/src/NewButton/types.ts

@@ -1,36 +0,0 @@
-import React, {HTMLAttributes} from 'react'
-import {IconProps} from '@primer/octicons-react'
-import {SxProp} from '../sx'
-
-export type VariantType = 'default' | 'primary' | 'invisible' | 'danger' | 'outline'
-
-export type Size = 'small' | 'medium' | 'large'
-
-export type ButtonProps = {
-  /**
-   * Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'
-   */
-  variant?: VariantType
-  /**
-   * Size of button and fontSize of text in button
-   */
-  size?: Size
-  /**
-   * This is to be used if it is an icon-only button. Will make text visually hidden
-   */
-  icon?: React.FunctionComponent<IconProps>
-  /**
-   * The leading icon comes before button content
-   */
-  leadingIcon?: React.FunctionComponent<IconProps>
-  /**
-   * The trailing icon comes after button content
-   */
-  trailingIcon?: React.FunctionComponent<IconProps>
-  /**
-   * Items that are disabled can not be clicked, selected, or navigated through.
-   */
-  disabled?: boolean
-  children: React.ReactNode
-} & SxProp &
-  HTMLAttributes<HTMLButtonElement>

package/src/Overlay.tsx

@@ -1,198 +0,0 @@
-import styled from 'styled-components'
-import React, {ReactElement, useEffect, useRef} from 'react'
-import {get, COMMON, SystemPositionProps, SystemCommonProps} from './constants'
-import {ComponentProps} from './utils/types'
-import useLayoutEffect from './utils/useIsomorphicLayoutEffect'
-import {useOverlay, TouchOrMouseEvent} from './hooks'
-import Portal from './Portal'
-import sx, {SxProp} from './sx'
-import {useCombinedRefs} from './hooks/useCombinedRefs'
-import {AnchorSide} from './behaviors/anchoredPosition'
-import {useTheme} from './ThemeProvider'
-
-type StyledOverlayProps = {
-  width?: keyof typeof widthMap
-  height?: keyof typeof heightMap
-  maxHeight?: keyof Omit<typeof heightMap, 'auto' | 'initial'>
-  visibility?: 'visible' | 'hidden'
-  anchorSide?: AnchorSide
-}
-
-const heightMap = {
-  xsmall: '192px',
-  small: '256px',
-  medium: '320px',
-  large: '432px',
-  xlarge: '600px',
-  auto: 'auto',
-  initial: 'auto' // Passing 'initial' initially applies 'auto'
-}
-
-const widthMap = {
-  small: '256px',
-  medium: '320px',
-  large: '480px',
-  xlarge: '640px',
-  xxlarge: '960px',
-  auto: 'auto'
-}
-const animationDuration = 200
-
-function getSlideAnimationStartingVector(anchorSide?: AnchorSide): {x: number; y: number} {
-  if (anchorSide?.endsWith('bottom')) {
-    return {x: 0, y: -1}
-  } else if (anchorSide?.endsWith('top')) {
-    return {x: 0, y: 1}
-  } else if (anchorSide?.endsWith('right')) {
-    return {x: -1, y: 0}
-  } else if (anchorSide?.endsWith('left')) {
-    return {x: 1, y: 0}
-  }
-
-  return {x: 0, y: 0}
-}
-
-const StyledOverlay = styled.div<StyledOverlayProps & SystemCommonProps & SxProp>`
-  background-color: ${get('colors.canvas.overlay')};
-  box-shadow: ${get('shadows.overlay.shadow')};
-  position: absolute;
-  min-width: 192px;
-  max-width: 640px;
-  height: ${props => heightMap[props.height || 'auto']};
-  max-height: ${props => props.maxHeight && heightMap[props.maxHeight]};
-  width: ${props => widthMap[props.width || 'auto']};
-  border-radius: 12px;
-  overflow: hidden;
-  animation: overlay-appear ${animationDuration}ms ${get('animation.easeOutCubic')};
-
-  @keyframes overlay-appear {
-    0% {
-      opacity: 0;
-    }
-    100% {
-      opacity: 1;
-    }
-  }
-  visibility: var(--styled-overlay-visibility);
-  :focus {
-    outline: none;
-  }
-  ${COMMON};
-  ${sx};
-`
-export type OverlayProps = {
-  ignoreClickRefs?: React.RefObject<HTMLElement>[]
-  initialFocusRef?: React.RefObject<HTMLElement>
-  returnFocusRef: React.RefObject<HTMLElement>
-  onClickOutside: (e: TouchOrMouseEvent) => void
-  onEscape: (e: KeyboardEvent) => void
-  visibility?: 'visible' | 'hidden'
-  [additionalKey: string]: unknown
-  top: number
-  left: number
-  portalContainerName?: string
-  preventFocusOnOpen?: boolean
-} & Omit<ComponentProps<typeof StyledOverlay>, 'visibility' | keyof SystemPositionProps>
-
-/**
- * An `Overlay` is a flexible floating surface, used to display transient content such as menus,
- * selection options, dialogs, and more. Overlays use shadows to express elevation. The `Overlay`
- * component handles all behaviors needed by overlay UIs as well as the common styles that all overlays * should have.
- * @param ignoreClickRefs Optional. An array of ref objects to ignore clicks on in the `onOutsideClick` behavior. This is often used to ignore clicking on the element that toggles the open/closed state for the `Overlay` to prevent the `Overlay` from being toggled twice.
- * @param initialFocusRef Optional. Ref for the element to focus when the `Overlay` is opened. If nothing is provided, the first focusable element in the `Overlay` body is focused.
- * @param returnFocusRef Required. Ref for the element to focus when the `Overlay` is closed.
- * @param onClickOutside  Required. Function to call when clicking outside of the `Overlay`. Typically this function removes the Overlay.
- * @param onEscape Required. Function to call when user presses `Escape`. Typically this function removes the Overlay.
- * @param width Sets the width of the `Overlay`, pick from our set list of widths, or pass `auto` to automatically set the width based on the content of the `Overlay`. `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `480px`, `xlarge` corresponds to `640px`, `xxlarge` corresponds to `960px`.
- * @param height Sets the height of the `Overlay`, pick from our set list of heights, or pass `auto` to automatically set the height based on the content of the `Overlay`, or pass `initial` to set the height based on the initial content of the `Overlay` (i.e. ignoring content changes). `xsmall` corresponds to `192px`, `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `432px`, `xlarge` corresponds to `600px`.
- * @param maxHeight Sets the maximum height of the `Overlay`, pick from our set list of heights. `xsmall` corresponds to `192px`, `small` corresponds to `256px`, `medium` corresponds to `320px`, `large` corresponds to `432px`, `xlarge` corresponds to `600px`.
- * @param anchorSide If provided, the Overlay will slide into position from the side of the anchor with a brief animation
- * @param top Optional. Vertical position of the overlay, relative to its closest positioned ancestor (often its `Portal`).
- * @param left Optional. Horizontal position of the overlay, relative to its closest positioned ancestor (often its `Portal`).
- * @param portalContainerName Optional. The name of the portal container to render the Overlay into.
- */
-const Overlay = React.forwardRef<HTMLDivElement, OverlayProps>(
-  (
-    {
-      onClickOutside,
-      role = 'none',
-      initialFocusRef,
-      returnFocusRef,
-      ignoreClickRefs,
-      onEscape,
-      visibility = 'visible',
-      height,
-      top,
-      left,
-      anchorSide,
-      portalContainerName,
-      preventFocusOnOpen,
-      ...rest
-    },
-    forwardedRef
-  ): ReactElement => {
-    const overlayRef = useRef<HTMLDivElement>(null)
-    const combinedRef = useCombinedRefs(overlayRef, forwardedRef)
-    const {theme} = useTheme()
-    const slideAnimationDistance = parseInt(get('space.2')(theme).replace('px', ''))
-    const slideAnimationEasing = get('animation.easeOutCubic')(theme)
-
-    useOverlay({
-      overlayRef,
-      returnFocusRef,
-      onEscape,
-      ignoreClickRefs,
-      onClickOutside,
-      initialFocusRef,
-      preventFocusOnOpen
-    })
-
-    useEffect(() => {
-      if (height === 'initial' && combinedRef.current?.clientHeight) {
-        combinedRef.current.style.height = `${combinedRef.current.clientHeight}px`
-      }
-    }, [height, combinedRef])
-
-    useLayoutEffect(() => {
-      const {x, y} = getSlideAnimationStartingVector(anchorSide)
-      if ((!x && !y) || !overlayRef.current?.animate || visibility === 'hidden') {
-        return
-      }
-
-      // JS animation is required because Safari does not allow css animations to start paused and then run
-      overlayRef.current.animate(
-        {transform: [`translate(${slideAnimationDistance * x}px, ${slideAnimationDistance * y}px)`, `translate(0, 0)`]},
-        {
-          duration: animationDuration,
-          easing: slideAnimationEasing
-        }
-      )
-    }, [anchorSide, slideAnimationDistance, slideAnimationEasing, visibility])
-
-    return (
-      <Portal containerName={portalContainerName}>
-        <StyledOverlay
-          height={height}
-          role={role}
-          {...rest}
-          ref={combinedRef}
-          style={
-            {
-              top: `${top || 0}px`,
-              left: `${left || 0}px`,
-              ...rest.style,
-              '--styled-overlay-visibility': visibility
-            } as React.CSSProperties
-          }
-        />
-      </Portal>
-    )
-  }
-)
-
-Overlay.defaultProps = {
-  height: 'auto',
-  width: 'auto'
-}
-
-export default Overlay

package/src/Pagehead.tsx

@@ -1,17 +0,0 @@
-import styled from 'styled-components'
-import {COMMON, get, SystemCommonProps} from './constants'
-import sx, {SxProp} from './sx'
-import {ComponentProps} from './utils/types'
-
-const Pagehead = styled.div<SystemCommonProps & SxProp>`
-  position: relative;
-  padding-top: ${get('space.4')};
-  padding-bottom: ${get('space.4')};
-  margin-bottom: ${get('space.4')};
-  border-bottom: 1px solid ${get('colors.border.default')};
-  ${COMMON};
-  ${sx};
-`
-
-export type PageheadProps = ComponentProps<typeof Pagehead>
-export default Pagehead

package/src/Pagination/Pagination.tsx

@@ -1,214 +0,0 @@
-import React from 'react'
-import styled from 'styled-components'
-import Box from '../Box'
-import {COMMON, get} from '../constants'
-import sx from '../sx'
-import {buildComponentData, buildPaginationModel} from './model'
-
-const Page = styled.a`
-  display: inline-block;
-  min-width: 32px;
-  padding: 5px 10px;
-  font-style: normal;
-  line-height: 20px;
-  color: ${get('colors.fg.default')};
-  text-align: center;
-  white-space: nowrap;
-  vertical-align: middle;
-  cursor: pointer;
-  user-select: none;
-  text-decoration: none;
-
-  margin-right: ${get('space.1')};
-
-  &:last-child {
-    margin-right: 0;
-  }
-
-  border: ${get('borderWidths.1')} solid transparent;
-  border-radius: ${get('radii.2')};
-  transition: border-color 0.2s cubic-bezier(0.3, 0, 0.5, 1);
-
-  &:hover,
-  &:focus {
-    text-decoration: none;
-    border-color: ${get('colors.border.default')};
-    outline: 0;
-    transition-duration: 0.1s;
-  }
-
-  &:active {
-    border-color: ${get('colors.border.muted')};
-  }
-
-  &[rel='prev'],
-  &[rel='next'] {
-    color: ${get('colors.accent.fg')};
-  }
-
-  &[aria-current],
-  &[aria-current]:hover {
-    color: ${get('colors.fg.onEmphasis')};
-    background-color: ${get('colors.accent.emphasis')};
-    border-color: transparent;
-  }
-
-  &[aria-disabled],
-  &[aria-disabled]:hover {
-    color: ${get('colors.primer.fg.disabled')}; // check
-    cursor: default;
-    border-color: transparent;
-  }
-
-  @supports (clip-path: polygon(50% 0, 100% 50%, 50% 100%)) {
-    &[rel='prev']::before,
-    &[rel='next']::after {
-      display: inline-block;
-      width: 16px;
-      height: 16px;
-      vertical-align: text-bottom;
-      content: '';
-      background-color: currentColor;
-    }
-
-    // chevron-left
-    &[rel='prev']::before {
-      margin-right: ${get('space.1')};
-      clip-path: polygon(
-        9.8px 12.8px,
-        8.7px 12.8px,
-        4.5px 8.5px,
-        4.5px 7.5px,
-        8.7px 3.2px,
-        9.8px 4.3px,
-        6.1px 8px,
-        9.8px 11.7px,
-        9.8px 12.8px
-      );
-    }
-
-    // chevron-right
-    &[rel='next']::after {
-      margin-left: ${get('space.1')};
-      clip-path: polygon(
-        6.2px 3.2px,
-        7.3px 3.2px,
-        11.5px 7.5px,
-        11.5px 8.5px,
-        7.3px 12.8px,
-        6.2px 11.7px,
-        9.9px 8px,
-        6.2px 4.3px,
-        6.2px 3.2px
-      );
-    }
-  }
-
-  ${COMMON};
-`
-
-type UsePaginationPagesParameters = {
-  theme?: Record<string, unknown> // set to theme type once /src/theme.js is converted
-  pageCount: number
-  currentPage: number
-  onPageChange: (e: React.MouseEvent, n: number) => void
-  hrefBuilder: (n: number) => string
-  marginPageCount: number
-  showPages?: boolean
-  surroundingPageCount: number
-}
-
-function usePaginationPages({
-  theme,
-  pageCount,
-  currentPage,
-  onPageChange,
-  hrefBuilder,
-  marginPageCount,
-  showPages,
-  surroundingPageCount
-}: UsePaginationPagesParameters) {
-  const pageChange = React.useCallback(n => (e: React.MouseEvent) => onPageChange(e, n), [onPageChange])
-
-  const model = React.useMemo(() => {
-    return buildPaginationModel(pageCount, currentPage, !!showPages, marginPageCount, surroundingPageCount)
-  }, [pageCount, currentPage, showPages, marginPageCount, surroundingPageCount])
-
-  const children = React.useMemo(() => {
-    return model.map(page => {
-      const {props, key, content} = buildComponentData(page, hrefBuilder, pageChange(page.num))
-      return (
-        <Page {...props} key={key} theme={theme}>
-          {content}
-        </Page>
-      )
-    })
-  }, [model, hrefBuilder, pageChange, theme])
-
-  return children
-}
-
-const PaginationContainer = styled.nav`
-  margin-top: 20px;
-  margin-bottom: 15px;
-  text-align: center;
-  ${sx};
-`
-
-export type PaginationProps = {
-  theme?: Record<string, unknown>
-  pageCount: number
-  currentPage: number
-  onPageChange?: (e: React.MouseEvent, n: number) => void
-  hrefBuilder?: (n: number) => string
-  marginPageCount: number
-  showPages?: boolean
-  surroundingPageCount?: number
-}
-
-function Pagination({
-  theme,
-  pageCount,
-  currentPage,
-  onPageChange = noop,
-  hrefBuilder = defaultHrefBuilder,
-  marginPageCount = 1,
-  showPages = true,
-  surroundingPageCount = 2,
-  ...rest
-}: PaginationProps) {
-  const pageElements = usePaginationPages({
-    theme,
-    pageCount,
-    currentPage,
-    onPageChange,
-    hrefBuilder,
-    marginPageCount,
-    showPages,
-    surroundingPageCount
-  })
-  return (
-    <PaginationContainer aria-label="Pagination" {...rest} theme={theme}>
-      <Box display="inline-block" theme={theme}>
-        {pageElements}
-      </Box>
-    </PaginationContainer>
-  )
-}
-
-function defaultHrefBuilder(pageNum: number) {
-  return `#${pageNum}`
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-function noop() {}
-
-Pagination.defaultProps = {
-  hrefBuilder: defaultHrefBuilder,
-  marginPageCount: 1,
-  onPageChange: noop,
-  showPages: true,
-  surroundingPageCount: 2
-}
-
-export default Pagination

package/src/Pagination/index.ts

@@ -1,4 +0,0 @@
-import Pagination from './Pagination'
-
-export type {PaginationProps} from './Pagination'
-export default Pagination

package/src/Pagination/model.tsx

@@ -1,187 +0,0 @@
-export function buildPaginationModel(
-  pageCount: number,
-  currentPage: number,
-  showPages: boolean,
-  marginPageCount: number,
-  surroundingPageCount: number
-) {
-  const pages = []
-
-  if (showPages) {
-    const pageNums: Array<number> = []
-    const addPage = (n: number) => {
-      if (n >= 1 && n <= pageCount) {
-        pageNums.push(n)
-      }
-    }
-
-    // Start by defining the window of pages to show around the current page.
-    // If the window goes off either edge, shift it until it fits.
-    let extentLeft = currentPage - surroundingPageCount
-    let extentRight = currentPage + surroundingPageCount
-    if (extentLeft < 1 && extentRight > pageCount) {
-      // Our window is larger than the entire range,
-      // so simply display every page.
-      extentLeft = 1
-      extentRight = pageCount
-    } else if (extentLeft < 1) {
-      while (extentLeft < 1) {
-        extentLeft++
-        extentRight++
-      }
-    } else if (extentRight > pageCount) {
-      while (extentRight > pageCount) {
-        extentLeft--
-        extentRight--
-      }
-    }
-
-    // Next, include the pages in the margins.
-    // If a margin page is already covered in the window,
-    // extend the window to the other direction.
-    for (let i = 1; i <= marginPageCount; i++) {
-      const leftPage = i
-      const rightPage = pageCount - (i - 1)
-      if (leftPage >= extentLeft) {
-        extentRight++
-      } else {
-        addPage(leftPage)
-      }
-      if (rightPage <= extentRight) {
-        extentLeft--
-      } else {
-        addPage(rightPage)
-      }
-    }
-
-    for (let i = extentLeft; i <= extentRight; i++) {
-      addPage(i)
-    }
-
-    const sorted = pageNums
-      .slice()
-      .sort((a, b) => a - b)
-      .filter((item, idx, ary) => !idx || item !== ary[idx - 1])
-    for (let idx = 0; idx < sorted.length; idx++) {
-      const num = sorted[idx]
-      const selected = num === currentPage
-      if (idx === 0) {
-        if (num !== 1) {
-          // If the first page isn't page one,
-          // we need to add a break
-          pages.push({
-            type: 'BREAK',
-            num: 1
-          })
-        }
-        pages.push({
-          type: 'NUM',
-          num,
-          selected
-        })
-      } else {
-        const last = sorted[idx - 1]
-        const delta = num - last
-        if (delta === 1) {
-          pages.push({
-            type: 'NUM',
-            num,
-            selected
-          })
-        } else {
-          // We skipped some, so add a break
-          pages.push({
-            type: 'BREAK',
-            num: num - 1
-          })
-          pages.push({
-            type: 'NUM',
-            num,
-            selected
-          })
-        }
-      }
-    }
-
-    const lastPage = pages[pages.length - 1]
-    if (lastPage.type === 'NUM' && lastPage.num !== pageCount) {
-      // The last page we rendered wasn't the actual last page,
-      // so we need an additional break
-      pages.push({
-        type: 'BREAK',
-        num: pageCount
-      })
-    }
-  }
-
-  const prev = {type: 'PREV', num: currentPage - 1, disabled: currentPage === 1}
-  const next = {type: 'NEXT', num: currentPage + 1, disabled: currentPage === pageCount}
-  return [prev, ...pages, next]
-}
-
-type PageType = {
-  type: string
-  num: number
-  disabled?: boolean
-  selected?: boolean
-}
-
-export function buildComponentData(
-  page: PageType,
-  hrefBuilder: (n: number) => string,
-  onClick: (e: React.MouseEvent) => void
-) {
-  const props = {}
-  let content = ''
-  let key = ''
-
-  switch (page.type) {
-    case 'PREV': {
-      key = 'page-prev'
-      content = 'Previous'
-      if (page.disabled) {
-        Object.assign(props, {as: 'span', 'aria-disabled': 'true'})
-      } else {
-        Object.assign(props, {
-          rel: 'prev',
-          href: hrefBuilder(page.num),
-          'aria-label': 'Previous Page',
-          onClick
-        })
-      }
-      break
-    }
-    case 'NEXT': {
-      key = 'page-next'
-      content = 'Next'
-      if (page.disabled) {
-        Object.assign(props, {as: 'span', 'aria-disabled': 'true'})
-      } else {
-        Object.assign(props, {
-          rel: 'next',
-          href: hrefBuilder(page.num),
-          'aria-label': 'Next Page',
-          onClick
-        })
-      }
-      break
-    }
-    case 'NUM': {
-      key = `page-${page.num}`
-      content = String(page.num)
-      if (page.selected) {
-        Object.assign(props, {as: 'em', 'aria-current': 'page'})
-      } else {
-        Object.assign(props, {href: hrefBuilder(page.num), 'aria-label': `Page ${page.num}`, onClick})
-      }
-      break
-    }
-    case 'BREAK': {
-      key = `page-${page.num}-break`
-      content = '…'
-      Object.assign(props, {as: 'span', 'aria-disabled': true})
-    }
-  }
-
-  return {props, key, content}
-}

package/src/PointerBox.tsx

@@ -1,31 +0,0 @@
-import React from 'react'
-import BorderBox, {BorderBoxProps} from './BorderBox'
-import Caret, {CaretProps} from './Caret'
-
-export type PointerBoxProps = {
-  caret?: CaretProps['location']
-  bg?: CaretProps['bg']
-  borderColor?: CaretProps['borderColor']
-  border?: CaretProps['borderWidth']
-} & BorderBoxProps
-
-function PointerBox(props: PointerBoxProps) {
-  // don't destructure these, just grab them
-  const {bg, border, borderColor, theme} = props
-  const {caret, children, ...boxProps} = props
-  const caretProps = {
-    bg,
-    borderColor,
-    borderWidth: border,
-    location: caret,
-    theme
-  }
-  return (
-    <BorderBox sx={{position: 'relative'}} {...boxProps}>
-      {children}
-      <Caret {...caretProps} />
-    </BorderBox>
-  )
-}
-
-export default PointerBox