@primer/components 31.2.0-rc.fbb10090 → 31.2.0

package/lib/Pagination/Pagination.jsx

@@ -0,0 +1,163 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const styled_components_1 = __importDefault(require("styled-components"));
+const Box_1 = __importDefault(require("../Box"));
+const constants_1 = require("../constants");
+const sx_1 = __importDefault(require("../sx"));
+const model_1 = require("./model");
+const Page = styled_components_1.default.a `
+  display: inline-block;
+  min-width: 32px;
+  padding: 5px 10px;
+  font-style: normal;
+  line-height: 20px;
+  color: ${constants_1.get('colors.fg.default')};
+  text-align: center;
+  white-space: nowrap;
+  vertical-align: middle;
+  cursor: pointer;
+  user-select: none;
+  text-decoration: none;
+
+  margin-right: ${constants_1.get('space.1')};
+
+  &:last-child {
+    margin-right: 0;
+  }
+
+  border: ${constants_1.get('borderWidths.1')} solid transparent;
+  border-radius: ${constants_1.get('radii.2')};
+  transition: border-color 0.2s cubic-bezier(0.3, 0, 0.5, 1);
+
+  &:hover,
+  &:focus {
+    text-decoration: none;
+    border-color: ${constants_1.get('colors.border.default')};
+    outline: 0;
+    transition-duration: 0.1s;
+  }
+
+  &:active {
+    border-color: ${constants_1.get('colors.border.muted')};
+  }
+
+  &[rel='prev'],
+  &[rel='next'] {
+    color: ${constants_1.get('colors.accent.fg')};
+  }
+
+  &[aria-current],
+  &[aria-current]:hover {
+    color: ${constants_1.get('colors.fg.onEmphasis')};
+    background-color: ${constants_1.get('colors.accent.emphasis')};
+    border-color: transparent;
+  }
+
+  &[aria-disabled],
+  &[aria-disabled]:hover {
+    color: ${constants_1.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: ${constants_1.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: ${constants_1.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
+      );
+    }
+  }
+
+  ${constants_1.COMMON};
+`;
+function usePaginationPages({ theme, pageCount, currentPage, onPageChange, hrefBuilder, marginPageCount, showPages, surroundingPageCount }) {
+    const pageChange = react_1.default.useCallback(n => (e) => onPageChange(e, n), [onPageChange]);
+    const model = react_1.default.useMemo(() => {
+        return model_1.buildPaginationModel(pageCount, currentPage, !!showPages, marginPageCount, surroundingPageCount);
+    }, [pageCount, currentPage, showPages, marginPageCount, surroundingPageCount]);
+    const children = react_1.default.useMemo(() => {
+        return model.map(page => {
+            const { props, key, content } = model_1.buildComponentData(page, hrefBuilder, pageChange(page.num));
+            return (<Page {...props} key={key} theme={theme}>
+          {content}
+        </Page>);
+        });
+    }, [model, hrefBuilder, pageChange, theme]);
+    return children;
+}
+const PaginationContainer = styled_components_1.default.nav `
+  margin-top: 20px;
+  margin-bottom: 15px;
+  text-align: center;
+  ${sx_1.default};
+`;
+function Pagination({ theme, pageCount, currentPage, onPageChange = noop, hrefBuilder = defaultHrefBuilder, marginPageCount = 1, showPages = true, surroundingPageCount = 2, ...rest }) {
+    const pageElements = usePaginationPages({
+        theme,
+        pageCount,
+        currentPage,
+        onPageChange,
+        hrefBuilder,
+        marginPageCount,
+        showPages,
+        surroundingPageCount
+    });
+    return (<PaginationContainer aria-label="Pagination" {...rest} theme={theme}>
+      <Box_1.default display="inline-block" theme={theme}>
+        {pageElements}
+      </Box_1.default>
+    </PaginationContainer>);
+}
+function defaultHrefBuilder(pageNum) {
+    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
+};
+exports.default = Pagination;

package/lib/Pagination/index.js

@@ -1,13 +1,7 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _Pagination = _interopRequireDefault(require("./Pagination"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-var _default = _Pagination.default;
-exports.default = _default;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Pagination_1 = __importDefault(require("./Pagination"));
+exports.default = Pagination_1.default;

package/lib/Pagination/model.jsx

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildComponentData = exports.buildPaginationModel = void 0;
+function buildPaginationModel(pageCount, currentPage, showPages, marginPageCount, surroundingPageCount) {
+    const pages = [];
+    if (showPages) {
+        const pageNums = [];
+        const addPage = (n) => {
+            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];
+}
+exports.buildPaginationModel = buildPaginationModel;
+function buildComponentData(page, hrefBuilder, onClick) {
+    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 };
+}
+exports.buildComponentData = buildComponentData;

package/lib/PointerBox.jsx

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const BorderBox_1 = __importDefault(require("./BorderBox"));
+const Caret_1 = __importDefault(require("./Caret"));
+function PointerBox(props) {
+    // 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_1.default sx={{ position: 'relative' }} {...boxProps}>
+      {children}
+      <Caret_1.default {...caretProps}/>
+    </BorderBox_1.default>);
+}
+exports.default = PointerBox;

package/{src/Popover.tsx → lib/Popover.jsx}

@@ -1,60 +1,39 @@
-import classnames from 'classnames'
-import styled from 'styled-components'
-import Box from './Box'
-import {COMMON, get, LAYOUT, POSITION, SystemCommonProps, SystemLayoutProps, SystemPositionProps} from './constants'
-import sx, {SxProp} from './sx'
-import {ComponentProps} from './utils/types'
-
-type CaretPosition =
-  | 'top'
-  | 'bottom'
-  | 'left'
-  | 'right'
-  | 'bottom-left'
-  | 'bottom-right'
-  | 'top-left'
-  | 'top-right'
-  | 'left-bottom'
-  | 'left-top'
-  | 'right-bottom'
-  | 'right-top'
-
-type StyledPopoverProps = {
-  caret?: CaretPosition
-  relative?: boolean
-  open?: boolean
-} & SystemCommonProps &
-  SystemLayoutProps &
-  SystemPositionProps &
-  SxProp
-
-const Popover = styled.div.attrs<StyledPopoverProps>(({className, caret}) => {
-  return {
-    className: classnames(className, `caret-pos--${caret}`)
-  }
-})<StyledPopoverProps>`
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const classnames_1 = __importDefault(require("classnames"));
+const styled_components_1 = __importDefault(require("styled-components"));
+const Box_1 = __importDefault(require("./Box"));
+const constants_1 = require("./constants");
+const sx_1 = __importDefault(require("./sx"));
+const Popover = styled_components_1.default.div.attrs(({ className, caret }) => {
+    return {
+        className: classnames_1.default(className, `caret-pos--${caret}`)
+    };
+}) `
   position: ${props => (props.relative ? 'relative' : 'absolute')};
   z-index: 100;
   display: ${props => (props.open ? 'block' : 'none')};
 
-  ${COMMON};
-  ${LAYOUT};
-  ${POSITION};
-  ${sx};
-`
-
-const PopoverContent = styled(Box)`
-  border: 1px solid ${get('colors.border.default')};
-  border-radius: ${get('radii.2')};
+  ${constants_1.COMMON};
+  ${constants_1.LAYOUT};
+  ${constants_1.POSITION};
+  ${sx_1.default};
+`;
+const PopoverContent = styled_components_1.default(Box_1.default) `
+  border: 1px solid ${constants_1.get('colors.border.default')};
+  border-radius: ${constants_1.get('radii.2')};
   position: relative;
   width: 232px;
   margin-right: auto;
   margin-left: auto;
-  padding: ${get('space.4')};
-  background-color: ${get('colors.canvas.overlay')};
+  padding: ${constants_1.get('space.4')};
+  background-color: ${constants_1.get('colors.canvas.overlay')};
 
-  ${COMMON};
-  ${LAYOUT};
+  ${constants_1.COMMON};
+  ${constants_1.LAYOUT};
 
   // Carets
   &::before,
@@ -66,17 +45,17 @@ const PopoverContent = styled(Box)`
   }
 
   &::before {
-    top: -${get('space.3')};
+    top: -${constants_1.get('space.3')};
     margin-left: -9px;
-    border: ${get('space.2')} solid transparent; // TODO: solid?
-    border-bottom-color: ${get('colors.border.default')};
+    border: ${constants_1.get('space.2')} solid transparent; // TODO: solid?
+    border-bottom-color: ${constants_1.get('colors.border.default')};
   }
 
   &::after {
     top: -14px;
-    margin-left: -${get('space.2')};
+    margin-left: -${constants_1.get('space.2')};
     border: 7px solid transparent; // todo: solid
-    border-bottom-color: ${get('colors.canvas.overlay')};
+    border-bottom-color: ${constants_1.get('colors.canvas.overlay')};
   }
 
   // Bottom-oriented carets
@@ -90,14 +69,14 @@ const PopoverContent = styled(Box)`
     }
 
     &::before {
-      bottom: -${get('space.3')};
-      border-top-color: ${get('colors.border.default')};
+      bottom: -${constants_1.get('space.3')};
+      border-top-color: ${constants_1.get('colors.border.default')};
     }
 
     &::after {
       bottom: -14px;
       // stylelint-disable-next-line primer/borders
-      border-top-color: ${get('colors.canvas.overlay')};
+      border-top-color: ${constants_1.get('colors.canvas.overlay')};
     }
   }
 
@@ -130,12 +109,12 @@ const PopoverContent = styled(Box)`
 
     &::before,
     &::after {
-      left: ${get('space.4')};
+      left: ${constants_1.get('space.4')};
       margin-left: 0;
     }
 
     &::after {
-      left: calc(${get('space.4')} + 1px);
+      left: calc(${constants_1.get('space.4')} + 1px);
     }
   }
 
@@ -156,11 +135,11 @@ const PopoverContent = styled(Box)`
 
     &::before {
       // stylelint-disable-next-line primer/spacing
-      margin-top: calc((${get('space.2')} + 1px) * -1);
+      margin-top: calc((${constants_1.get('space.2')} + 1px) * -1);
     }
 
     &::after {
-      margin-top: -${get('space.2')};
+      margin-top: -${constants_1.get('space.2')};
     }
   }
 
@@ -169,14 +148,14 @@ const PopoverContent = styled(Box)`
   ${Popover}.caret-pos--right-top & ,
   ${Popover}.caret-pos--right-bottom & {
     &::before {
-      right: -${get('space.3')};
-      border-left-color: ${get('colors.border.default')};
+      right: -${constants_1.get('space.3')};
+      border-left-color: ${constants_1.get('colors.border.default')};
     }
 
     &::after {
       right: -14px;
       // stylelint-disable-next-line primer/borders
-      border-left-color: ${get('colors.canvas.overlay')};
+      border-left-color: ${constants_1.get('colors.canvas.overlay')};
     }
   }
 
@@ -185,14 +164,14 @@ const PopoverContent = styled(Box)`
   ${Popover}.caret-pos--left-top & ,
   ${Popover}.caret-pos--left-bottom & {
     &::before {
-      left: -${get('space.3')};
-      border-right-color: ${get('colors.border.default')};
+      left: -${constants_1.get('space.3')};
+      border-right-color: ${constants_1.get('colors.border.default')};
     }
 
     &::after {
       left: -14px;
       // stylelint-disable-next-line primer/borders
-      border-right-color: ${get('colors.canvas.overlay')};
+      border-right-color: ${constants_1.get('colors.canvas.overlay')};
     }
   }
 
@@ -201,7 +180,7 @@ const PopoverContent = styled(Box)`
   ${Popover}.caret-pos--left-top & {
     &::before,
     &::after {
-      top: ${get('space.4')};
+      top: ${constants_1.get('space.4')};
     }
   }
 
@@ -214,23 +193,18 @@ const PopoverContent = styled(Box)`
     }
 
     &::before {
-      bottom: ${get('space.3')};
+      bottom: ${constants_1.get('space.3')};
     }
 
     &::after {
-      bottom: calc(${get('space.3')} + 1px);
+      bottom: calc(${constants_1.get('space.3')} + 1px);
     }
   }
 
-  ${sx};
-`
-
+  ${sx_1.default};
+`;
 Popover.defaultProps = {
-  caret: 'top'
-}
-
-PopoverContent.displayName = 'Popover.Content'
-
-export type PopoverProps = ComponentProps<typeof Popover>
-export type PopoverContentProps = ComponentProps<typeof PopoverContent>
-export default Object.assign(Popover, {Content: PopoverContent})
+    caret: 'top'
+};
+PopoverContent.displayName = 'Popover.Content';
+exports.default = Object.assign(Popover, { Content: PopoverContent });

package/lib/Portal/Portal.js

@@ -10,6 +10,8 @@ var _react = _interopRequireDefault(require("react"));
 
 var _reactDom = require("react-dom");
 
+var _useIsomorphicLayoutEffect = _interopRequireDefault(require("../utils/useIsomorphicLayoutEffect"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const PRIMER_PORTAL_ROOT_ID = '__primerPortalRoot__';
@@ -72,7 +74,7 @@ const Portal = ({
 
   const elementRef = _react.default.useRef(hostElement);
 
-  _react.default.useLayoutEffect(() => {
+  (0, _useIsomorphicLayoutEffect.default)(() => {
     let containerName = _containerName;
 
     if (containerName === undefined) {
@@ -93,7 +95,6 @@ const Portal = ({
       parentElement.removeChild(element);
     }; // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [elementRef]);
-
   return /*#__PURE__*/(0, _reactDom.createPortal)(children, elementRef.current);
 };