UNPKG

@wordpress/components

Version:
253 lines (252 loc) • 9.61 kB
import { __ } from "@wordpress/i18n"; import { useCallback, useEffect, useRef, useState } from "@wordpress/element"; import Modal from "../modal/index.mjs"; import { contextConnect, useContextSystem } from "../context/index.mjs"; import { Flex } from "../flex/index.mjs"; import Button from "../button/index.mjs"; import { Text } from "../text/index.mjs"; import { VStack } from "../v-stack/index.mjs"; import { Fragment, jsx, jsxs } from "react/jsx-runtime"; // packages/style-runtime/src/index.ts const STYLE_HASH_ATTRIBUTE = "data-wp-hash"; /** * Returns the shared style runtime registry. * * The registry is stored on `globalThis` so separately bundled copies of this * package can coordinate through the same document and style maps. * * @return The shared runtime registry. */ function getRuntime() { const globalScope = globalThis; if (globalScope.__wpStyleRuntime) return globalScope.__wpStyleRuntime; globalScope.__wpStyleRuntime = { documents: /* @__PURE__ */ new Map(), styles: /* @__PURE__ */ new Map(), injectedStyles: /* @__PURE__ */ new WeakMap() }; if (typeof document !== "undefined") registerDocument(document); return globalScope.__wpStyleRuntime; } /** * Checks whether a document already contains a style tag for a hash. * * @param targetDocument Document to inspect. * @param hash Stable hash for the transformed CSS. * * @return Whether the style hash already exists in the document. */ function documentContainsStyleHash(targetDocument, hash) { if (!targetDocument.head) return false; for (const style of targetDocument.head.querySelectorAll(`style[${STYLE_HASH_ATTRIBUTE}]`)) if (style.getAttribute(STYLE_HASH_ATTRIBUTE) === hash) return true; return false; } /** * Injects a registered style into a document, unless that document already * contains a style tag for the same hash. * * @param targetDocument Document to inject the style into. * @param hash Stable hash for the transformed CSS. * @param css CSS text to inject. */ function injectStyle(targetDocument, hash, css) { if (!targetDocument.head) return; const runtime = getRuntime(); let injectedStyles = runtime.injectedStyles.get(targetDocument); if (!injectedStyles) { injectedStyles = /* @__PURE__ */ new Set(); runtime.injectedStyles.set(targetDocument, injectedStyles); } if (injectedStyles.has(hash)) return; if (documentContainsStyleHash(targetDocument, hash)) { injectedStyles.add(hash); return; } const style = targetDocument.createElement("style"); style.setAttribute(STYLE_HASH_ATTRIBUTE, hash); style.appendChild(targetDocument.createTextNode(css)); targetDocument.head.appendChild(style); injectedStyles.add(hash); } /** * Registers a document as a style injection target. * * Existing registered styles are replayed into the document immediately. * Documents are reference-counted so multiple providers can safely register the * same document without one cleanup removing it while another registration is * still active. * * @param targetDocument Document to receive registered styles. * @return Cleanup function that unregisters this document registration. */ function registerDocument(targetDocument) { const runtime = getRuntime(); runtime.documents.set(targetDocument, (runtime.documents.get(targetDocument) ?? 0) + 1); for (const [hash, css] of runtime.styles) injectStyle(targetDocument, hash, css); return () => { const count = runtime.documents.get(targetDocument); if (count === void 0) return; if (count <= 1) { runtime.documents.delete(targetDocument); return; } runtime.documents.set(targetDocument, count - 1); }; } /** * Registers a style and injects it into all registered documents. * * The hash is used as the deduplication key, so calling this repeatedly with * the same hash will not add duplicate style tags to a document. * Registered styles are retained for the lifetime of the page so they can be * replayed into documents that are registered later. * * @param hash Stable hash for the transformed CSS. * @param css CSS text to inject. */ function registerStyle(hash, css) { const runtime = getRuntime(); runtime.styles.set(hash, css); for (const targetDocument of runtime.documents.keys()) injectStyle(targetDocument, hash, css); } // packages/components/src/confirm-dialog/style.module.scss if (typeof process === "undefined" || process.env.NODE_ENV !== "test") registerStyle("b650a2b0b6", "._275a37b064c3d282__wrapper._275a37b064c3d282__wrapper{z-index:1000001}"); var style_module_default = { "wrapper": "_275a37b064c3d282__wrapper" }; // packages/components/src/confirm-dialog/component.tsx const UnconnectedConfirmDialog = (props, forwardedRef) => { const { isOpen: isOpenProp, onConfirm, onCancel, children, confirmButtonText, cancelButtonText, isBusy, title, __experimentalHideHeader = true, ...otherProps } = useContextSystem(props, "ConfirmDialog"); const wrapperClassName = style_module_default.wrapper; const cancelButtonRef = useRef(null); const confirmButtonRef = useRef(null); const [isOpen, setIsOpen] = useState(); const [shouldSelfClose, setShouldSelfClose] = useState(); useEffect(() => { const isIsOpenSet = typeof isOpenProp !== "undefined"; setIsOpen(isIsOpenSet ? isOpenProp : true); setShouldSelfClose(!isIsOpenSet); }, [isOpenProp]); const handleEvent = useCallback((callback) => (event) => { callback?.(event); if (shouldSelfClose) setIsOpen(false); }, [shouldSelfClose, setIsOpen]); const handleEnter = useCallback((event) => { if (!(event.target === cancelButtonRef.current || event.target === confirmButtonRef.current) && event.key === "Enter") handleEvent(onConfirm)(event); }, [handleEvent, onConfirm]); const cancelLabel = cancelButtonText ?? __("Cancel"); const confirmLabel = confirmButtonText ?? __("OK"); return /* @__PURE__ */ jsx(Fragment, { children: isOpen && /* @__PURE__ */ jsx(Modal, { onRequestClose: handleEvent(onCancel), onKeyDown: handleEnter, closeButtonLabel: cancelLabel, isDismissible: true, ref: forwardedRef, overlayClassName: wrapperClassName, title, __experimentalHideHeader, ...otherProps, children: /* @__PURE__ */ jsxs(VStack, { spacing: 8, children: [/* @__PURE__ */ jsx(Text, { children }), /* @__PURE__ */ jsxs(Flex, { direction: "row", justify: "flex-end", children: [/* @__PURE__ */ jsx(Button, { __next40pxDefaultSize: true, ref: cancelButtonRef, variant: "tertiary", onClick: handleEvent(onCancel), accessibleWhenDisabled: true, disabled: isBusy, children: cancelLabel }), /* @__PURE__ */ jsx(Button, { __next40pxDefaultSize: true, ref: confirmButtonRef, variant: "primary", onClick: handleEvent(onConfirm), accessibleWhenDisabled: true, disabled: isBusy, isBusy, children: confirmLabel })] })] }) }) }); }; /** * `ConfirmDialog` is built on top of [`Modal`](/packages/components/src/modal/README.md) * and displays a confirmation dialog, with _confirm_ and _cancel_ buttons. * * The dialog is confirmed by clicking the _confirm_ button or by pressing the `Enter` key. * It is cancelled (closed) by clicking the _cancel_ button, by pressing the `ESC` key, or by * clicking outside the dialog focus (i.e. the overlay). * * `ConfirmDialog` has two main modes: controlled and uncontrolled. * * ### Uncontrolled mode * * Allows the component to be used standalone, just by declaring it as part of another React * component's render method: * * - It will be automatically open (displayed) upon mounting. * - It will be automatically closed when clicking the _cancel_ button, by pressing the `ESC` * key, or by clicking outside the dialog focus (i.e. the overlay). * - `onCancel` is not mandatory but can be passed. Even if passed, the dialog will still be * able to close itself. * * Activating this mode is as simple as omitting the `isOpen` prop. The only mandatory prop * in this case is the `onConfirm` callback. The message is passed as the `children`. * * ```jsx * import { __experimentalConfirmDialog as ConfirmDialog } from '@wordpress/components'; * * function Example() { * return ( * <ConfirmDialog onConfirm={ () => console.debug( 'Confirmed!' ) }> * Are you sure? <strong>This action cannot be undone!</strong> * </ConfirmDialog> * ); * } * ``` * * ### Controlled mode * * Let the parent component control when the dialog is open/closed. It's activated when a * boolean value is passed to `isOpen`: * * - It will not be automatically closed. You need to let it know when to open/close by * updating the value of the `isOpen` prop. * - Both `onConfirm` and the `onCancel` callbacks are mandatory props in this mode. * - You'll want to update the state that controls `isOpen` from the `onCancel` and * `onConfirm` callbacks. * * ```jsx * import { useState } from '@wordpress/element'; * import { __experimentalConfirmDialog as ConfirmDialog } from '@wordpress/components'; * * function Example() { * const [ isOpen, setIsOpen ] = useState( true ); * * const handleConfirm = () => { * console.debug( 'Confirmed!' ); * setIsOpen( false ); * }; * * const handleCancel = () => { * console.debug( 'Cancelled!' ); * setIsOpen( false ); * }; * * return ( * <ConfirmDialog * isOpen={ isOpen } * onConfirm={ handleConfirm } * onCancel={ handleCancel } * > * Are you sure? <strong>This action cannot be undone!</strong> * </ConfirmDialog> * ); * } * ``` */ const ConfirmDialog = contextConnect(UnconnectedConfirmDialog, "ConfirmDialog"); export { ConfirmDialog, ConfirmDialog as default }; //# sourceMappingURL=component.mjs.map