@wordpress/components
Version:
UI components for WordPress.
257 lines (256 loc) • 11.6 kB
JavaScript
;
Object.defineProperties(exports, {
__esModule: { value: true },
[Symbol.toStringTag]: { value: "Module" }
});
// \0rolldown/runtime.js
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
key = keys[i];
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
get: ((k) => from[k]).bind(null, key),
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
});
}
return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
value: mod,
enumerable: true
}) : target, mod));
let clsx = require("clsx");
clsx = __toESM(clsx);
let _wordpress_element = require("@wordpress/element");
let _wordpress_compose = require("@wordpress/compose");
let _wordpress_i18n = require("@wordpress/i18n");
let _wordpress_icons = require("@wordpress/icons");
let _wordpress_dom = require("@wordpress/dom");
let _wordpress_keycodes = require("@wordpress/keycodes");
let __aria_helper_ts = require("./aria-helper.cjs");
__aria_helper_ts = __toESM(__aria_helper_ts);
let ___button_index_tsx = require("../button/index.cjs");
___button_index_tsx = __toESM(___button_index_tsx);
let ___style_provider_index_tsx = require("../style-provider/index.cjs");
___style_provider_index_tsx = __toESM(___style_provider_index_tsx);
let ___spacer_index_ts = require("../spacer/index.cjs");
let __use_modal_exit_animation_ts = require("./use-modal-exit-animation.cjs");
let __context_ts = require("./context.cjs");
let react_jsx_runtime = require("react/jsx-runtime");
// packages/components/src/modal/index.tsx
const bodyOpenClasses = /* @__PURE__ */ new Map();
function UnforwardedModal(props, forwardedRef) {
const { bodyOpenClassName = "modal-open", role = "dialog", title = null, focusOnMount = true, shouldCloseOnEsc = true, shouldCloseOnClickOutside = true, isDismissible = true, aria = {
labelledby: void 0,
describedby: void 0
}, onRequestClose, icon, closeButtonLabel, children, style, overlayClassName: overlayClassnameProp, className, contentLabel, onKeyDown, isFullScreen = false, size, headerActions = null, __experimentalHideHeader = false } = props;
const ref = (0, _wordpress_element.useRef)(null);
const instanceId = (0, _wordpress_compose.useInstanceId)(Modal);
const headingId = title ? `components-modal-header-${instanceId}` : aria.labelledby;
const dialogLabel = contentLabel ?? (__experimentalHideHeader && title ? title : void 0);
const shouldFocusContent = focusOnMount === "firstContentElement";
const focusOnMountRef = (0, _wordpress_compose.useFocusOnMount)(shouldFocusContent ? false : focusOnMount);
const constrainedTabbingRef = (0, _wordpress_compose.useConstrainedTabbing)();
const focusReturnRef = (0, _wordpress_compose.useFocusReturn)();
const contentRef = (0, _wordpress_element.useRef)(null);
const childrenContainerRef = (0, _wordpress_element.useRef)(null);
const focusContentRef = (0, _wordpress_compose.useRefEffect)((node) => {
if (!shouldFocusContent || node.contains(node.ownerDocument.activeElement)) return;
const timerId = setTimeout(() => {
const childrenContainer = childrenContainerRef.current;
(childrenContainer && _wordpress_dom.focus.tabbable.find(childrenContainer)[0] || _wordpress_dom.focus.tabbable.find(node)[0] || node).focus({ preventScroll: true });
}, 0);
return () => clearTimeout(timerId);
}, [shouldFocusContent]);
const [hasScrolledContent, setHasScrolledContent] = (0, _wordpress_element.useState)(false);
const [hasScrollableContent, setHasScrollableContent] = (0, _wordpress_element.useState)(false);
let sizeClass;
if (isFullScreen || size === "fill") sizeClass = "is-full-screen";
else if (size) sizeClass = `has-size-${size}`;
const isContentScrollable = (0, _wordpress_element.useCallback)(() => {
if (!contentRef.current) return;
const closestScrollContainer = (0, _wordpress_dom.getScrollContainer)(contentRef.current);
if (contentRef.current === closestScrollContainer) setHasScrollableContent(true);
else setHasScrollableContent(false);
}, [contentRef]);
(0, _wordpress_element.useEffect)(() => {
const modalElement = ref.current;
__aria_helper_ts.modalize(modalElement);
return () => __aria_helper_ts.unmodalize(modalElement);
}, []);
const onRequestCloseRef = (0, _wordpress_element.useRef)(void 0);
(0, _wordpress_element.useEffect)(() => {
onRequestCloseRef.current = onRequestClose;
}, [onRequestClose]);
const dismissers = (0, _wordpress_element.useContext)(__context_ts.ModalContext);
const [nestedDismissers] = (0, _wordpress_element.useState)(() => /* @__PURE__ */ new Set());
(0, _wordpress_element.useEffect)(() => {
dismissers.add(onRequestCloseRef);
for (const dismisser of dismissers) if (dismisser !== onRequestCloseRef) dismisser.current?.();
return () => {
for (const dismisser of nestedDismissers) dismisser.current?.();
dismissers.delete(onRequestCloseRef);
};
}, [dismissers, nestedDismissers]);
(0, _wordpress_element.useEffect)(() => {
const theClass = bodyOpenClassName;
const oneMore = 1 + (bodyOpenClasses.get(theClass) ?? 0);
bodyOpenClasses.set(theClass, oneMore);
document.body.classList.add(bodyOpenClassName);
return () => {
const oneLess = bodyOpenClasses.get(theClass) - 1;
if (oneLess === 0) {
document.body.classList.remove(theClass);
bodyOpenClasses.delete(theClass);
} else bodyOpenClasses.set(theClass, oneLess);
};
}, [bodyOpenClassName]);
const { closeModal, frameRef, overlayClassname } = (0, __use_modal_exit_animation_ts.useModalExitAnimation)();
(0, _wordpress_element.useLayoutEffect)(() => {
if (!window.ResizeObserver || !childrenContainerRef.current) return;
const resizeObserver = new ResizeObserver(isContentScrollable);
resizeObserver.observe(childrenContainerRef.current);
isContentScrollable();
return () => {
resizeObserver.disconnect();
};
}, [isContentScrollable, childrenContainerRef]);
function handleEscapeKeyDown(event) {
if (shouldCloseOnEsc && (event.code === "Escape" || event.key === "Escape") && !event.defaultPrevented) {
event.preventDefault();
event.stopPropagation();
closeModal().then(() => onRequestClose(event));
}
}
const onContentContainerScroll = (0, _wordpress_element.useCallback)((e) => {
const scrollY = e?.currentTarget?.scrollTop ?? -1;
if (!hasScrolledContent && scrollY > 0) setHasScrolledContent(true);
else if (hasScrolledContent && scrollY <= 0) setHasScrolledContent(false);
}, [hasScrolledContent]);
let pressTarget = null;
const modal = /* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
ref: (0, _wordpress_compose.useMergeRefs)([ref, forwardedRef]),
className: (0, clsx.default)("components-modal__screen-overlay", overlayClassname, overlayClassnameProp),
onKeyDown: (0, _wordpress_keycodes.withIgnoreIMEEvents)(handleEscapeKeyDown),
...shouldCloseOnClickOutside ? {
onPointerDown: (event) => {
if (event.target === event.currentTarget) {
pressTarget = event.target;
event.preventDefault();
}
},
onPointerUp: ({ target, button }) => {
const isSameTarget = target === pressTarget;
pressTarget = null;
if (button === 0 && isSameTarget) closeModal().then(() => onRequestClose());
}
} : {},
children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(___style_provider_index_tsx.default, {
document,
children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
className: (0, clsx.default)("components-modal__frame", sizeClass, className),
style,
ref: (0, _wordpress_compose.useMergeRefs)([
frameRef,
constrainedTabbingRef,
focusReturnRef,
shouldFocusContent ? focusContentRef : focusOnMountRef
]),
role,
"aria-label": dialogLabel,
"aria-labelledby": dialogLabel ? void 0 : headingId,
"aria-describedby": aria.describedby,
tabIndex: -1,
onKeyDown,
children: /* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
className: (0, clsx.default)("components-modal__content", {
"hide-header": __experimentalHideHeader,
"is-scrollable": hasScrollableContent,
"has-scrolled-content": hasScrolledContent
}),
role: "document",
onScroll: onContentContainerScroll,
ref: contentRef,
"aria-label": hasScrollableContent ? (0, _wordpress_i18n.__)("Scrollable section") : void 0,
tabIndex: hasScrollableContent ? 0 : void 0,
children: [!__experimentalHideHeader && /* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
className: "components-modal__header",
children: [
/* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
className: "components-modal__header-heading-container",
children: [icon && /* @__PURE__ */ (0, react_jsx_runtime.jsx)("span", {
className: "components-modal__icon-container",
"aria-hidden": true,
children: icon
}), title && /* @__PURE__ */ (0, react_jsx_runtime.jsx)("h1", {
id: headingId,
className: "components-modal__header-heading",
children: title
})]
}),
headerActions,
isDismissible && /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(react_jsx_runtime.Fragment, { children: [/* @__PURE__ */ (0, react_jsx_runtime.jsx)(___spacer_index_ts.Spacer, {
marginBottom: 0,
marginLeft: 2
}), /* @__PURE__ */ (0, react_jsx_runtime.jsx)(___button_index_tsx.default, {
size: "compact",
onClick: (event) => closeModal().then(() => onRequestClose(event)),
icon: _wordpress_icons.close,
label: closeButtonLabel || (0, _wordpress_i18n.__)("Close")
})] })
]
}), /* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
ref: childrenContainerRef,
className: "components-modal__children-container",
children
})]
})
})
})
});
return (0, _wordpress_element.createPortal)(/* @__PURE__ */ (0, react_jsx_runtime.jsx)(__context_ts.ModalContext.Provider, {
value: nestedDismissers,
children: modal
}), document.body);
}
/**
* Modals give users information and choices related to a task they’re trying to
* accomplish. They can contain critical information, require decisions, or
* involve multiple tasks.
*
* ```jsx
* import { Button, Modal } from '@wordpress/components';
* import { useState } from '@wordpress/element';
*
* const MyModal = () => {
* const [ isOpen, setOpen ] = useState( false );
* const openModal = () => setOpen( true );
* const closeModal = () => setOpen( false );
*
* return (
* <>
* <Button variant="secondary" onClick={ openModal }>
* Open Modal
* </Button>
* { isOpen && (
* <Modal title="This is my modal" onRequestClose={ closeModal }>
* <Button variant="secondary" onClick={ closeModal }>
* My custom close button
* </Button>
* </Modal>
* ) }
* </>
* );
* };
* ```
*/
const Modal = (0, _wordpress_element.forwardRef)(UnforwardedModal);
Modal.displayName = "Modal";
exports.Modal = Modal;
exports.default = Modal;
//# sourceMappingURL=index.cjs.map