@atlaskit/top-layer 4.0.0 → 4.2.0

package/dist/types/dialog/types.d.ts

@@ -11,6 +11,10 @@ import type { StrictXCSSProp } from '@atlaskit/css';
  * produces. The consumer simply sets `isOpen={false}`.
  */
 export type TDialogCloseReason = 'escape' | 'overlay-click';
+/**
+ * User interactions that are allowed to dismiss the dialog.
+ */
+export type TDialogDismissedBy = 'none' | 'escape' | 'escape-and-outside-click';
 /**
  * Props shared across `TDialogProps` variants.
  *
@@ -40,14 +44,24 @@ type TDialogBaseProps = {
      */
     isOpen: boolean;
     /**
-     * Called when the user triggers close via Escape or backdrop click.
+     * Called after the dialog closes through an allowed Escape or backdrop interaction.
      *
-     * The dialog does **not** close itself. The consumer decides whether to
-     * set `isOpen={false}` (e.g. gate by reason).
+     * User dismissal cannot be rejected from this callback. The consumer must set
+     * `isOpen={false}` in response to synchronize controlled state with the native dialog.
      */
     onClose: (args: {
         reason: TDialogCloseReason;
     }) => void;
+    /**
+     * Controls which user actions can dismiss the dialog.
+     *
+     * - `'escape-and-outside-click'`: Escape and outside click.
+     * - `'escape'`: Escape only.
+     * - `'none'`: no user action.
+     *
+     * Defaults to `'escape-and-outside-click'`.
+     */
+    dismissedBy?: TDialogDismissedBy;
     /**
      * Whether the dialog should animate in and out.
      *

package/dist/types/entry-points/dialog.d.ts

@@ -1,2 +1,2 @@
 export { createCloseEvent, Dialog } from '../dialog';
-export type { TDialogCloseReason, TDialogProps } from '../dialog';
+export type { TDialogCloseReason, TDialogDismissedBy, TDialogProps } from '../dialog';

package/dist/types/internal/use-animated-visibility.d.ts

@@ -42,6 +42,12 @@ type TUseAnimatedVisibilityResult = {
      * trapping, listeners that must outlive the exit).
      */
     phase: TPhase;
+    /**
+     * Notifies the visibility lifecycle after the primitive has finished its
+     * own native toggle handling. Closing toggles make native dismissal
+     * authoritative while preserving primitive-specific handler ordering.
+     */
+    onToggle: (event: ToggleEvent) => void;
 };
 /**
  * Visibility lifecycle phase shared between `useAnimatedVisibility`,
@@ -93,7 +99,7 @@ export type TPhase = 'closed' | 'entering' | 'open' | 'exiting';
  * `entering`, `open`, `exiting`). The host element is rendered while
  * `phase !== 'closed'`, so the `exiting` phase keeps the host mounted
  * while the CSS exit transition plays (or, with animation disabled,
- * while we wait for the browser `toggle` / `close` event to fire on the
+ * while we wait for the browser's closing `toggle` event to fire on the
  * still-attached element):
  *
  * ```

package/dist/types/popover/popover.d.ts

@@ -16,11 +16,7 @@ import { type TPopoverForwardedProps } from './types';
  * ### 📜 Browser dismiss is non-cancellable
  *
  * Per the popover spec, `beforetoggle` is cancellable on open transitions
- * only, not on close. Consumers that need to ignore a specific dismiss
- * (e.g. a click on a logically-associated external trigger) must reconcile
- * inside their own `onClose` handler by calling `showPopover()` again.
- * `Popover` does not self-heal so consumers do not pay a reconcile cost
- * by default.
+ * only, not on close.
  *
  * - Spec: <https://html.spec.whatwg.org/multipage/popover.html#the-popover-attribute>
  * - <https://github.com/whatwg/html/issues/8973>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/top-layer",
-	"version": "4.0.0",
+	"version": "4.2.0",
 	"description": "Low-level layering primitives based on popover and dialog",
 	"homepage": "https://atlassian.design/components/top-layer",
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",