@atlaskit/modal-dialog 14.18.3 → 15.0.1

package/dist/es2019/internal/components/modal-wrapper.js

@@ -3,30 +3,62 @@ import _extends from "@babel/runtime/helpers/extends";
 import "./modal-wrapper.compiled.css";
 import * as React from 'react';
 import { ax, ix } from "@compiled/react/runtime";
-import { useCallback } from 'react';
+import { useCallback, useEffect, useMemo, useRef } from 'react';
 import FocusLock from 'react-focus-lock';
 import ScrollLock, { TouchScrollable } from 'react-scrolllock';
 import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next';
 import Blanket from '@atlaskit/blanket';
 import noop from '@atlaskit/ds-lib/noop';
+import useAutoFocus from '@atlaskit/ds-lib/use-auto-focus';
+import { useId } from '@atlaskit/ds-lib/use-id';
 import { Layering } from '@atlaskit/layering';
 import { useNotifyOpenLayerObserver } from '@atlaskit/layering/experimental/open-layer-observer';
 import { Motion } from '@atlaskit/motion';
+import { useExitingPersistence } from '@atlaskit/motion/exiting-persistence';
 import FadeIn from '@atlaskit/motion/fade-in';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Portal from '@atlaskit/portal';
+import { combine } from '@atlaskit/pragmatic-drag-and-drop/combine';
 import { layers } from '@atlaskit/theme/constants';
+import { dialogSlideUpAndFade } from '@atlaskit/top-layer/animations';
+import { createCloseEvent } from '@atlaskit/top-layer/create-close-event';
+import { Dialog } from '@atlaskit/top-layer/dialog';
+import { DialogScrollLock } from '@atlaskit/top-layer/dialog-scroll-lock';
+import { ModalContext, ScrollContext } from '../context';
 import useModalStack from '../hooks/use-modal-stack';
 import usePreventProgrammaticScroll from '../hooks/use-prevent-programmatic-scroll';
-import ModalDialog from './modal-dialog';
+import { disableDraggingToCrossOriginIFramesForElement } from '../pragmatic-drag-and-drop/disable-dragging-to-cross-origin-iframes/element';
+import { disableDraggingToCrossOriginIFramesForExternal } from '../pragmatic-drag-and-drop/disable-dragging-to-cross-origin-iframes/external';
+import { disableDraggingToCrossOriginIFramesForTextSelection } from '../pragmatic-drag-and-drop/disable-dragging-to-cross-origin-iframes/text-selection';
+import ModalDialog, { dialogHeight, dialogWidth as getDialogWidth } from './modal-dialog';
+const modalAnimation = dialogSlideUpAndFade();
 const fillScreenStyles = null;
+
+// Visual styles for modal content inside native <dialog>.
+// Uses cssMap (not css) to avoid triggering no-nested-styles lint rule.
+
+const LOCAL_CURRENT_SURFACE_CSS_VAR = '--ds-elevation-surface-current';
+const topLayerStyles = {
+  content: "_1e0c1txw _4t3i1osq _2lx21bp4 _bfhk1bhr _syazi7uo _1q1l1bhr _lcxv1wug _1mq81kw7 _m01u1kw7 _1dg11kw7 _mizu1v1w _1ah3dkaa _ra3xnqa1 _128mdkaa _zg7p130s",
+  borderRadius: "_epkxfajl",
+  borderRadiusT26: "_epkxpb1k"
+};
+
+// Scroll-mode styles for the content div.
+// Height overrides use ID-scoped <style> (see dialogPositionStyles) because
+// Compiled atomic classes have specificity (0,1,0) (increaseSpecificity is disabled).
+// The doubled-ID selector (#id#id > div) at (2,0,1) reliably wins.
+// Only non-height properties needing the && boost remain here.
+
+const topLayerBodyScrollStyles = null;
+const topLayerViewportScrollStyles = null;
 const allowlistElements = (element, callback) => {
-  // Allow focus to reach elements outside the modal:
-  // if AUI dialog is allowListed and visible
-  if (document.querySelector('.aui-blanket:not([hidden])')) {
+  // Allow focus outside modal when AUI dialog is visible
+  // eslint-disable-next-line @atlaskit/platform/no-direct-document-usage -- legacy FocusLock allowlist
+  if (Boolean(document.querySelector('.aui-blanket:not([hidden])'))) {
     return false;
   }
-  // allows to pass a callback function to allow elements be ignored by focus lock
+  // Optional callback to let consumers exclude elements from focus lock
   if (typeof callback === 'function') {
     return callback(element);
   }
@@ -45,7 +77,7 @@ const allowlistElements = (element, callback) => {
  */
 const InternalModalWrapper = props => {
   const {
-    autoFocus = true,
+    autoFocus,
     focusLockAllowlist,
     shouldCloseOnEscapePress = true,
     shouldCloseOnOverlayClick = true,
@@ -71,10 +103,8 @@ const InternalModalWrapper = props => {
   const stackIndex = stackIndexOverride || calculatedStackIndex;
   const isForeground = stackIndex === 0;
 
-  // When a user supplies a ref to focus we skip auto focus via react-focus-lock
-  // When flag is true and a ref is not supplied, autofocus is true. See https://product-fabric.atlassian.net/browse/DSP-24307
-  // When we remove boolean `autoFocus`, we won't have to worry about this
-  const autoFocusLock = typeof autoFocus === 'boolean';
+  // If no ref is provided, autofocus on first element
+  const autoFocusLock = !(typeof autoFocus === 'object');
   const onCloseHandler = usePlatformLeafEventHandler({
     fn: providedOnClose || noop,
     action: 'closed',
@@ -88,18 +118,214 @@ const InternalModalWrapper = props => {
     }
   }, [shouldCloseOnOverlayClick, onCloseHandler]);
 
-  // This ensures to prevent additional re-renders while nothing is passed to focusLockAllowlist explicitly.
+  // Stable callback to avoid re-renders when focusLockAllowlist is not provided.
   const allowListCallback = useCallback(element => allowlistElements(element, focusLockAllowlist), [focusLockAllowlist]);
-  usePreventProgrammaticScroll();
+
+  // Called outside the feature-flag branch to keep hook order stable.
+  // Legacy path: FadeIn calls onFinish. Top-layer path: called directly.
+  const {
+    isExiting,
+    onFinish: onExitFinish
+  } = useExitingPersistence();
+
+  // Prevent background scroll (top-layer path uses DialogScrollLock instead).
+  // Safe conditional hook: feature flags are resolved once at startup.
+  if (!fg('platform-dst-top-layer')) {
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    usePreventProgrammaticScroll();
+  }
   useNotifyOpenLayerObserver({
     type: 'modal',
-    // Modal dialog is conditionally rendered when visible, so when this runs it is always open.
+    // Always open — modal is conditionally rendered when visible.
     isOpen: true,
-    // Passing a no-op for now, as there isn't a real use case for closing the modal dialog programmatically
-    // by the OpenLayerObserver. The only current use case is closing layers when resizing the nav layout,
-    // which cannot happen while a modal dialog is open.
+    // No-op: no current use case for programmatic close via OpenLayerObserver.
     onClose: noop
   });
+
+  /**
+   * Top-layer path (platform-dst-top-layer).
+   *
+   * Replaces Portal, FocusLock, ScrollLock, Blanket, Positioner, and z-index
+   * management with native <dialog> via @atlaskit/top-layer/dialog.
+   *
+   * Key decisions:
+   * - Animation: CSS transitions via @starting-style / allow-discrete.
+   * - Close gating: onDialogClose only forwards allowed reasons
+   *   (see notes/guides/dialog-close-flow.md).
+   * - onClose event param: undefined - consumers should use close reason.
+   * - Focus restoration: native <dialog> behavior replaces react-focus-lock's
+   *   returnFocus (see accessibility-criteria.md).
+   */
+  if (fg('platform-dst-top-layer')) {
+    // Native <dialog> always restores focus on close - no opt-out via shouldReturnFocus.
+    const defaultTestId = testId || 'modal-dialog';
+
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const id = useId();
+    const titleId = `modal-dialog-title-${id}`;
+
+    // Content container ref - used for onOpenComplete/onCloseComplete callbacks.
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const contentRef = useRef(null);
+
+    // Cache last content element for onCloseComplete after children unmount
+    // (with reduced motion, contentRef clears before onExitFinish fires).
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const lastContentElRef = useRef(null);
+    if (contentRef.current) {
+      lastContentElRef.current = contentRef.current;
+    }
+
+    // Native <dialog> ref - needed for ExitingPersistence to call dialog.close().
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const dialogRef = useRef(null);
+
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const modalDialogContext = useMemo(() => ({
+      testId: defaultTestId,
+      titleId,
+      onClose: onCloseHandler,
+      hasProvidedOnClose: Boolean(providedOnClose),
+      isFullScreen: isFullScreen !== null && isFullScreen !== void 0 ? isFullScreen : false
+    }), [defaultTestId, titleId, onCloseHandler, providedOnClose, isFullScreen]);
+
+    // Only forward close when the reason is allowed by props.
+    // Passes a synthetic event to satisfy the KeyboardOrMouseEvent contract.
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const onDialogClose = useCallback(({
+      reason
+    }) => {
+      if (reason === 'escape' && shouldCloseOnEscapePress) {
+        onCloseHandler(createCloseEvent({
+          reason
+        }));
+      }
+      if (reason === 'overlay-click' && shouldCloseOnOverlayClick) {
+        onCloseHandler(createCloseEvent({
+          reason
+        }));
+      }
+    }, [onCloseHandler, shouldCloseOnEscapePress, shouldCloseOnOverlayClick]);
+
+    // ExitingPersistence: isExiting → isOpen={false} → Dialog exit animation →
+    // onExitFinish → onCloseComplete + unmount.
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const handleDialogExitFinish = useCallback(() => {
+      var _contentRef$current;
+      const el = (_contentRef$current = contentRef.current) !== null && _contentRef$current !== void 0 ? _contentRef$current : lastContentElRef.current;
+      if (onCloseComplete && el) {
+        onCloseComplete(el);
+      }
+      lastContentElRef.current = null;
+      onExitFinish === null || onExitFinish === void 0 ? void 0 : onExitFinish();
+    }, [onExitFinish, onCloseComplete]);
+
+    // Fire onOpenComplete after mount.
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    useEffect(() => {
+      if (onOpenComplete && contentRef.current) {
+        onOpenComplete(contentRef.current, true);
+      }
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+
+    // Honor `shouldReturnFocus={ref}` on unmount.
+    // Native <dialog>.close() restores focus to the trigger that opened it,
+    // but the consumer asked for focus to go to a specific element instead.
+    // Run this in an unmount cleanup so it fires after dialog.close()
+    // (which fires in the Dialog's effect cleanup).
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const shouldReturnFocusRef = useRef(shouldReturnFocus);
+    shouldReturnFocusRef.current = shouldReturnFocus;
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    useEffect(() => {
+      return () => {
+        const target = shouldReturnFocusRef.current;
+        if (typeof target === 'object' && target.current) {
+          target.current.focus();
+        }
+      };
+    }, []);
+
+    // Focus a ref-targeted element after mount (when autoFocus is a ref).
+    // When true, native <dialog>.showModal() handles focus automatically.
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    useAutoFocus(typeof autoFocus === 'object' ? autoFocus : undefined, typeof autoFocus === 'object');
+
+    // Chrome cross-origin iframe DnD workaround (crbug.com/362301053)
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    useEffect(() => {
+      return combine(disableDraggingToCrossOriginIFramesForElement(), disableDraggingToCrossOriginIFramesForTextSelection(), disableDraggingToCrossOriginIFramesForExternal());
+    }, []);
+
+    // Responsive layout via ID-scoped <style> (same pattern as Dialog's hideBackdrop).
+    // ID selector beats Compiled atomic classes without !important and supports @media.
+    const namedWidth = getDialogWidth(width !== null && width !== void 0 ? width : 'medium');
+    const dialogId = `modal-dialog-${id}`;
+    const escapedDialogId = CSS.escape(dialogId);
+
+    // Percentage widths need special handling in the top layer.
+    // In legacy, the percentage resolved against the Positioner's max-width
+    // (100vw - 120px). In the top layer, the <dialog>'s containing block is the
+    // viewport (100vw), so a raw percentage would produce a wider modal.
+    // Transform e.g. '42%' → 'calc(42 * (100vw - 120px) / 100)' to match legacy.
+    const resolvedWidth = namedWidth.endsWith('%') ? `calc(${parseFloat(namedWidth)} * (100vw - 120px) / 100)` : namedWidth;
+    const dialogStyle = isFullScreen ? {
+      width: '100vw',
+      height: '100vh',
+      margin: '0'
+    } : {
+      width: `min(${resolvedWidth}, 100vw)`
+    };
+
+    // Shift stacked background modals down by space.100 (8px) per level.
+    if (stackIndex > 0) {
+      dialogStyle['transform'] = `translateY(calc(${stackIndex}px * ${"var(--ds-space-100, 8px)"}))`;
+    }
+
+    // Mobile: viewport fill. Desktop (≥ 30rem): gutter margins, auto height.
+    // Content-div height set via #id > div to beat Compiled's atomic specificity.
+    const desktopMargin = shouldScrollInViewport ? '60px auto' : '60px auto auto';
+    const resolvedHeight = dialogHeight(height);
+    // Body-scroll: specified height or auto. Viewport-scroll: uses min-height.
+    const desktopContentHeight = shouldScrollInViewport ? 'auto' : resolvedHeight;
+    const desktopContentMinHeight = shouldScrollInViewport ? resolvedHeight : 'auto';
+    // Viewport-scroll: the legacy Positioner was a fixed 100vh container that
+    // scrolled internally, so the modal section could fill (100vh - 60px top gutter).
+    // In the top layer the <dialog> sizes to content with height:auto, so we need
+    // an explicit min-height to ensure the dialog stretches to the same visible area.
+    const desktopDialogMinHeight = shouldScrollInViewport ? 'min-height:calc(100vh - 60px);' : '';
+    // Doubled-ID selector (#id#id > div) at specificity (2,0,1) beats
+    // Compiled atomic classes at (0,1,0) (increaseSpecificity is disabled).
+    const dialogPositionStyles = isFullScreen ? ''
+    // Mobile: edge-to-edge. Desktop (≥ 30rem): 60px gutters, max-width.
+    : `#${escapedDialogId}#${escapedDialogId}{margin:0;height:100vh}#${escapedDialogId}#${escapedDialogId}>div{height:100%}@media(min-width:30rem){#${escapedDialogId}#${escapedDialogId}{margin:${desktopMargin};height:auto;${desktopDialogMinHeight}max-width:calc(100vw - 120px)}#${escapedDialogId}#${escapedDialogId}>div{height:${desktopContentHeight};min-height:${desktopContentMinHeight}}}`;
+    return /*#__PURE__*/React.createElement(Dialog, {
+      ref: dialogRef,
+      id: dialogId,
+      onClose: onDialogClose,
+      onExitFinish: handleDialogExitFinish,
+      animate: isFullScreen ? false : modalAnimation,
+      isOpen: !isExiting,
+      shouldHideBackdrop: stackIndex > 0 || Boolean(isBlanketHidden),
+      label: label,
+      labelledBy: label ? undefined : titleId,
+      testId: defaultTestId
+      // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop
+      ,
+      style: dialogStyle
+    }, /*#__PURE__*/React.createElement(DialogScrollLock, null), dialogPositionStyles &&
+    /*#__PURE__*/
+    // eslint-disable-next-line @atlaskit/ui-styling-standard/no-global-styles
+    React.createElement("style", null, dialogPositionStyles), /*#__PURE__*/React.createElement("div", {
+      ref: contentRef,
+      className: ax([topLayerStyles.content, !isFullScreen && topLayerStyles.borderRadius, !isFullScreen && fg('platform-dst-shape-theme-default') && topLayerStyles.borderRadiusT26, !isFullScreen && !shouldScrollInViewport && "_bolhzwhf", !isFullScreen && shouldScrollInViewport && "_1tke1kxc _c71lglyw"])
+    }, /*#__PURE__*/React.createElement(ModalContext.Provider, {
+      value: modalDialogContext
+    }, /*#__PURE__*/React.createElement(ScrollContext.Provider, {
+      value: shouldScrollInViewport
+    }, children))));
+  }
   const modalDialogWithBlanket = /*#__PURE__*/React.createElement(Blanket, {
     isTinted: !isBlanketHidden,
     onBlanketClicked: onBlanketClicked,

package/dist/esm/internal/components/modal-dialog.js

@@ -23,7 +23,7 @@ import { disableDraggingToCrossOriginIFramesForTextSelection } from '../pragmati
 import { ScrollContext } from '../scroll-context';
 import { width } from '../width';
 import Positioner from './positioner';
-var dialogWidth = function dialogWidth(input) {
+export var dialogWidth = function dialogWidth(input) {
   if (!input) {
     return 'auto';
   }
@@ -34,7 +34,7 @@ var dialogWidth = function dialogWidth(input) {
   }
   return typeof input === 'number' ? "".concat(input, "px") : input;
 };
-var dialogHeight = function dialogHeight(input) {
+export var dialogHeight = function dialogHeight(input) {
   if (!input) {
     return 'auto';
   }
@@ -56,7 +56,7 @@ var ModalDialog = function ModalDialog(props) {
     _props$shouldScrollIn = props.shouldScrollInViewport,
     shouldScrollInViewport = _props$shouldScrollIn === void 0 ? false : _props$shouldScrollIn,
     shouldCloseOnEscapePress = props.shouldCloseOnEscapePress,
-    providedAutoFocus = props.autoFocus,
+    autoFocus = props.autoFocus,
     stackIndex = props.stackIndex,
     onClose = props.onClose,
     onCloseComplete = props.onCloseComplete,
@@ -73,10 +73,6 @@ var ModalDialog = function ModalDialog(props) {
   var id = useId();
   var titleId = "modal-dialog-title-".concat(id);
   var defaultTestId = testId || 'modal-dialog';
-  // https://product-fabric.atlassian.net/browse/DSP-24307
-  // If flag and falsy, use true instead.
-  // When we remove boolean `autoFocus`, we won't have to worry about this
-  var autoFocus = !providedAutoFocus ? true : providedAutoFocus;
   useEffect(function () {
     // Modal dialogs can appear on top of iframe elements that are on another domain.
     // There is a Chrome bug where drag and drop in an element on top of a cross domain
@@ -88,7 +84,7 @@ var ModalDialog = function ModalDialog(props) {
 
     return combine(disableDraggingToCrossOriginIFramesForElement(), disableDraggingToCrossOriginIFramesForTextSelection(), disableDraggingToCrossOriginIFramesForExternal());
   }, []);
-  useAutoFocus(_typeof(autoFocus) === 'object' ? autoFocus : undefined,
+  useAutoFocus(autoFocus,
   // When a user supplies  a ref to focus we enable this hook
   _typeof(autoFocus) === 'object');
   var _useOnMotionFinish = useOnMotionFinish({

package/dist/esm/internal/components/modal-wrapper.compiled.css

@@ -1,7 +1,24 @@
+
 ._152tze3t{inset-block-start:var(--ds-space-0,0)}
 ._18m91wug{overflow-y:auto}
 ._1bsbauwl{width:100vw}
+._1dg11kw7>form:only-child{flex-direction:inherit}
 ._1e02ze3t{inset-inline-start:var(--ds-space-0,0)}
+._1e0c1txw{display:flex}
+._1mq81kw7>form:only-child{display:inherit}
+._1q1l1bhr{--ds-elevation-surface-current:var(--ds-surface-overlay,#fff)}
+._1tke1kxc{min-height:100vh}
+._2lx21bp4{flex-direction:column}
 ._4t3i1kxc{height:100vh}
+._4t3i1osq{height:100%}
 ._8am5i4x0{-webkit-overflow-scrolling:touch}
-._kqsw1n9t{position:fixed}
+._bfhk1bhr{background-color:var(--ds-surface-overlay,#fff)}
+._c71lglyw{max-height:none}
+._kqsw1n9t{position:fixed}
+._lcxv1wug{pointer-events:auto}
+._m01u1kw7>form:only-child{max-height:inherit}
+._syazi7uo{color:var(--ds-text,#292a2e)}._128mdkaa:focus-visible{outline-width:var(--ds-border-width-focused,2px)}
+._1ah3dkaa:focus-visible{outline-offset:var(--ds-border-width-focused,2px)}
+._mizu1v1w:focus-visible{outline-color:var(--ds-border-focused,#4688ec)}
+._ra3xnqa1:focus-visible{outline-style:solid}
+@media (min-width:30rem){._bolhzwhf._bolhzwhf{max-height:calc(100vh - 119px)}._epkxfajl{border-radius:var(--ds-radius-small,3px)}._epkxpb1k{border-radius:var(--ds-radius-xlarge,9pt)}._zg7p130s{box-shadow:var(--ds-shadow-overlay,0 8px 9pt #1e1f2126,0 0 1px #1e1f214f)}}