@primer/components 31.2.0-rc.c53cfd9e → 31.2.0

package/lib/Dialog/ConfirmationDialog.jsx

@@ -0,0 +1,146 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useConfirm = exports.ConfirmationDialog = void 0;
+const react_1 = __importStar(require("react"));
+const react_dom_1 = __importDefault(require("react-dom"));
+const styled_components_1 = __importDefault(require("styled-components"));
+const Box_1 = __importDefault(require("../Box"));
+const ThemeProvider_1 = require("../ThemeProvider");
+const focusZone_1 = require("../behaviors/focusZone");
+const constants_1 = require("../constants");
+const Dialog_1 = require("../Dialog/Dialog");
+const useFocusZone_1 = require("../hooks/useFocusZone");
+const StyledConfirmationHeader = styled_components_1.default.header `
+  padding: ${constants_1.get('space.2')};
+  display: flex;
+  flex-direction: row;
+`;
+const StyledTitle = styled_components_1.default(Box_1.default) `
+  font-size: ${constants_1.get('fontSizes.3')};
+  font-weight: ${constants_1.get('fontWeights.bold')};
+  padding: 6px ${constants_1.get('space.2')};
+  flex-grow: 1;
+`;
+const ConfirmationHeader = ({ title, onClose, dialogLabelId }) => {
+    const onCloseClick = react_1.useCallback(() => {
+        onClose('close-button');
+    }, [onClose]);
+    return (<StyledConfirmationHeader>
+      <StyledTitle id={dialogLabelId}>{title}</StyledTitle>
+      <Dialog_1.Dialog.CloseButton onClose={onCloseClick}/>
+    </StyledConfirmationHeader>);
+};
+const StyledConfirmationBody = styled_components_1.default(Box_1.default) `
+  font-size: ${constants_1.get('fontSizes.1')};
+  padding: 0 ${constants_1.get('space.3')} ${constants_1.get('space.3')} ${constants_1.get('space.3')};
+  color: ${constants_1.get('colors.fg.muted')};
+  flex-grow: 1;
+`;
+const ConfirmationBody = ({ children }) => {
+    return <StyledConfirmationBody>{children}</StyledConfirmationBody>;
+};
+const StyledConfirmationFooter = styled_components_1.default(Box_1.default) `
+  display: grid;
+  grid-auto-flow: column;
+  grid-auto-columns: max-content;
+  grid-gap: ${constants_1.get('space.2')};
+  align-items: end;
+  justify-content: end;
+  padding: ${constants_1.get('space.1')} ${constants_1.get('space.3')} ${constants_1.get('space.3')};
+`;
+const ConfirmationFooter = ({ footerButtons }) => {
+    const { containerRef: footerRef } = useFocusZone_1.useFocusZone({
+        bindKeys: focusZone_1.FocusKeys.ArrowHorizontal | focusZone_1.FocusKeys.Tab,
+        focusInStrategy: 'closest'
+    });
+    // Must have exactly 2 buttons!
+    return (<StyledConfirmationFooter ref={footerRef}>
+      <Dialog_1.Dialog.Buttons buttons={footerButtons ?? []}/>
+    </StyledConfirmationFooter>);
+};
+/**
+ * A ConfirmationDialog is a special kind of dialog with more rigid behavior. It
+ * is used to confirm a user action. ConfirmationDialogs always have exactly
+ * two buttons: one to cancel the action and one to confirm it. No custom
+ * rendering capabilities are provided for ConfirmationDialog.
+ */
+const ConfirmationDialog = props => {
+    const { onClose, title, cancelButtonContent = 'Cancel', confirmButtonContent = 'OK', confirmButtonType = 'normal', children } = props;
+    const onCancelButtonClick = react_1.useCallback(() => {
+        onClose('cancel');
+    }, [onClose]);
+    const onConfirmButtonClick = react_1.useCallback(() => {
+        onClose('confirm');
+    }, [onClose]);
+    const cancelButton = {
+        content: cancelButtonContent,
+        onClick: onCancelButtonClick
+    };
+    const confirmButton = {
+        content: confirmButtonContent,
+        buttonType: confirmButtonType,
+        onClick: onConfirmButtonClick,
+        autoFocus: true
+    };
+    const footerButtons = [cancelButton, confirmButton];
+    return (<Dialog_1.Dialog onClose={onClose} title={title} footerButtons={footerButtons} role="alertdialog" width="medium" renderHeader={ConfirmationHeader} renderBody={ConfirmationBody} renderFooter={ConfirmationFooter}>
+      {children}
+    </Dialog_1.Dialog>);
+};
+exports.ConfirmationDialog = ConfirmationDialog;
+async function confirm(themeProps, options) {
+    const { content, ...confirmationDialogProps } = options;
+    return new Promise(resolve => {
+        const hostElement = document.createElement('div');
+        const onClose = gesture => {
+            react_dom_1.default.unmountComponentAtNode(hostElement);
+            if (gesture === 'confirm') {
+                resolve(true);
+            }
+            else {
+                resolve(false);
+            }
+        };
+        react_dom_1.default.render(<ThemeProvider_1.ThemeProvider {...themeProps}>
+        <exports.ConfirmationDialog {...confirmationDialogProps} onClose={onClose}>
+          {content}
+        </exports.ConfirmationDialog>
+      </ThemeProvider_1.ThemeProvider>, hostElement);
+    });
+}
+/**
+ * This hook takes no parameters and returns an `async` function, `confirm`. When `confirm`
+ * is called, it shows the confirmation dialog. When the dialog is dismissed, a promise is
+ * resolved with `true` or `false` depending on whether or not the confirm button was used.
+ */
+function useConfirm() {
+    const { theme, colorMode, dayScheme, nightScheme } = ThemeProvider_1.useTheme();
+    const result = react_1.useCallback((options) => {
+        const themeProps = { theme, colorMode, dayScheme, nightScheme };
+        return confirm(themeProps, options);
+    }, [theme, colorMode, dayScheme, nightScheme]);
+    return result;
+}
+exports.useConfirm = useConfirm;

package/lib/Dialog/Dialog.js

@@ -248,6 +248,7 @@ const Buttons = ({
     return /*#__PURE__*/_react.default.createElement(ButtonElement, _extends({
       key: index
     }, buttonProps, {
+      variant: buttonType,
       ref: autoFocus && autoFocusCount === 0 ? (autoFocusCount++, autoFocusRef) : null
     }), content);
   }));

package/lib/Dialog/Dialog.jsx

@@ -0,0 +1,273 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dialog = void 0;
+const react_1 = __importStar(require("react"));
+const styled_components_1 = __importDefault(require("styled-components"));
+const Button_1 = __importStar(require("../Button"));
+const Box_1 = __importDefault(require("../Box"));
+const constants_1 = require("../constants");
+const hooks_1 = require("../hooks");
+const useFocusTrap_1 = require("../hooks/useFocusTrap");
+const sx_1 = __importDefault(require("../sx"));
+const StyledOcticon_1 = __importDefault(require("../StyledOcticon"));
+const octicons_react_1 = require("@primer/octicons-react");
+const useFocusZone_1 = require("../hooks/useFocusZone");
+const focusZone_1 = require("../behaviors/focusZone");
+const Portal_1 = __importDefault(require("../Portal"));
+const useCombinedRefs_1 = require("../hooks/useCombinedRefs");
+const ssr_1 = require("@react-aria/ssr");
+const ANIMATION_DURATION = '200ms';
+const Backdrop = styled_components_1.default('div') `
+  position: fixed;
+  top: 0;
+  left: 0;
+  bottom: 0;
+  right: 0;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  background-color: rgba(0, 0, 0, 0.4);
+  animation: dialog-backdrop-appear ${ANIMATION_DURATION} ${constants_1.get('animation.easeOutCubic')};
+
+  @keyframes dialog-backdrop-appear {
+    0% {
+      opacity: 0;
+    }
+    100% {
+      opacity: 1;
+    }
+  }
+`;
+const heightMap = {
+    small: '480px',
+    large: '640px',
+    auto: 'auto'
+};
+const widthMap = {
+    small: '296px',
+    medium: '320px',
+    large: '480px',
+    xlarge: '640px'
+};
+const StyledDialog = styled_components_1.default.div `
+  display: flex;
+  flex-direction: column;
+  background-color: ${constants_1.get('colors.canvas.overlay')};
+  box-shadow: ${constants_1.get('shadows.overlay.shadow')};
+  min-width: 296px;
+  max-width: calc(100vw - 64px);
+  max-height: calc(100vh - 64px);
+  width: ${props => widthMap[props.width ?? 'xlarge']};
+  height: ${props => heightMap[props.height ?? 'auto']};
+  border-radius: 12px;
+  opacity: 1;
+  animation: overlay--dialog-appear ${ANIMATION_DURATION} ${constants_1.get('animation.easeOutCubic')};
+
+  @keyframes overlay--dialog-appear {
+    0% {
+      opacity: 0;
+      transform: scale(0.5);
+    }
+    100% {
+      opacity: 1;
+      transform: scale(1);
+    }
+  }
+
+  ${constants_1.COMMON};
+  ${constants_1.POSITION};
+  ${sx_1.default};
+`;
+const DefaultHeader = ({ dialogLabelId, title, subtitle, dialogDescriptionId, onClose }) => {
+    const onCloseClick = react_1.useCallback(() => {
+        onClose('close-button');
+    }, [onClose]);
+    return (<exports.Dialog.Header>
+      <Box_1.default display="flex">
+        <Box_1.default display="flex" px={2} py="6px" flexDirection="column" flexGrow={1}>
+          <exports.Dialog.Title id={dialogLabelId}>{title ?? 'Dialog'}</exports.Dialog.Title>
+          {subtitle && <exports.Dialog.Subtitle id={dialogDescriptionId}>{subtitle}</exports.Dialog.Subtitle>}
+        </Box_1.default>
+        <exports.Dialog.CloseButton onClose={onCloseClick}/>
+      </Box_1.default>
+    </exports.Dialog.Header>);
+};
+const DefaultBody = ({ children }) => {
+    return <exports.Dialog.Body>{children}</exports.Dialog.Body>;
+};
+const DefaultFooter = ({ footerButtons }) => {
+    const { containerRef: footerRef } = useFocusZone_1.useFocusZone({
+        bindKeys: focusZone_1.FocusKeys.ArrowHorizontal | focusZone_1.FocusKeys.Tab,
+        focusInStrategy: 'closest'
+    });
+    return footerButtons ? (<exports.Dialog.Footer ref={footerRef}>
+      <exports.Dialog.Buttons buttons={footerButtons}/>
+    </exports.Dialog.Footer>) : null;
+};
+const _Dialog = react_1.default.forwardRef((props, forwardedRef) => {
+    const { title = 'Dialog', subtitle = '', renderHeader, renderBody, renderFooter, onClose, role = 'dialog', width = 'xlarge', height = 'auto', footerButtons = [] } = props;
+    const dialogLabelId = ssr_1.useSSRSafeId();
+    const dialogDescriptionId = ssr_1.useSSRSafeId();
+    const autoFocusedFooterButtonRef = react_1.useRef(null);
+    for (const footerButton of footerButtons) {
+        if (footerButton.autoFocus) {
+            footerButton.ref = autoFocusedFooterButtonRef;
+        }
+    }
+    const defaultedProps = { ...props, title, subtitle, role, dialogLabelId, dialogDescriptionId };
+    const dialogRef = react_1.useRef(null);
+    const combinedRef = useCombinedRefs_1.useCombinedRefs(dialogRef, forwardedRef);
+    const backdropRef = react_1.useRef(null);
+    useFocusTrap_1.useFocusTrap({ containerRef: dialogRef, restoreFocusOnCleanUp: true, initialFocusRef: autoFocusedFooterButtonRef });
+    hooks_1.useOnEscapePress((event) => {
+        onClose('escape');
+        event.preventDefault();
+    }, [onClose]);
+    const header = (renderHeader ?? DefaultHeader)(defaultedProps);
+    const body = (renderBody ?? DefaultBody)(defaultedProps);
+    const footer = (renderFooter ?? DefaultFooter)(defaultedProps);
+    return (<>
+      <Portal_1.default>
+        <Backdrop ref={backdropRef}>
+          <StyledDialog width={width} height={height} ref={combinedRef} role={role} aria-labelledby={dialogLabelId} aria-describedby={dialogDescriptionId}>
+            {header}
+            {body}
+            {footer}
+          </StyledDialog>
+        </Backdrop>
+      </Portal_1.default>
+    </>);
+});
+_Dialog.displayName = 'Dialog';
+const Header = styled_components_1.default(Box_1.default).attrs({ as: 'header' }) `
+  box-shadow: 0 1px 0 ${constants_1.get('colors.border.default')};
+  padding: ${constants_1.get('space.2')};
+  z-index: 1;
+  flex-shrink: 0;
+`;
+const Title = styled_components_1.default(Box_1.default) `
+  font-size: ${constants_1.get('fontSizes.1')};
+  font-weight: ${constants_1.get('fontWeights.bold')};
+`;
+const Subtitle = styled_components_1.default(Box_1.default) `
+  font-size: ${constants_1.get('fontSizes.0')};
+  margin-top: ${constants_1.get('space.1')};
+  color: ${constants_1.get('colors.fg.muted')};
+`;
+const Body = styled_components_1.default(Box_1.default) `
+  flex-grow: 1;
+  overflow: auto;
+  padding: ${constants_1.get('space.3')};
+`;
+const Footer = styled_components_1.default(Box_1.default).attrs({ as: 'footer' }) `
+  box-shadow: 0 -1px 0 ${constants_1.get('colors.border.default')};
+  padding: ${constants_1.get('space.3')};
+  display: flex;
+  flex-flow: wrap;
+  justify-content: flex-end;
+  z-index: 1;
+  flex-shrink: 0;
+
+  button {
+    margin-left: ${constants_1.get('space.1')};
+    &:first-child {
+      margin-left: 0;
+    }
+  }
+`;
+const buttonTypes = {
+    normal: Button_1.default,
+    primary: Button_1.ButtonPrimary,
+    danger: Button_1.ButtonDanger
+};
+const Buttons = ({ buttons }) => {
+    const autoFocusRef = hooks_1.useProvidedRefOrCreate(buttons.find(button => button.autoFocus)?.ref);
+    let autoFocusCount = 0;
+    const [hasRendered, setHasRendered] = react_1.useState(0);
+    react_1.useEffect(() => {
+        // hack to work around dialogs originating from other focus traps.
+        if (hasRendered === 1) {
+            autoFocusRef.current?.focus();
+        }
+        else {
+            setHasRendered(hasRendered + 1);
+        }
+    }, [autoFocusRef, hasRendered]);
+    return (<>
+      {buttons.map((dialogButtonProps, index) => {
+            const { content, buttonType = 'normal', autoFocus = false, ...buttonProps } = dialogButtonProps;
+            const ButtonElement = buttonTypes[buttonType];
+            return (<ButtonElement key={index} {...buttonProps} variant={buttonType} ref={autoFocus && autoFocusCount === 0 ? (autoFocusCount++, autoFocusRef) : null}>
+            {content}
+          </ButtonElement>);
+        })}
+    </>);
+};
+const DialogCloseButton = styled_components_1.default(Button_1.default) `
+  border-radius: 4px;
+  background: transparent;
+  border: 0;
+  vertical-align: middle;
+  color: ${constants_1.get('colors.fg.muted')};
+  padding: ${constants_1.get('space.2')};
+  align-self: flex-start;
+  line-height: normal;
+  box-shadow: none;
+`;
+const CloseButton = ({ onClose }) => {
+    return (<DialogCloseButton aria-label="Close" onClick={onClose}>
+      <StyledOcticon_1.default icon={octicons_react_1.XIcon}/>
+    </DialogCloseButton>);
+};
+/**
+ * A dialog is a type of overlay that can be used for confirming actions, asking
+ * for disambiguation, and presenting small forms. They generally allow the user
+ * to focus on a quick task without having to navigate to a different page.
+ *
+ * Dialogs appear in the page after a direct user interaction. Don't show dialogs
+ * on page load or as system alerts.
+ *
+ * Dialogs appear centered in the page, with a visible backdrop that dims the rest
+ * of the window for focus.
+ *
+ * All dialogs have a title and a close button.
+ *
+ * Dialogs are modal. Dialogs can be dismissed by clicking on the close button,
+ * pressing the escape key, or by interacting with another button in the dialog.
+ * To avoid losing information and missing important messages, clicking outside
+ * of the dialog will not close it.
+ *
+ * The sub components provided (e.g. Header, Title, etc.) are available for custom
+ * renderers only. They are not intended to be used otherwise.
+ */
+exports.Dialog = Object.assign(_Dialog, {
+    Header,
+    Title,
+    Subtitle,
+    Body,
+    Footer,
+    Buttons,
+    CloseButton
+});