@mittwald/flow-react-components 1.5.39 → 1.5.41

package/dist/types/lib/controller/overlay/OverlayController.d.ts

@@ -1,16 +1,13 @@
+import { OverlayState, OverlayCloseHandler, OverlayCloseOptions, OverlayOpenHandler, OverlayOpenStateHandler } from '../../../_bundled/flow-components-base/index';
 import { DependencyList } from 'react';
 import { FlowComponentName } from '../../../components/propTypes';
-export type OverlayOpenHandler = () => unknown;
-export type OverlayCloseHandler = () => unknown;
-export type OverlayOpenStateHandler = (isOpen: boolean) => unknown;
-type DisposerFn = () => void;
-export interface CloseOverlayOptions {
+export type { OverlayCloseHandler, OverlayOpenHandler, OverlayOpenStateHandler, } from '../../../_bundled/flow-components-base/index';
+export interface CloseOverlayOptions extends OverlayCloseOptions {
     /**
      * The overlay to close. Omitted, the nearest enclosing overlay is closed –
      * the same thing `closeOverlay={true}` means.
      */
     overlay?: FlowComponentName | OverlayController;
-    bypassConfirmation?: boolean;
 }
 export interface OnOverlayClosedOptions {
     dependencies?: DependencyList;
@@ -35,48 +32,17 @@ export interface OverlayControllerOptions {
      */
     confirmOnClose?: boolean;
 }
-type ConstructorOptions = Pick<OverlayControllerOptions, "isDefaultOpen" | "confirmOnClose">;
-export declare class OverlayController {
-    isOpen: boolean;
-    isContentSuspended: boolean;
-    private onOpenHandlers;
-    private onCloseHandlers;
-    private onOpenChangeHandlers;
-    showConfirmationModal: boolean;
-    closeIsConfirmed: boolean;
-    private readonly confirmOnCloseFromOptions;
-    /**
-     * Every mounted component that has an opinion on close confirmation
-     * contributes one entry here – e.g. a `Modal` with a `confirmOnClose` prop
-     * and a `Form` tracking its dirty state. Combining them instead of assigning
-     * a single flag keeps them from overwriting each other.
-     */
-    private confirmOnCloseSources;
-    /**
-     * Active grants that allow closing without a confirmation. Each entry is
-     * scoped to an ongoing operation that legitimately closes the overlay – e.g.
-     * a `Form` submit – and is dropped again when that operation has finished, so
-     * an operation that does _not_ close the overlay leaves the confirmation
-     * armed.
-     */
-    private closeWithoutConfirmationGrants;
-    /**
-     * The open state a `setOpen` call is currently applying. Handlers run before
-     * `isOpen` is assigned, so a handler that calls `setOpen` again would not be
-     * caught by the equality check at the top and would recurse.
-     */
-    private openStateInFlight;
-    constructor(options?: ConstructorOptions);
-    /** Whether closing this overlay currently requires a confirmation. */
-    get confirmOnCloseEnabled(): boolean;
+/**
+ * The state is `OverlayState` from `@mittwald/flow-components-base`, shared
+ * with every remote binding; this adds the hooks.
+ */
+export declare class OverlayController extends OverlayState<CloseOptions> {
     useUpdateOptions(options?: OverlayControllerOptions): void;
     /**
      * Registers the calling component as a close confirmation source for as long
      * as it is mounted. `undefined` contributes nothing at all.
      */
     private useConfirmOnCloseSource;
-    private setConfirmOnCloseSource;
-    private removeConfirmOnCloseSource;
     /**
      * Can be used to execute a callback when the Overlay has unmounted – means
      * after any closing animation.
@@ -85,27 +51,7 @@ export declare class OverlayController {
      */
     useOnClosed(callback: () => unknown, options?: OnOverlayClosedOptions): void;
     static useNew(options?: OverlayControllerOptions): OverlayController;
-    private addOpenStateHandler;
     private useOnHandler;
-    private executeHandlers;
-    private executeOnClose;
-    private executeOnOpen;
-    private executeOnOpenChange;
-    addOnClose(handler: OverlayCloseHandler): DisposerFn;
-    addOnOpen(handler: OverlayOpenHandler): DisposerFn;
-    addOnOpenChange(handler: OverlayOpenStateHandler): DisposerFn;
-    open(): void;
-    close(options?: CloseOptions): void;
-    toggle(): void;
-    setOpen(toOpen: boolean, options?: CloseOptions): void;
-    /**
-     * Sets the open state without running any handler. Use it to mirror a
-     * controlled `isOpen` prop, whose change comes from the consumer – notifying
-     * them of their own state would echo it back.
-     */
-    syncOpen(toOpen: boolean): void;
-    private applyOpenState;
-    setIsContentSuspended(to: boolean): void;
     useIsOpen(): boolean;
     useIsContentSuspended(): boolean;
     useShowConfirmationModal(): boolean;
@@ -115,16 +61,4 @@ export declare class OverlayController {
         readonly cancel: () => void;
         readonly confirm: () => void;
     } | undefined;
-    /**
-     * Allows closing this overlay without a confirmation until the returned
-     * disposer is called. Use it around an operation that may legitimately close
-     * the overlay – e.g. a `Form` submit, where a "discard unsaved changes?"
-     * prompt would be nonsense – and dispose it as soon as that operation has
-     * finished. An operation that ends without closing the overlay therefore
-     * leaves the confirmation armed (#2775).
-     */
-    grantCloseWithoutConfirmation(): DisposerFn;
-    confirmClose(): void;
-    cancelConfirmation(): void;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/flow-react-components",
-  "version": "1.5.39",
+  "version": "1.5.41",
   "type": "module",
   "description": "A React implementation of Flow, mittwald’s design system",
   "homepage": "https://flow.mittwald.de",
@@ -84,9 +84,9 @@
     "@internationalized/string-compiler": "^3.4.1",
     "@lezer/common": "^1.5.2",
     "@lezer/highlight": "^1.2.3",
-    "@mittwald/flow-icons": "^1.5.39",
+    "@mittwald/flow-icons": "^1.5.41",
     "@mittwald/password-tools-js": "^3.0.0",
-    "@mittwald/react-tunnel": "^1.5.39",
+    "@mittwald/react-tunnel": "^1.5.41",
     "@mittwald/react-use-promise": "^4.2.2",
     "@react-aria/form": "^3.2.1",
     "@react-aria/i18n": "^3.13.1",
@@ -139,13 +139,13 @@
     "@internationalized/date": "^3.12.3",
     "@lezer/generator": "^1.8.0",
     "@lezer/lr": "^1.4.10",
-    "@mittwald/flow-components-base": "1.5.39",
-    "@mittwald/flow-core": "1.5.39",
-    "@mittwald/flow-design-tokens": "1.5.39",
-    "@mittwald/flow-icons-base": "1.5.39",
+    "@mittwald/flow-components-base": "1.5.41",
+    "@mittwald/flow-core": "1.5.41",
+    "@mittwald/flow-design-tokens": "1.5.41",
+    "@mittwald/flow-icons-base": "1.5.41",
     "@mittwald/react-use-promise": "^4.2.2",
     "@mittwald/remote-dom-react": "1.2.2-mittwald.10",
-    "@mittwald/typescript-config": "1.5.39",
+    "@mittwald/typescript-config": "1.5.41",
     "@nx/storybook": "^22.7.6",
     "@storybook/addon-a11y": "^10.5.10",
     "@storybook/addon-actions": "^9.0.8",
@@ -199,7 +199,7 @@
   },
   "peerDependencies": {
     "@internationalized/date": "^3.12.2",
-    "@mittwald/flow-icons-pro": "1.5.39",
+    "@mittwald/flow-icons-pro": "1.5.41",
     "@mittwald/react-use-promise": "^4.2.2",
     "next": "^16.2.3",
     "react": "^19.2.0",
@@ -223,5 +223,5 @@
   "browserslist": [
     "baseline widely available"
   ],
-  "gitHead": "8c64cc3870d11c76b8b72709d48857e4e1d6b736"
+  "gitHead": "cf4d4ef710dab68d8041026fb8cfb43ce61f8990"
 }