@homebound/beam 3.68.1 → 3.69.0

package/dist/index.d.cts

@@ -7257,7 +7257,7 @@ declare enum SuperDrawerWidth {
     Normal = 1040
 }
 
-interface OpenInDrawerOpts {
+type OpenInDrawerOpts = {
     /** Invokes left, disabled if undefined. */
     onPrevClick?: () => void;
     /** Invokes right, disabled if undefined. */
@@ -7267,10 +7267,10 @@ interface OpenInDrawerOpts {
     content: ReactNode;
     /** Adds the ability to change the SuperDrawer width based on some pre-defined values */
     width?: SuperDrawerWidth;
-}
-interface OpenDetailOpts {
+};
+type OpenDetailOpts = {
     content: ReactNode;
-}
+};
 type ContentStack = {
     kind: "open";
     opts: OpenInDrawerOpts;
@@ -7279,7 +7279,7 @@ type ContentStack = {
     opts: OpenDetailOpts;
 };
 /** The public API for interacting with `useSuperDrawer`. */
-interface UseSuperDrawerHook {
+type UseSuperDrawerHook = {
     /** Opens a new drawer, throwing away the current drawer is one exists. */
     openInDrawer: (opts: OpenInDrawerOpts) => void;
     /** Closes the entire drawer, returns false is the previous drawer can't be closed. */
@@ -7304,7 +7304,7 @@ interface UseSuperDrawerHook {
      * the action.
      */
     addCanCloseDrawerDetailCheck: (canCloseCheck: CanCloseCheck) => void;
-}
+};
 declare function useSuperDrawer(): UseSuperDrawerHook;
 
 type BeamProviderProps = {
@@ -9746,6 +9746,18 @@ type MaxLinesProps = PropsWithChildren<{
 }>;
 declare function MaxLines({ maxLines, children }: MaxLinesProps): JSX.Element;
 
+type ConfirmCloseModalProps = {
+    onClose: () => void;
+    /** Called when the user chooses to stay (in addition to closing the modal). */
+    onContinue?: () => void;
+    title?: ReactNode;
+    message?: ReactNode;
+    discardText?: string;
+    continueText?: string;
+};
+/** Modal content for discarding unsaved changes (SuperDrawer close, WorkflowLayout leave, etc.). */
+declare function ConfirmCloseModal(props: ConfirmCloseModalProps): JSX.Element;
+
 interface OpenModalProps {
     /** The custom modal content to show. */
     children: JSX.Element;
@@ -9950,14 +9962,6 @@ interface SuperDrawerHeaderStructuredProps {
 }
 declare function SuperDrawerHeader(props: SuperDrawerHeaderProps | SuperDrawerHeaderStructuredProps): JSX.Element;
 
-interface ConfirmCloseModalProps {
-    onClose: () => void;
-    discardText?: string;
-    continueText?: string;
-}
-/** Modal content to appear when a close checks fails */
-declare function ConfirmCloseModal(props: ConfirmCloseModalProps): JSX.Element;
-
 type SuperDrawerContentProps = {
     children: ReactNode;
     /**
@@ -10257,6 +10261,8 @@ type WorkflowLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix"
     steps: WorkflowLayoutStep[];
     /** The step shown initially (matched against `defaultTestId(step.label)`); falls back to the first step if omitted or if it doesn't match any step. Uncontrolled — the layout owns step navigation from here. */
     defaultStep?: string;
+    /** When this returns true, Cancel / in-app route changes / tab close require confirmation. */
+    isDirty?: () => boolean;
 };
 /**
  * Workflow-header + body shell with sticky (always-visible) chrome. Contract: `docs/layouts.md`.
@@ -10268,7 +10274,7 @@ type WorkflowLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix"
  *
  * Owns the workflow's fixed CTA set (Back/Cancel/Save & Exit/Continue-or-Complete) via `WorkflowActions`
  * so it can move them into a mobile footer at the `sm` breakpoint — `WorkflowHeader` itself is not part
- * of the public API.
+ * of the public API. Pass `isDirty` to confirm before Cancel, in-app navigation, or tab close.
  */
 declare function WorkflowLayout(props: WorkflowLayoutProps): JSX.Element;
 
@@ -10297,8 +10303,6 @@ declare const zIndices: {
     readonly tableActions: 45;
     readonly scrollToTop: 50;
     readonly scrollShadow: 50;
-    readonly superDrawerScrim: 55;
-    readonly modalUnderlay: 60;
     readonly pageStickyHeader: 70;
     readonly pageStickyFooter: 70;
     readonly dragHandle: 80;
@@ -10307,6 +10311,8 @@ declare const zIndices: {
     readonly navbarMobileMenuScrim: 124;
     readonly navbarMobileMenu: 125;
     readonly environmentBanner: 130;
+    readonly superDrawerScrim: 140;
+    readonly modalUnderlay: 150;
     readonly pageOverlay: 1000;
     readonly snackbar: 1100;
 };

package/dist/index.d.ts

@@ -7257,7 +7257,7 @@ declare enum SuperDrawerWidth {
     Normal = 1040
 }
 
-interface OpenInDrawerOpts {
+type OpenInDrawerOpts = {
     /** Invokes left, disabled if undefined. */
     onPrevClick?: () => void;
     /** Invokes right, disabled if undefined. */
@@ -7267,10 +7267,10 @@ interface OpenInDrawerOpts {
     content: ReactNode;
     /** Adds the ability to change the SuperDrawer width based on some pre-defined values */
     width?: SuperDrawerWidth;
-}
-interface OpenDetailOpts {
+};
+type OpenDetailOpts = {
     content: ReactNode;
-}
+};
 type ContentStack = {
     kind: "open";
     opts: OpenInDrawerOpts;
@@ -7279,7 +7279,7 @@ type ContentStack = {
     opts: OpenDetailOpts;
 };
 /** The public API for interacting with `useSuperDrawer`. */
-interface UseSuperDrawerHook {
+type UseSuperDrawerHook = {
     /** Opens a new drawer, throwing away the current drawer is one exists. */
     openInDrawer: (opts: OpenInDrawerOpts) => void;
     /** Closes the entire drawer, returns false is the previous drawer can't be closed. */
@@ -7304,7 +7304,7 @@ interface UseSuperDrawerHook {
      * the action.
      */
     addCanCloseDrawerDetailCheck: (canCloseCheck: CanCloseCheck) => void;
-}
+};
 declare function useSuperDrawer(): UseSuperDrawerHook;
 
 type BeamProviderProps = {
@@ -9746,6 +9746,18 @@ type MaxLinesProps = PropsWithChildren<{
 }>;
 declare function MaxLines({ maxLines, children }: MaxLinesProps): JSX.Element;
 
+type ConfirmCloseModalProps = {
+    onClose: () => void;
+    /** Called when the user chooses to stay (in addition to closing the modal). */
+    onContinue?: () => void;
+    title?: ReactNode;
+    message?: ReactNode;
+    discardText?: string;
+    continueText?: string;
+};
+/** Modal content for discarding unsaved changes (SuperDrawer close, WorkflowLayout leave, etc.). */
+declare function ConfirmCloseModal(props: ConfirmCloseModalProps): JSX.Element;
+
 interface OpenModalProps {
     /** The custom modal content to show. */
     children: JSX.Element;
@@ -9950,14 +9962,6 @@ interface SuperDrawerHeaderStructuredProps {
 }
 declare function SuperDrawerHeader(props: SuperDrawerHeaderProps | SuperDrawerHeaderStructuredProps): JSX.Element;
 
-interface ConfirmCloseModalProps {
-    onClose: () => void;
-    discardText?: string;
-    continueText?: string;
-}
-/** Modal content to appear when a close checks fails */
-declare function ConfirmCloseModal(props: ConfirmCloseModalProps): JSX.Element;
-
 type SuperDrawerContentProps = {
     children: ReactNode;
     /**
@@ -10257,6 +10261,8 @@ type WorkflowLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix"
     steps: WorkflowLayoutStep[];
     /** The step shown initially (matched against `defaultTestId(step.label)`); falls back to the first step if omitted or if it doesn't match any step. Uncontrolled — the layout owns step navigation from here. */
     defaultStep?: string;
+    /** When this returns true, Cancel / in-app route changes / tab close require confirmation. */
+    isDirty?: () => boolean;
 };
 /**
  * Workflow-header + body shell with sticky (always-visible) chrome. Contract: `docs/layouts.md`.
@@ -10268,7 +10274,7 @@ type WorkflowLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix"
  *
  * Owns the workflow's fixed CTA set (Back/Cancel/Save & Exit/Continue-or-Complete) via `WorkflowActions`
  * so it can move them into a mobile footer at the `sm` breakpoint — `WorkflowHeader` itself is not part
- * of the public API.
+ * of the public API. Pass `isDirty` to confirm before Cancel, in-app navigation, or tab close.
  */
 declare function WorkflowLayout(props: WorkflowLayoutProps): JSX.Element;
 
@@ -10297,8 +10303,6 @@ declare const zIndices: {
     readonly tableActions: 45;
     readonly scrollToTop: 50;
     readonly scrollShadow: 50;
-    readonly superDrawerScrim: 55;
-    readonly modalUnderlay: 60;
     readonly pageStickyHeader: 70;
     readonly pageStickyFooter: 70;
     readonly dragHandle: 80;
@@ -10307,6 +10311,8 @@ declare const zIndices: {
     readonly navbarMobileMenuScrim: 124;
     readonly navbarMobileMenu: 125;
     readonly environmentBanner: 130;
+    readonly superDrawerScrim: 140;
+    readonly modalUnderlay: 150;
     readonly pageOverlay: 1000;
     readonly snackbar: 1100;
 };