@mskcc/carbon-react
Version:
Carbon react components for the MSKCC DSM
519 lines (510 loc) • 18.9 kB
JavaScript
/**
* MSKCC 2021, 2024
*/
'use strict';
Object.defineProperty(exports, '__esModule', { value: true });
var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
var PropTypes = require('prop-types');
var React = require('react');
var cx = require('classnames');
var iconsReact = require('@carbon/icons-react');
var toggleClass = require('../../tools/toggleClass.js');
var Button = require('../Button/Button.js');
require('../Button/Button.Skeleton.js');
var ButtonSet = require('../ButtonSet/ButtonSet.js');
var InlineLoading = require('../MskInlineLoading/InlineLoading.js');
var index$1 = require('../MskLayer/index.js');
var wrapFocus = require('../../internal/wrapFocus.js');
var debounce = require('lodash.debounce');
var useIsomorphicEffect = require('../../internal/useIsomorphicEffect.js');
var useId = require('../../internal/useId.js');
var usePrefix = require('../../internal/usePrefix.js');
require('../Text/index.js');
var index = require('../FeatureFlags/index.js');
var events = require('../../tools/events.js');
var requiredIfGivenPropIsTruthyv2 = require('../../prop-types/requiredIfGivenPropIsTruthyv2.js');
var Text = require('../Text/Text.js');
var match = require('../../internal/keyboard/match.js');
var keys = require('../../internal/keyboard/keys.js');
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
var debounce__default = /*#__PURE__*/_interopDefaultLegacy(debounce);
const noopFn = () => {};
const ModalSizes = ['xs', 'sm', 'md', 'lg'];
const Modal = /*#__PURE__*/React__default["default"].forwardRef(function Modal(_ref, ref) {
let {
'aria-label': ariaLabelProp,
children,
className,
modalHeading = '',
modalLabel = '',
modalAriaLabel,
passiveModal = false,
secondaryButtonText,
primaryButtonText,
open,
onRequestClose = noopFn,
onRequestSubmit = noopFn,
onSecondarySubmit,
primaryButtonDisabled = false,
danger,
alert,
secondaryButtons,
selectorPrimaryFocus = '[data-modal-primary-focus]',
selectorsFloatingMenus,
shouldSubmitOnEnter,
size,
hasScrollingContent = false,
closeButtonLabel = 'Close',
preventCloseOnClickOutside = false,
isFullWidth,
launcherButtonRef,
loadingStatus = 'inactive',
loadingDescription,
loadingIconDescription,
onLoadingSuccess = noopFn,
slug,
primaryButtonKind = 'primary',
primaryButtonClassName,
secondaryButtonKind = 'tertiary',
disableInitialFocus = false,
...rest
} = _ref;
const prefix = usePrefix.usePrefix();
const button = React.useRef(null);
const secondaryButton = React.useRef();
const contentRef = React.useRef(null);
const innerModal = React.useRef(null);
const startTrap = React.useRef(null);
const endTrap = React.useRef(null);
const [isScrollable, setIsScrollable] = React.useState(false);
const modalInstanceId = `modal-${useId.useId()}`;
const modalLabelId = `${prefix}--modal-header__label--${modalInstanceId}`;
const modalHeadingId = `${prefix}--modal-header__heading--${modalInstanceId}`;
const modalBodyId = `${prefix}--modal-body--${modalInstanceId}`;
const modalCloseButtonClass = `${prefix}--modal-close`;
const primaryButtonClass = cx__default["default"]({
primaryButtonClassName,
[`${prefix}--btn--loading`]: loadingStatus !== 'inactive'
});
const loadingActive = loadingStatus !== 'inactive';
const focusTrapWithoutSentinels = index.useFeatureFlag('enable-experimental-focus-wrap-without-sentinels');
function isCloseButton(element) {
return !onSecondarySubmit && element === secondaryButton.current || element.classList.contains(modalCloseButtonClass);
}
function handleKeyDown(evt) {
evt.stopPropagation();
if (open) {
if (match.match(evt, keys.Escape)) {
onRequestClose(evt);
}
if (match.match(evt, keys.Enter) && shouldSubmitOnEnter && !isCloseButton(evt.target)) {
onRequestSubmit(evt);
}
if (focusTrapWithoutSentinels && match.match(evt, keys.Tab) && innerModal.current) {
wrapFocus.wrapFocusWithoutSentinels({
containerNode: innerModal.current,
currentActiveNode: evt.target,
event: evt
});
}
}
}
function handleOnClick(evt) {
const target = evt.target;
evt.stopPropagation();
if (!preventCloseOnClickOutside && !wrapFocus.elementOrParentIsFloatingMenu(target, selectorsFloatingMenus) && innerModal.current && !innerModal.current.contains(target)) {
onRequestClose(evt);
}
}
function handleBlur(_ref2) {
let {
target: oldActiveNode,
relatedTarget: currentActiveNode
} = _ref2;
if (open && currentActiveNode && oldActiveNode) {
const {
current: bodyNode
} = innerModal;
const {
current: startTrapNode
} = startTrap;
const {
current: endTrapNode
} = endTrap;
wrapFocus["default"]({
bodyNode,
startTrapNode,
endTrapNode,
currentActiveNode,
oldActiveNode,
selectorsFloatingMenus
});
}
}
const onSecondaryButtonClick = onSecondarySubmit ? onSecondarySubmit : onRequestClose;
const modalClasses = cx__default["default"](`${prefix}--modal`, {
[`${prefix}--modal-tall`]: !passiveModal,
'is-visible': open,
[`${prefix}--modal--danger`]: danger,
[`${prefix}--modal--slug`]: slug
}, className);
const containerClasses = cx__default["default"](`${prefix}--modal-container`, {
[`${prefix}--modal-container--${size}`]: size,
[`${prefix}--modal-container--full-width`]: isFullWidth
});
const contentClasses = cx__default["default"](`${prefix}--modal-content`, {
[`${prefix}--modal-scroll-content`]: hasScrollingContent || isScrollable
});
const footerClasses = cx__default["default"](`${prefix}--modal-footer`, {
[`${prefix}--modal-footer--three-button`]: Array.isArray(secondaryButtons) && secondaryButtons.length === 2
});
const asStringOrUndefined = node => {
return typeof node === 'string' ? node : undefined;
};
const modalLabelStr = asStringOrUndefined(modalLabel);
const modalHeadingStr = asStringOrUndefined(modalHeading);
const ariaLabel = modalLabelStr || ariaLabelProp || modalAriaLabel || modalHeadingStr;
const getAriaLabelledBy = modalLabel ? modalLabelId : modalHeadingId;
const hasScrollingContentProps = hasScrollingContent || isScrollable ? {
tabIndex: 0,
role: 'region',
'aria-label': ariaLabel,
'aria-labelledby': getAriaLabelledBy
} : {};
const alertDialogProps = {};
if (alert && passiveModal) {
alertDialogProps.role = 'alert';
}
if (alert && !passiveModal) {
alertDialogProps.role = 'alertdialog';
alertDialogProps['aria-describedby'] = modalBodyId;
}
React.useEffect(() => {
return () => {
toggleClass["default"](document.body, `${prefix}--body--with-modal-open`, false);
};
}, [prefix]);
React.useEffect(() => {
toggleClass["default"](document.body, `${prefix}--body--with-modal-open`, open ?? false);
}, [open, prefix]);
React.useEffect(() => {
if (!open && launcherButtonRef) {
setTimeout(() => {
launcherButtonRef?.current?.focus();
});
}
}, [open, launcherButtonRef]);
React.useEffect(() => {
const initialFocus = focusContainerElement => {
if (disableInitialFocus) {
return null;
}
const containerElement = focusContainerElement || innerModal.current;
const primaryFocusElement = containerElement ? containerElement.querySelector(danger ? `.${prefix}--btn--tertiary` : selectorPrimaryFocus) : null;
if (primaryFocusElement) {
return primaryFocusElement;
}
return button && button.current;
};
const focusButton = focusContainerElement => {
const target = initialFocus(focusContainerElement);
if (target !== null) {
target.focus();
}
};
if (open) {
focusButton(innerModal.current);
}
}, [open, selectorPrimaryFocus, danger, prefix, disableInitialFocus]);
useIsomorphicEffect["default"](() => {
if (contentRef.current) {
setIsScrollable(contentRef.current.scrollHeight > contentRef.current.clientHeight);
}
function handler() {
if (contentRef.current) {
setIsScrollable(contentRef.current.scrollHeight > contentRef.current.clientHeight);
}
}
const debouncedHandler = debounce__default["default"](handler, 200);
window.addEventListener('resize', debouncedHandler);
return () => {
debouncedHandler.cancel();
window.removeEventListener('resize', debouncedHandler);
};
}, []);
// Slug is always size `sm`
let normalizedSlug;
if (slug && slug['type']?.displayName === 'AILabel') {
normalizedSlug = /*#__PURE__*/React__default["default"].cloneElement(slug, {
size: 'sm'
});
}
const modalButton = /*#__PURE__*/React__default["default"].createElement("div", {
className: `${prefix}--modal-close-button`
}, /*#__PURE__*/React__default["default"].createElement("button", {
className: modalCloseButtonClass,
type: 'button',
onClick: onRequestClose,
"aria-label": closeButtonLabel,
ref: button
}, /*#__PURE__*/React__default["default"].createElement(iconsReact.Close, {
size: 20,
"aria-hidden": "true",
tabIndex: "-1",
className: `${modalCloseButtonClass}__icon`
})));
const modalBody = /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({
ref: innerModal,
role: "dialog"
}, alertDialogProps, {
className: containerClasses,
"aria-label": ariaLabel,
"aria-modal": "true",
tabIndex: -1
}), /*#__PURE__*/React__default["default"].createElement("div", {
className: `${prefix}--modal-header`
}, passiveModal && modalButton, modalLabel && /*#__PURE__*/React__default["default"].createElement(Text.Text, {
as: "h2",
id: modalLabelId,
className: `${prefix}--modal-header__label`
}, modalLabel), /*#__PURE__*/React__default["default"].createElement(Text.Text, {
as: "h3",
id: modalHeadingId,
className: `${prefix}--modal-header__heading`
}, modalHeading), normalizedSlug, !passiveModal && modalButton), /*#__PURE__*/React__default["default"].createElement(index$1.Layer, _rollupPluginBabelHelpers["extends"]({
ref: contentRef,
id: modalBodyId,
className: contentClasses
}, hasScrollingContentProps), children), !passiveModal && /*#__PURE__*/React__default["default"].createElement(ButtonSet["default"], {
className: footerClasses,
"aria-busy": loadingActive
}, Array.isArray(secondaryButtons) && secondaryButtons.length <= 2 ? secondaryButtons.map((_ref3, i) => {
let {
buttonText,
onClick: onButtonClick
} = _ref3;
return /*#__PURE__*/React__default["default"].createElement(Button["default"], {
key: `${buttonText}-${i}`,
kind: secondaryButtonKind,
onClick: onButtonClick
}, buttonText);
}) : secondaryButtonText && /*#__PURE__*/React__default["default"].createElement(Button["default"], {
disabled: loadingActive,
kind: secondaryButtonKind,
onClick: onSecondaryButtonClick,
ref: secondaryButton
}, secondaryButtonText), /*#__PURE__*/React__default["default"].createElement(Button["default"], {
className: primaryButtonClass,
kind: danger ? 'danger' : primaryButtonKind,
disabled: loadingActive || primaryButtonDisabled,
onClick: onRequestSubmit,
ref: button
}, loadingStatus === 'inactive' ? primaryButtonText : /*#__PURE__*/React__default["default"].createElement(InlineLoading["default"], {
status: loadingStatus,
description: loadingDescription,
iconDescription: loadingIconDescription,
className: `${prefix}--inline-loading--btn`,
onSuccess: onLoadingSuccess
}))));
return /*#__PURE__*/React__default["default"].createElement(index$1.Layer, _rollupPluginBabelHelpers["extends"]({}, rest, {
level: 0,
onKeyDown: handleKeyDown,
onClick: events.composeEventHandlers([rest?.onClick, handleOnClick]),
onBlur: !focusTrapWithoutSentinels ? handleBlur : () => {},
className: modalClasses,
role: "presentation",
ref: ref
}), !focusTrapWithoutSentinels && /*#__PURE__*/React__default["default"].createElement("span", {
ref: startTrap,
tabIndex: 0,
role: "link",
className: `${prefix}--visually-hidden`
}, "Focus sentinel"), modalBody, !focusTrapWithoutSentinels && /*#__PURE__*/React__default["default"].createElement("span", {
ref: endTrap,
tabIndex: 0,
role: "link",
className: `${prefix}--visually-hidden`
}, "Focus sentinel"));
});
Modal.propTypes = {
/**
* Specify whether the Modal is displaying an alert, error or warning
* Should go hand in hand with the danger prop.
*/
alert: PropTypes__default["default"].bool,
/**
* Required props for the accessibility label of the header
*/
['aria-label']: requiredIfGivenPropIsTruthyv2["default"]('hasScrollingContent', PropTypes__default["default"].string),
/**
* Provide the contents of your Modal
*/
children: PropTypes__default["default"].node,
/**
* Specify an optional className to be applied to the modal root node
*/
className: PropTypes__default["default"].string,
/**
* Specify an label for the close button of the modal; defaults to close
*/
closeButtonLabel: PropTypes__default["default"].string,
/**
* Specify whether the Modal is for dangerous actions
*/
danger: PropTypes__default["default"].bool,
/**
* Specify whether the modal contains scrolling content
*/
hasScrollingContent: PropTypes__default["default"].bool,
/**
* Specify the DOM element ID of the top-level node.
*/
id: PropTypes__default["default"].string,
/**
* Specify whether or not the Modal content should have any inner padding.
*/
isFullWidth: PropTypes__default["default"].bool,
/**
* Provide a ref to return focus to once the modal is closed.
*/
launcherButtonRef: PropTypes__default["default"].oneOfType([PropTypes__default["default"].func, PropTypes__default["default"].shape({
current: PropTypes__default["default"].any
})]),
/**
* Specify the description for the loading text
*/
loadingDescription: PropTypes__default["default"].string,
/**
* Specify the description for the loading text
*/
loadingIconDescription: PropTypes__default["default"].string,
/**
* loading status
*/
loadingStatus: PropTypes__default["default"].oneOf(['inactive', 'active', 'finished', 'error']),
/**
* Specify a label to be read by screen readers on the modal root node
*/
modalAriaLabel: PropTypes__default["default"].string,
/**
* Specify the content of the modal header title.
*/
modalHeading: PropTypes__default["default"].node,
/**
* Specify the content of the modal header label.
*/
modalLabel: PropTypes__default["default"].node,
/**
* Specify a handler for keypresses.
*/
onKeyDown: PropTypes__default["default"].func,
/**
* Provide an optional handler to be invoked when loading is
* successful
*/
onLoadingSuccess: PropTypes__default["default"].func,
/**
* Specify a handler for closing modal.
* The handler should care of closing modal, e.g. changing `open` prop.
*/
onRequestClose: PropTypes__default["default"].func,
/**
* Specify a handler for "submitting" modal.
* The handler should care of closing modal, e.g. changing `open` prop, if necessary.
*/
onRequestSubmit: PropTypes__default["default"].func,
/**
* Specify a handler for the secondary button.
* Useful if separate handler from `onRequestClose` is desirable
*/
onSecondarySubmit: PropTypes__default["default"].func,
/**
* Specify whether the Modal is currently open
*/
open: PropTypes__default["default"].bool,
/**
* Specify whether the modal should be button-less
*/
passiveModal: PropTypes__default["default"].bool,
/**
* Prevent closing on click outside of modal
*/
preventCloseOnClickOutside: PropTypes__default["default"].bool,
/**
* Specify whether the Button should be disabled, or not
*/
primaryButtonDisabled: PropTypes__default["default"].bool,
/**
* Specify the text for the primary button
*/
primaryButtonText: PropTypes__default["default"].node,
/**
* Specify the classnames of the primary button
*/
primaryButtonClassName: PropTypes__default["default"].string,
/**
* Specify the text for the secondary button
*/
secondaryButtonText: PropTypes__default["default"].node,
/**
* Specify an array of config objects for secondary buttons
* (`Array<{
* buttonText: string,
* onClick: function,
* }>`).
*/
secondaryButtons: (props, propName, componentName) => {
if (props.secondaryButtons) {
if (!Array.isArray(props.secondaryButtons) || props.secondaryButtons.length !== 2) {
return new Error(`${propName} needs to be an array of two button config objects`);
}
const shape = {
buttonText: PropTypes__default["default"].node,
onClick: PropTypes__default["default"].func
};
props[propName].forEach(secondaryButton => {
PropTypes__default["default"].checkPropTypes(shape, secondaryButton, propName, componentName);
});
}
return null;
},
/**
* Specify a CSS selector that matches the DOM element that should
* be focused when the Modal opens
*/
selectorPrimaryFocus: PropTypes__default["default"].string,
/**
* Specify CSS selectors that match DOM elements working as floating menus.
* Focusing on those elements won't trigger "focus-wrap" behavior
*/
selectorsFloatingMenus: PropTypes__default["default"].arrayOf(PropTypes__default["default"].string.isRequired),
/**
* Specify if Enter key should be used as "submit" action
*/
shouldSubmitOnEnter: PropTypes__default["default"].bool,
/**
* Specify the size variant.
*/
size: PropTypes__default["default"].oneOf(ModalSizes),
/**
* **Experimental**: Provide a `Slug` component to be rendered inside the `Modal` component
*/
slug: PropTypes__default["default"].node,
/**
* Specify whether the initial focus should be disabled
*/
disableInitialFocus: PropTypes__default["default"].bool,
/**
* Specify kind of the primary button
*/
primaryButtonKind: PropTypes__default["default"].oneOf(Button.ButtonKinds),
/**
* Specify kind of the secondary button
* */
secondaryButtonKind: PropTypes__default["default"].oneOf(Button.ButtonKinds)
};
exports.ModalSizes = ModalSizes;
exports["default"] = Modal;