@primer/components 31.2.0-rc.c53cfd9e → 31.2.0

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

package/src/Portal/Portal.tsx

@@ -1,97 +0,0 @@
-import React from 'react'
-import {createPortal} from 'react-dom'
-import useLayoutEffect from '../utils/useIsomorphicLayoutEffect'
-
-const PRIMER_PORTAL_ROOT_ID = '__primerPortalRoot__'
-const DEFAULT_PORTAL_CONTAINER_NAME = '__default__'
-
-const portalRootRegistry: Partial<Record<string, Element>> = {}
-
-/**
- * Register a container to serve as a portal root.
- * @param root The element that will be the root for portals created in this container
- * @param name The name of the container, to be used with the `containerName` prop on the Portal Component.
- * If name is not specified, registers the default portal root.
- */
-export function registerPortalRoot(root: Element, name = DEFAULT_PORTAL_CONTAINER_NAME): void {
-  portalRootRegistry[name] = root
-}
-
-// Ensures that a default portal root exists and is registered. If a DOM element exists
-// with id __primerPortalRoot__, allow that element to serve as the default portal root.
-// Otherwise, create that element and attach it to the end of document.body.
-function ensureDefaultPortal() {
-  const existingDefaultPortalContainer = portalRootRegistry[DEFAULT_PORTAL_CONTAINER_NAME]
-  if (!existingDefaultPortalContainer || !document.body.contains(existingDefaultPortalContainer)) {
-    let defaultPortalContainer = document.getElementById(PRIMER_PORTAL_ROOT_ID)
-    if (!(defaultPortalContainer instanceof Element)) {
-      defaultPortalContainer = document.createElement('div')
-      defaultPortalContainer.setAttribute('id', PRIMER_PORTAL_ROOT_ID)
-      defaultPortalContainer.style.position = 'absolute'
-      defaultPortalContainer.style.top = '0'
-      defaultPortalContainer.style.left = '0'
-      const suitablePortalRoot = document.querySelector('[data-portal-root]')
-      if (suitablePortalRoot) {
-        suitablePortalRoot.appendChild(defaultPortalContainer)
-      } else {
-        document.body.appendChild(defaultPortalContainer)
-      }
-    }
-
-    registerPortalRoot(defaultPortalContainer)
-  }
-}
-
-export interface PortalProps {
-  /**
-   * Called when this portal is added to the DOM
-   */
-  onMount?: () => void
-
-  /**
-   * Optional. Mount this portal at the container specified
-   * by this name. The container must be previously registered
-   * with `registerPortal`.
-   */
-  containerName?: string
-}
-
-/**
- * Creates a React Portal, placing all children in a separate physical DOM root node.
- * @see https://reactjs.org/docs/portals.html
- */
-export const Portal: React.FC<PortalProps> = ({children, onMount, containerName: _containerName}) => {
-  const hostElement = document.createElement('div')
-
-  // Portaled content should get their own stacking context so they don't interfere
-  // with each other in unexpected ways. One should never find themselves tempted
-  // to change the zIndex to a value other than "1".
-  hostElement.style.position = 'relative'
-  hostElement.style.zIndex = '1'
-  const elementRef = React.useRef(hostElement)
-
-  useLayoutEffect(() => {
-    let containerName = _containerName
-    if (containerName === undefined) {
-      containerName = DEFAULT_PORTAL_CONTAINER_NAME
-      ensureDefaultPortal()
-    }
-    const parentElement = portalRootRegistry[containerName]
-
-    if (!parentElement) {
-      throw new Error(
-        `Portal container '${_containerName}' is not yet registered. Container must be registered with registerPortal before use.`
-      )
-    }
-    const element = elementRef.current
-    parentElement.appendChild(element)
-    onMount?.()
-
-    return () => {
-      parentElement.removeChild(element)
-    }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [elementRef])
-
-  return createPortal(children, elementRef.current)
-}

package/src/Portal/index.ts

@@ -1,5 +0,0 @@
-import {Portal, PortalProps, registerPortalRoot} from './Portal'
-
-export default Portal
-export {registerPortalRoot}
-export type {PortalProps}

package/src/Position.tsx

@@ -1,63 +0,0 @@
-import React from 'react'
-import styled from 'styled-components'
-import Box from './Box'
-import {ComponentProps} from './utils/types'
-
-type StyledPositionProps = {as?: React.ElementType}
-
-/**
- * @deprecated Use the Box component instead (i.e. <Position> → <Box>)
- */
-const Position = styled(Box)<StyledPositionProps>``
-
-export type PositionProps = ComponentProps<typeof Position>
-
-/**
- * @deprecated Use the Box component instead (i.e. <Absolute> → <Box position="absolute">)
- */
-export default Position
-
-// Absolute
-export type AbsoluteProps = Omit<PositionProps, 'position'>
-
-/**
- * @deprecated Use the Box component instead (i.e. <Absolute> → <Box position="absolute">)
- */
-export const Absolute = React.forwardRef((props: AbsoluteProps, ref) => {
-  return <Position {...props} position="absolute" ref={ref} />
-})
-Absolute.displayName = 'Absolute'
-
-// Fixed
-export type FixedProps = Omit<PositionProps, 'position'>
-
-/**
- * @deprecated Use the Box component instead (i.e. <Fixed> → <Box position="fixed">)
- */
-export const Fixed = React.forwardRef((props: AbsoluteProps, ref) => {
-  return <Position {...props} position="fixed" ref={ref} />
-})
-Fixed.displayName = 'Fixed'
-
-// Relative
-export type RelativeProps = Omit<PositionProps, 'position'>
-
-/**
- * @deprecated Use the Box component instead (i.e. <Relative> → <Box position="relative">)
- */
-export const Relative = React.forwardRef((props: RelativeProps, ref) => {
-  return <Position {...props} position="relative" ref={ref} />
-})
-Relative.displayName = 'Relative'
-
-// Sticky
-export type StickyProps = Omit<PositionProps, 'position'>
-
-/**
- * @deprecated Use the Box component instead (i.e. <Sticky> → <Box position="sticky">)
- */
-export const Sticky = React.forwardRef((props: StickyProps, ref) => {
-  return <Position {...props} position="sticky" ref={ref} />
-})
-Sticky.defaultProps = {top: 0, zIndex: 1}
-Sticky.displayName = 'Sticky'

package/src/ProgressBar.tsx

@@ -1,52 +0,0 @@
-import React from 'react'
-import styled from 'styled-components'
-import {width, WidthProps} from 'styled-system'
-import {COMMON, get, SystemCommonProps} from './constants'
-import sx, {SxProp} from './sx'
-import {ComponentProps} from './utils/types'
-
-const Bar = styled.span<{progress?: string | number} & SystemCommonProps>`
-  width: ${props => (props.progress ? `${props.progress}%` : 0)};
-  ${COMMON}
-`
-
-const sizeMap = {
-  small: '5px',
-  large: '10px',
-  default: '8px'
-}
-
-type StyledProgressContainerProps = {
-  inline?: boolean
-  barSize?: keyof typeof sizeMap
-} & WidthProps &
-  SystemCommonProps &
-  SxProp
-
-const ProgressContainer = styled.span<StyledProgressContainerProps>`
-  display: ${props => (props.inline ? 'inline-flex' : 'flex')};
-  overflow: hidden;
-  background-color: ${get('colors.border.default')};
-  border-radius: ${get('radii.1')};
-  height: ${props => sizeMap[props.barSize || 'default']};
-  ${COMMON}
-  ${width}
-  ${sx};
-`
-
-export type ProgressBarProps = ComponentProps<typeof ProgressContainer> & ComponentProps<typeof Bar>
-
-function ProgressBar({progress, bg, theme, ...rest}: ProgressBarProps) {
-  return (
-    <ProgressContainer theme={theme} {...rest}>
-      <Bar progress={progress} bg={bg} theme={theme} />
-    </ProgressContainer>
-  )
-}
-
-ProgressBar.defaultProps = {
-  bg: 'success.emphasis',
-  barSize: 'default'
-}
-
-export default ProgressBar