@okyrychenko-dev/react-action-guard-router 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +519 -0
- package/dist/index.cjs +91 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +158 -0
- package/dist/index.d.ts +158 -0
- package/dist/index.js +84 -0
- package/dist/index.js.map +1 -0
- package/dist/nextjs/index.cjs +178 -0
- package/dist/nextjs/index.cjs.map +1 -0
- package/dist/nextjs/index.d.cts +120 -0
- package/dist/nextjs/index.d.ts +120 -0
- package/dist/nextjs/index.js +174 -0
- package/dist/nextjs/index.js.map +1 -0
- package/dist/react-router/index.cjs +193 -0
- package/dist/react-router/index.cjs.map +1 -0
- package/dist/react-router/index.d.cts +137 -0
- package/dist/react-router/index.d.ts +137 -0
- package/dist/react-router/index.js +189 -0
- package/dist/react-router/index.js.map +1 -0
- package/dist/tanstack-router/index.cjs +172 -0
- package/dist/tanstack-router/index.cjs.map +1 -0
- package/dist/tanstack-router/index.d.cts +75 -0
- package/dist/tanstack-router/index.d.ts +75 -0
- package/dist/tanstack-router/index.js +170 -0
- package/dist/tanstack-router/index.js.map +1 -0
- package/dist/types-C3CPuZip.d.cts +105 -0
- package/dist/types-C3CPuZip.d.ts +105 -0
- package/package.json +139 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/core/utils.ts","../../src/core/useBeforeUnload.ts","../../src/core/useShouldBlock.ts","../../src/react-router/useNavigationBlocker.ts","../../src/react-router/usePrompt.ts"],"names":["useEffect","useMemo","useIsBlocked","useRef","useState","useBlocker","useCallback"],"mappings":";;;;;;;;;AAMO,SAAS,iBAAiB,SAAA,EAA+C;AAC9E,EAAA,OAAO,OAAO,SAAA,KAAc,UAAA,GAAa,SAAA,EAAU,GAAI,SAAA;AACzD;AAMA,IAAM,OAAA,GAAU,CAAC,KAAA,KACf,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,MAAA,IAAU,KAAA;AAKpD,SAAS,WAAc,KAAA,EAAyC;AACrE,EAAA,IAAI,CAAC,OAAA,CAAQ,KAAK,CAAA,EAAG;AACnB,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,MAAM,IAAA,KAAS,UAAA;AAC/B;AAiBO,SAAS,oBAAA,CACd,OAAA,EACA,SAAA,EACA,eAAA,EACe;AACf,EAAA,IAAI,CAAC,SAAA,EAAW;AACd,IAAA,OAAO,EAAE,IAAA,EAAM,MAAA,EAAQ,SAAA,EAAW,eAAA,CAAgB,OAAO,CAAA,EAAE;AAAA,EAC7D;AAEA,EAAA,MAAM,MAAA,GAAS,UAAU,OAAO,CAAA;AAChC,EAAA,IAAI,UAAA,CAAoB,MAAM,CAAA,EAAG;AAC/B,IAAA,OAAO,EAAE,IAAA,EAAM,OAAA,EAAS,SAAS,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAA,EAAE;AAAA,EAC3D;AAEA,EAAA,OAAO,EAAE,IAAA,EAAM,MAAA,EAAQ,SAAA,EAAW,MAAA,EAAO;AAC3C;AAqBO,SAAS,UAAa,KAAA,EAAyC;AACpE,EAAA,OAAO,KAAA,KAAU,UAAa,KAAA,KAAU,IAAA;AAC1C;AAQO,SAAS,eAAe,KAAA,EAA0D;AACvF,EAAA,IAAI,CAAC,KAAA,EAAO;AACV,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,MAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAA,GAAQ,CAAC,KAAK,CAAA;AAC9C;;;ACvFO,IAAM,sBAAA,GAAyB,oCAAA;AAmC/B,SAAS,eAAA,CACd,IAAA,EACA,OAAA,GAAU,sBAAA,EACJ;AACN,EAAAA,eAAA,CAAU,MAAM;AACd,IAAA,MAAM,WAAA,GAAc,iBAAiB,IAAI,CAAA;AAEzC,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,kBAAA,GAAqB,CAAC,KAAA,KAAmC;AAE7D,MAAA,KAAA,CAAM,cAAA,EAAe;AAGrB,MAAA,IAAI,iBAAiB,KAAA,EAAO;AAE1B,QAAA,KAAA,CAAM,WAAA,GAAc,OAAA;AAAA,MACtB;AAAA,IACF,CAAA;AAEA,IAAA,MAAA,CAAO,gBAAA,CAAiB,gBAAgB,kBAAkB,CAAA;AAE1D,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,CAAO,mBAAA,CAAoB,gBAAgB,kBAAkB,CAAA;AAAA,IAC/D,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,IAAA,EAAM,OAAO,CAAC,CAAA;AACpB;ACpDO,SAAS,cAAA,CACd,MACA,KAAA,EACS;AAET,EAAA,MAAM,MAAA,GAASC,cAAQ,MAAM,cAAA,CAAe,KAAK,CAAA,EAAG,CAAC,KAAK,CAAC,CAAA;AAG3D,EAAA,MAAM,cAAA,GAAiBC,8BAAa,MAAA,CAAO,MAAA,KAAW,IAAI,MAAA,CAAO,CAAC,IAAI,MAAM,CAAA;AAG5E,EAAA,MAAM,yBAAA,GAA4BC,aAAO,KAAK,CAAA;AAC9C,EAAA,MAAM,iBAAA,GAAoBA,aAAO,KAAK,CAAA;AAEtC,EAAAH,gBAAU,MAAM;AACd,IAAA,IAAI,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,aAAA,EAAe;AAC1C,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,0BAA0B,OAAA,IAAW,CAAC,UAAU,IAAI,CAAA,IAAK,CAAC,KAAA,EAAO;AACpE,MAAA,yBAAA,CAA0B,OAAA,GAAU,IAAA;AACpC,MAAA,OAAA,CAAQ,IAAA;AAAA,QACN;AAAA,OAEF;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,iBAAA,CAAkB,OAAA,IAAW,OAAO,SAAS,UAAA,EAAY;AAC5D,MAAA,iBAAA,CAAkB,OAAA,GAAU,IAAA;AAC5B,MAAA,OAAA,CAAQ,IAAA;AAAA,QACN;AAAA,OAEF;AAAA,IACF;AAAA,EACF,CAAA,EAAG,CAAC,IAAA,EAAM,KAAK,CAAC,CAAA;AAIhB,EAAA,MAAM,WAAA,GAAcC,cAAQ,MAAM;AAChC,IAAA,IAAI,cAAA,GAAiB,KAAA;AAGrB,IAAA,IAAI,SAAA,CAAU,IAAI,CAAA,EAAG;AACnB,MAAA,cAAA,GAAiB,iBAAiB,IAAI,CAAA;AAAA,IACxC;AAGA,IAAA,IAAI,SAAS,cAAA,EAAgB;AAC3B,MAAA,cAAA,GAAiB,IAAA;AAAA,IACnB;AAEA,IAAA,OAAO,cAAA;AAAA,EACT,CAAA,EAAG,CAAC,IAAA,EAAM,KAAA,EAAO,cAAc,CAAC,CAAA;AAEhC,EAAA,OAAO,WAAA;AACT;;;ACLO,SAAS,qBACd,OAAA,EACyB;AACzB,EAAA,MAAM;AAAA,IACJ,IAAA;AAAA,IACA,KAAA;AAAA,IACA,OAAA;AAAA,IACA,kBAAA,GAAqB,IAAA;AAAA;AAAA,IAErB,KAAA;AAAA;AAAA,IACA,OAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,MAAM,aAAA,GAAgBE,aAAO,CAAC,CAAA;AAC9B,EAAA,MAAM,CAAC,cAAA,EAAgB,iBAAiB,CAAA,GAAIC,eAGlC,IAAI,CAAA;AAGd,EAAA,MAAM,WAAA,GAAc,cAAA,CAAe,IAAA,IAAQ,KAAA,EAAO,KAAK,CAAA;AAGvD,EAAA,MAAM,OAAA,GAAUC,yBAAA;AAAA,IACdC,kBAAY,MAAM;AAEhB,MAAA,IAAI,CAAC,WAAA,EAAa;AAChB,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,OAAA,IAAU;AAGV,MAAA,IAAI,CAAC,OAAA,EAAS;AACZ,QAAA,OAAO,IAAA;AAAA,MACT;AAEA,MAAA,MAAM,YAAA,GAAe,oBAAA;AAAA,QAAqB,OAAA;AAAA,QAAS,SAAA;AAAA,QAAW,CAAC,KAAA,KAC7D,MAAA,CAAO,OAAA,CAAQ,KAAK;AAAA,OACtB;AAEA,MAAA,IAAI,YAAA,CAAa,SAAS,OAAA,EAAS;AACjC,QAAA,MAAM,EAAA,GAAK,EAAE,aAAA,CAAc,OAAA;AAC3B,QAAA,iBAAA,CAAkB,EAAE,EAAA,EAAI,OAAA,EAAS,YAAA,CAAa,SAAS,CAAA;AACvD,QAAA,OAAO,IAAA;AAAA,MACT;AAEA,MAAA,IAAI,aAAa,SAAA,EAAW;AAC1B,QAAA,OAAA,IAAU;AACV,QAAA,OAAO,KAAA;AAAA,MACT;AAEA,MAAA,OAAO,IAAA;AAAA,IACT,GAAG,CAAC,WAAA,EAAa,SAAS,OAAA,EAAS,SAAA,EAAW,OAAO,CAAC;AAAA,GACxD;AAEA,EAAAN,gBAAU,MAAM;AACd,IAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,MAAA,GAAS,IAAA;AACb,IAAA,MAAM,EAAE,EAAA,EAAI,OAAA,EAAQ,GAAI,cAAA;AAExB,IAAA,OAAA,CACG,IAAA,CAAK,CAAC,SAAA,KAAc;AACnB,MAAA,IAAI,CAAC,MAAA,IAAU,EAAA,KAAO,aAAA,CAAc,OAAA,EAAS;AAC3C,QAAA;AAAA,MACF;AACA,MAAA,IAAI,SAAA,EAAW;AACb,QAAA,OAAA,IAAU;AACV,QAAA,OAAA,CAAQ,OAAA,IAAU;AAAA,MACpB,CAAA,MAAO;AACL,QAAA,OAAA,CAAQ,KAAA,IAAQ;AAAA,MAClB;AAAA,IACF,CAAC,CAAA,CACA,KAAA,CAAM,MAAM;AACX,MAAA,IAAI,MAAA,IAAU,EAAA,KAAO,aAAA,CAAc,OAAA,EAAS;AAC1C,QAAA,OAAA,CAAQ,KAAA,IAAQ;AAAA,MAClB;AAAA,IACF,CAAC,CAAA,CACA,OAAA,CAAQ,MAAM;AACb,MAAA,IAAI,MAAA,IAAU,EAAA,KAAO,aAAA,CAAc,OAAA,EAAS;AAC1C,QAAA,iBAAA,CAAkB,IAAI,CAAA;AAAA,MACxB;AAAA,IACF,CAAC,CAAA;AAEH,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,GAAS,KAAA;AAAA,IACX,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,cAAA,EAAgB,OAAA,EAAS,OAAO,CAAC,CAAA;AAGrC,EAAA,eAAA,CAAgB,kBAAA,IAAsB,WAAA,EAAa,OAAA,IAAW,sBAAsB,CAAA;AAEpF,EAAA,OAAO;AAAA,IACL,UAAA,EAAY,WAAA;AAAA,IACZ,cAAA,EAAgB,QAAQ,KAAA,KAAU;AAAA,GACpC;AACF;;;AClIO,SAAS,SAAA,CAAU,SAAiB,IAAA,EAAuC;AAChF,EAAA,oBAAA,CAAqB;AAAA,IACnB,IAAA;AAAA,IACA,OAAA;AAAA,IACA,kBAAA,EAAoB;AAAA,GACrB,CAAA;AACH;AAeO,SAAS,qBAAqB,OAAA,EAAiC;AACpE,EAAA,oBAAA,CAAqB;AAAA,IACnB,GAAG,OAAA;AAAA,IACH,kBAAA,EAAoB,QAAQ,kBAAA,IAAsB;AAAA,GACnD,CAAA;AACH","file":"index.cjs","sourcesContent":["/**\n * Resolves a condition value (boolean or function returning boolean)\n *\n * @param condition - Boolean value or function\n * @returns Resolved boolean value\n */\nexport function resolveCondition(condition: boolean | (() => boolean)): boolean {\n return typeof condition === \"function\" ? condition() : condition;\n}\n\ninterface Thenable {\n then: (...args: Array<unknown>) => unknown;\n}\n\nconst hasThen = (value: unknown): value is Thenable =>\n typeof value === \"object\" && value !== null && \"then\" in value;\n\n/**\n * Checks if a value behaves like a Promise (thenable)\n */\nexport function isThenable<T>(value: unknown): value is PromiseLike<T> {\n if (!hasThen(value)) {\n return false;\n }\n return typeof value.then === \"function\";\n}\n\nexport interface ConfirmResultSync {\n kind: \"sync\";\n confirmed: boolean;\n}\n\nexport interface ConfirmResultAsync {\n kind: \"async\";\n promise: Promise<boolean>;\n}\n\nexport type ConfirmResult = ConfirmResultSync | ConfirmResultAsync;\n\n/**\n * Normalizes custom confirm result into sync or async branch.\n */\nexport function resolveConfirmResult(\n message: string,\n onConfirm: ((message: string) => boolean | PromiseLike<boolean>) | undefined,\n fallbackConfirm: (message: string) => boolean\n): ConfirmResult {\n if (!onConfirm) {\n return { kind: \"sync\", confirmed: fallbackConfirm(message) };\n }\n\n const result = onConfirm(message);\n if (isThenable<boolean>(result)) {\n return { kind: \"async\", promise: Promise.resolve(result) };\n }\n\n return { kind: \"sync\", confirmed: result };\n}\n\n/**\n * Generates a unique blocker ID based on scope and timestamp\n *\n * @param prefix - Prefix for the ID\n * @param scope - Optional scope\n * @returns Unique blocker ID\n */\nexport function createBlockerId(prefix: string, scope?: string | Array<string>): string {\n const scopePart = scope ? `-${Array.isArray(scope) ? scope.join(\"-\") : scope}` : \"\";\n const timestamp = String(Date.now());\n return `${prefix}${scopePart}-${timestamp}`;\n}\n\n/**\n * Checks if a value is defined and not empty\n *\n * @param value - Value to check\n * @returns True if value is defined and not empty\n */\nexport function isDefined<T>(value: T | undefined | null): value is T {\n return value !== undefined && value !== null;\n}\n\n/**\n * Normalizes scope to an array\n *\n * @param scope - String or array of strings\n * @returns Array of scope strings\n */\nexport function normalizeScope(scope: string | Array<string> | undefined): Array<string> {\n if (!scope) {\n return [];\n }\n return Array.isArray(scope) ? scope : [scope];\n}\n","import { useEffect } from \"react\";\nimport { resolveCondition } from \"./utils\";\n\n/**\n * Default message shown when preventing browser unload\n */\nexport const DEFAULT_UNLOAD_MESSAGE = \"Changes you made may not be saved.\";\n\n/**\n * Blocks browser tab close/refresh when condition is met.\n *\n * This hook adds a `beforeunload` event listener to warn users\n * before they close or refresh the browser tab. Modern browsers\n * may ignore custom messages and show their own generic warning.\n *\n * @param when - Boolean or function returning boolean to determine if blocking should be active\n * @param message - Optional custom message (may be ignored by browsers)\n *\n * @example\n * ```tsx\n * function MyForm() {\n * const [hasUnsavedChanges, setHasUnsavedChanges] = useState(false);\n *\n * useBeforeUnload(hasUnsavedChanges, 'You have unsaved changes');\n *\n * return <form>...</form>;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // With function condition\n * function EditPage() {\n * const isFormDirty = useIsBlocked('form');\n *\n * useBeforeUnload(() => isFormDirty);\n *\n * return <div>...</div>;\n * }\n * ```\n */\nexport function useBeforeUnload(\n when: boolean | (() => boolean),\n message = DEFAULT_UNLOAD_MESSAGE\n): void {\n useEffect(() => {\n const shouldBlock = resolveCondition(when);\n\n if (!shouldBlock) {\n return;\n }\n\n const handleBeforeUnload = (event: BeforeUnloadEvent): void => {\n // Prevent default to trigger the browser's confirmation dialog\n event.preventDefault();\n\n // Fallback for legacy browsers/WebViews that still rely on returnValue.\n if (\"returnValue\" in event) {\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n event.returnValue = message;\n }\n };\n\n window.addEventListener(\"beforeunload\", handleBeforeUnload);\n\n return () => {\n window.removeEventListener(\"beforeunload\", handleBeforeUnload);\n };\n }, [when, message]);\n}\n","import { useIsBlocked } from \"@okyrychenko-dev/react-action-guard\";\nimport { useEffect, useMemo, useRef } from \"react\";\nimport { isDefined, normalizeScope, resolveCondition } from \"./utils\";\n\n/**\n * Shared hook to determine if blocking should be active based on\n * condition and/or scope state.\n *\n * This hook uses `useMemo` for optimal performance, ensuring blocking state\n * is computed synchronously without additional re-renders.\n *\n * @param when - Optional condition (boolean or function)\n * @param scope - Optional scope(s) to check\n * @returns Whether blocking should be active\n *\n * @internal\n */\nexport function useShouldBlock(\n when?: boolean | (() => boolean),\n scope?: string | Array<string>\n): boolean {\n // Memoize scope normalization to avoid recalculation on every render\n const scopes = useMemo(() => normalizeScope(scope), [scope]);\n\n // Check if any specified scopes are blocked\n const isScopeBlocked = useIsBlocked(scopes.length === 1 ? scopes[0] : scopes);\n\n // Development-only validation\n const warnedMissingConditionRef = useRef(false);\n const warnedFunctionRef = useRef(false);\n\n useEffect(() => {\n if (process.env.NODE_ENV !== \"development\") {\n return;\n }\n\n if (!warnedMissingConditionRef.current && !isDefined(when) && !scope) {\n warnedMissingConditionRef.current = true;\n console.warn(\n '[react-action-guard-router] useShouldBlock: Neither \"when\" nor \"scope\" provided. ' +\n \"This hook will always return false. Please provide at least one condition.\"\n );\n }\n\n if (!warnedFunctionRef.current && typeof when === \"function\") {\n warnedFunctionRef.current = true;\n console.warn(\n '[react-action-guard-router] useShouldBlock: \"when\" is a function. ' +\n \"Make sure to wrap it with useCallback to avoid unnecessary re-computations.\"\n );\n }\n }, [when, scope]);\n\n // Compute blocking state synchronously using useMemo\n // This avoids the useState + useEffect pattern which causes an extra render\n const shouldBlock = useMemo(() => {\n let blockCondition = false;\n\n // Check manual condition\n if (isDefined(when)) {\n blockCondition = resolveCondition(when);\n }\n\n // Check scope-based blocking (OR logic - block if either condition is true)\n if (scope && isScopeBlocked) {\n blockCondition = true;\n }\n\n return blockCondition;\n }, [when, scope, isScopeBlocked]);\n\n return shouldBlock;\n}\n","import { useCallback, useEffect, useRef, useState } from \"react\";\nimport { useBlocker } from \"react-router-dom\";\nimport {\n DEFAULT_UNLOAD_MESSAGE,\n resolveConfirmResult,\n useBeforeUnload,\n useShouldBlock,\n} from \"../core\";\nimport type { UseNavigationBlockerOptions } from \"./types\";\nimport type { NavigationBlockerReturn } from \"../core/types\";\n\n/**\n * Blocks navigation in React Router v6+ applications based on conditions or scope state.\n *\n * This hook integrates React Router's `useBlocker` with react-action-guard's scope system,\n * allowing you to prevent navigation when certain conditions are met or when specific\n * scopes are blocked.\n *\n * **Features:**\n * - Block navigation based on boolean condition or function\n * - Automatically block when react-action-guard scopes are active\n * - Support for browser `beforeunload` event (tab close/refresh)\n * - Customizable confirmation dialog configuration\n * - Callbacks for block/allow events\n *\n * @param options - Configuration options\n * @returns Object with `isBlocking` state\n *\n * @example\n * ```tsx\n * // Block based on scope\n * function EditForm() {\n * useNavigationBlocker({\n * scope: 'form',\n * message: 'You have unsaved changes. Leave anyway?',\n * });\n *\n * return <form>...</form>;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // Block based on condition\n * function UnsavedChanges() {\n * const [hasChanges, setHasChanges] = useState(false);\n *\n * useNavigationBlocker({\n * when: hasChanges,\n * message: 'Discard changes?',\n * onBlock: () => console.log('Navigation blocked'),\n * });\n * }\n * ```\n *\n * @example\n * ```tsx\n * // Block with custom dialog\n * function CheckoutFlow() {\n * useNavigationBlocker({\n * scope: 'checkout',\n * message: 'Your items will still be in your cart.',\n * blockBrowserUnload: true,\n * });\n * }\n * ```\n */\nexport function useNavigationBlocker(\n options: UseNavigationBlockerOptions\n): NavigationBlockerReturn {\n const {\n when,\n scope,\n message,\n blockBrowserUnload = true,\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n block, // deprecated, for backwards compatibility\n onBlock,\n onAllow,\n onConfirm,\n } = options;\n\n const confirmSeqRef = useRef(0);\n const [pendingConfirm, setPendingConfirm] = useState<{\n id: number;\n promise: Promise<boolean>;\n } | null>(null);\n\n // Use shared logic to determine if blocking should be active\n const shouldBlock = useShouldBlock(when ?? block, scope);\n\n // Use React Router's blocker\n const blocker = useBlocker(\n useCallback(() => {\n // Early return if not blocking\n if (!shouldBlock) {\n return false;\n }\n\n // Trigger onBlock callback\n onBlock?.();\n\n // If no message, just block\n if (!message) {\n return true;\n }\n\n const confirmation = resolveConfirmResult(message, onConfirm, (value) =>\n window.confirm(value)\n );\n\n if (confirmation.kind === \"async\") {\n const id = ++confirmSeqRef.current;\n setPendingConfirm({ id, promise: confirmation.promise });\n return true;\n }\n\n if (confirmation.confirmed) {\n onAllow?.();\n return false;\n }\n\n return true;\n }, [shouldBlock, message, onBlock, onConfirm, onAllow])\n );\n\n useEffect(() => {\n if (!pendingConfirm) {\n return;\n }\n\n let active = true;\n const { id, promise } = pendingConfirm;\n\n promise\n .then((confirmed) => {\n if (!active || id !== confirmSeqRef.current) {\n return;\n }\n if (confirmed) {\n onAllow?.();\n blocker.proceed?.();\n } else {\n blocker.reset?.();\n }\n })\n .catch(() => {\n if (active && id === confirmSeqRef.current) {\n blocker.reset?.();\n }\n })\n .finally(() => {\n if (active && id === confirmSeqRef.current) {\n setPendingConfirm(null);\n }\n });\n\n return () => {\n active = false;\n };\n }, [pendingConfirm, blocker, onAllow]);\n\n // Also block browser unload if requested\n useBeforeUnload(blockBrowserUnload && shouldBlock, message ?? DEFAULT_UNLOAD_MESSAGE);\n\n return {\n isBlocking: shouldBlock,\n isIntercepting: blocker.state === \"blocked\",\n };\n}\n","import { useNavigationBlocker } from \"./useNavigationBlocker\";\nimport type { UsePromptOptions } from \"./types\";\n\n/**\n * Simple prompt API similar to React Router v5's `usePrompt`.\n *\n * Shows a confirmation dialog when the user tries to navigate away\n * while the condition is true.\n *\n * This is a simpler API compared to `useNavigationBlocker` for cases\n * where you just want to show a prompt without advanced configuration.\n *\n * @param message - Message to show in confirmation dialog\n * @param when - Condition to determine when to show the prompt\n *\n * @example\n * ```tsx\n * function MyForm() {\n * const [hasUnsavedChanges, setHasUnsavedChanges] = useState(false);\n *\n * usePrompt(\n * 'You have unsaved changes. Are you sure you want to leave?',\n * hasUnsavedChanges\n * );\n *\n * return <form>...</form>;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // With function condition\n * function EditPage() {\n * const isDirty = useFormDirty();\n *\n * usePrompt('Discard unsaved changes?', () => isDirty);\n * }\n * ```\n */\nexport function usePrompt(message: string, when: boolean | (() => boolean)): void {\n useNavigationBlocker({\n when,\n message,\n blockBrowserUnload: true,\n });\n}\n\n/**\n * Hook variant that accepts options object\n *\n * @param options - Prompt configuration\n *\n * @example\n * ```tsx\n * usePromptWithOptions({\n * message: 'Leave without saving?',\n * when: hasChanges\n * });\n * ```\n */\nexport function usePromptWithOptions(options: UsePromptOptions): void {\n useNavigationBlocker({\n ...options,\n blockBrowserUnload: options.blockBrowserUnload ?? true,\n });\n}\n"]}
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { B as BaseNavigationBlockerOptions, N as NavigationBlockerReturn } from '../types-C3CPuZip.cjs';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Options for React Router navigation blocker
|
|
5
|
+
*/
|
|
6
|
+
interface UseNavigationBlockerOptions extends BaseNavigationBlockerOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Whether to block navigation
|
|
9
|
+
* @deprecated Use `when` instead for consistency across adapters
|
|
10
|
+
*/
|
|
11
|
+
block?: boolean | (() => boolean);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Simple prompt options (React Router v5 compatibility)
|
|
15
|
+
*/
|
|
16
|
+
type UsePromptOptions = Omit<BaseNavigationBlockerOptions, "message" | "when" | "scope"> & {
|
|
17
|
+
/**
|
|
18
|
+
* Message to show in confirmation dialog
|
|
19
|
+
*/
|
|
20
|
+
message: string;
|
|
21
|
+
/**
|
|
22
|
+
* When to show the prompt
|
|
23
|
+
*/
|
|
24
|
+
when: boolean | (() => boolean);
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Blocks navigation in React Router v6+ applications based on conditions or scope state.
|
|
29
|
+
*
|
|
30
|
+
* This hook integrates React Router's `useBlocker` with react-action-guard's scope system,
|
|
31
|
+
* allowing you to prevent navigation when certain conditions are met or when specific
|
|
32
|
+
* scopes are blocked.
|
|
33
|
+
*
|
|
34
|
+
* **Features:**
|
|
35
|
+
* - Block navigation based on boolean condition or function
|
|
36
|
+
* - Automatically block when react-action-guard scopes are active
|
|
37
|
+
* - Support for browser `beforeunload` event (tab close/refresh)
|
|
38
|
+
* - Customizable confirmation dialog configuration
|
|
39
|
+
* - Callbacks for block/allow events
|
|
40
|
+
*
|
|
41
|
+
* @param options - Configuration options
|
|
42
|
+
* @returns Object with `isBlocking` state
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```tsx
|
|
46
|
+
* // Block based on scope
|
|
47
|
+
* function EditForm() {
|
|
48
|
+
* useNavigationBlocker({
|
|
49
|
+
* scope: 'form',
|
|
50
|
+
* message: 'You have unsaved changes. Leave anyway?',
|
|
51
|
+
* });
|
|
52
|
+
*
|
|
53
|
+
* return <form>...</form>;
|
|
54
|
+
* }
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```tsx
|
|
59
|
+
* // Block based on condition
|
|
60
|
+
* function UnsavedChanges() {
|
|
61
|
+
* const [hasChanges, setHasChanges] = useState(false);
|
|
62
|
+
*
|
|
63
|
+
* useNavigationBlocker({
|
|
64
|
+
* when: hasChanges,
|
|
65
|
+
* message: 'Discard changes?',
|
|
66
|
+
* onBlock: () => console.log('Navigation blocked'),
|
|
67
|
+
* });
|
|
68
|
+
* }
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```tsx
|
|
73
|
+
* // Block with custom dialog
|
|
74
|
+
* function CheckoutFlow() {
|
|
75
|
+
* useNavigationBlocker({
|
|
76
|
+
* scope: 'checkout',
|
|
77
|
+
* message: 'Your items will still be in your cart.',
|
|
78
|
+
* blockBrowserUnload: true,
|
|
79
|
+
* });
|
|
80
|
+
* }
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
declare function useNavigationBlocker(options: UseNavigationBlockerOptions): NavigationBlockerReturn;
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Simple prompt API similar to React Router v5's `usePrompt`.
|
|
87
|
+
*
|
|
88
|
+
* Shows a confirmation dialog when the user tries to navigate away
|
|
89
|
+
* while the condition is true.
|
|
90
|
+
*
|
|
91
|
+
* This is a simpler API compared to `useNavigationBlocker` for cases
|
|
92
|
+
* where you just want to show a prompt without advanced configuration.
|
|
93
|
+
*
|
|
94
|
+
* @param message - Message to show in confirmation dialog
|
|
95
|
+
* @param when - Condition to determine when to show the prompt
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```tsx
|
|
99
|
+
* function MyForm() {
|
|
100
|
+
* const [hasUnsavedChanges, setHasUnsavedChanges] = useState(false);
|
|
101
|
+
*
|
|
102
|
+
* usePrompt(
|
|
103
|
+
* 'You have unsaved changes. Are you sure you want to leave?',
|
|
104
|
+
* hasUnsavedChanges
|
|
105
|
+
* );
|
|
106
|
+
*
|
|
107
|
+
* return <form>...</form>;
|
|
108
|
+
* }
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* ```tsx
|
|
113
|
+
* // With function condition
|
|
114
|
+
* function EditPage() {
|
|
115
|
+
* const isDirty = useFormDirty();
|
|
116
|
+
*
|
|
117
|
+
* usePrompt('Discard unsaved changes?', () => isDirty);
|
|
118
|
+
* }
|
|
119
|
+
* ```
|
|
120
|
+
*/
|
|
121
|
+
declare function usePrompt(message: string, when: boolean | (() => boolean)): void;
|
|
122
|
+
/**
|
|
123
|
+
* Hook variant that accepts options object
|
|
124
|
+
*
|
|
125
|
+
* @param options - Prompt configuration
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* ```tsx
|
|
129
|
+
* usePromptWithOptions({
|
|
130
|
+
* message: 'Leave without saving?',
|
|
131
|
+
* when: hasChanges
|
|
132
|
+
* });
|
|
133
|
+
* ```
|
|
134
|
+
*/
|
|
135
|
+
declare function usePromptWithOptions(options: UsePromptOptions): void;
|
|
136
|
+
|
|
137
|
+
export { type UseNavigationBlockerOptions, type UsePromptOptions, useNavigationBlocker, usePrompt, usePromptWithOptions };
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { B as BaseNavigationBlockerOptions, N as NavigationBlockerReturn } from '../types-C3CPuZip.js';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Options for React Router navigation blocker
|
|
5
|
+
*/
|
|
6
|
+
interface UseNavigationBlockerOptions extends BaseNavigationBlockerOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Whether to block navigation
|
|
9
|
+
* @deprecated Use `when` instead for consistency across adapters
|
|
10
|
+
*/
|
|
11
|
+
block?: boolean | (() => boolean);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Simple prompt options (React Router v5 compatibility)
|
|
15
|
+
*/
|
|
16
|
+
type UsePromptOptions = Omit<BaseNavigationBlockerOptions, "message" | "when" | "scope"> & {
|
|
17
|
+
/**
|
|
18
|
+
* Message to show in confirmation dialog
|
|
19
|
+
*/
|
|
20
|
+
message: string;
|
|
21
|
+
/**
|
|
22
|
+
* When to show the prompt
|
|
23
|
+
*/
|
|
24
|
+
when: boolean | (() => boolean);
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Blocks navigation in React Router v6+ applications based on conditions or scope state.
|
|
29
|
+
*
|
|
30
|
+
* This hook integrates React Router's `useBlocker` with react-action-guard's scope system,
|
|
31
|
+
* allowing you to prevent navigation when certain conditions are met or when specific
|
|
32
|
+
* scopes are blocked.
|
|
33
|
+
*
|
|
34
|
+
* **Features:**
|
|
35
|
+
* - Block navigation based on boolean condition or function
|
|
36
|
+
* - Automatically block when react-action-guard scopes are active
|
|
37
|
+
* - Support for browser `beforeunload` event (tab close/refresh)
|
|
38
|
+
* - Customizable confirmation dialog configuration
|
|
39
|
+
* - Callbacks for block/allow events
|
|
40
|
+
*
|
|
41
|
+
* @param options - Configuration options
|
|
42
|
+
* @returns Object with `isBlocking` state
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```tsx
|
|
46
|
+
* // Block based on scope
|
|
47
|
+
* function EditForm() {
|
|
48
|
+
* useNavigationBlocker({
|
|
49
|
+
* scope: 'form',
|
|
50
|
+
* message: 'You have unsaved changes. Leave anyway?',
|
|
51
|
+
* });
|
|
52
|
+
*
|
|
53
|
+
* return <form>...</form>;
|
|
54
|
+
* }
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```tsx
|
|
59
|
+
* // Block based on condition
|
|
60
|
+
* function UnsavedChanges() {
|
|
61
|
+
* const [hasChanges, setHasChanges] = useState(false);
|
|
62
|
+
*
|
|
63
|
+
* useNavigationBlocker({
|
|
64
|
+
* when: hasChanges,
|
|
65
|
+
* message: 'Discard changes?',
|
|
66
|
+
* onBlock: () => console.log('Navigation blocked'),
|
|
67
|
+
* });
|
|
68
|
+
* }
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```tsx
|
|
73
|
+
* // Block with custom dialog
|
|
74
|
+
* function CheckoutFlow() {
|
|
75
|
+
* useNavigationBlocker({
|
|
76
|
+
* scope: 'checkout',
|
|
77
|
+
* message: 'Your items will still be in your cart.',
|
|
78
|
+
* blockBrowserUnload: true,
|
|
79
|
+
* });
|
|
80
|
+
* }
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
declare function useNavigationBlocker(options: UseNavigationBlockerOptions): NavigationBlockerReturn;
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Simple prompt API similar to React Router v5's `usePrompt`.
|
|
87
|
+
*
|
|
88
|
+
* Shows a confirmation dialog when the user tries to navigate away
|
|
89
|
+
* while the condition is true.
|
|
90
|
+
*
|
|
91
|
+
* This is a simpler API compared to `useNavigationBlocker` for cases
|
|
92
|
+
* where you just want to show a prompt without advanced configuration.
|
|
93
|
+
*
|
|
94
|
+
* @param message - Message to show in confirmation dialog
|
|
95
|
+
* @param when - Condition to determine when to show the prompt
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```tsx
|
|
99
|
+
* function MyForm() {
|
|
100
|
+
* const [hasUnsavedChanges, setHasUnsavedChanges] = useState(false);
|
|
101
|
+
*
|
|
102
|
+
* usePrompt(
|
|
103
|
+
* 'You have unsaved changes. Are you sure you want to leave?',
|
|
104
|
+
* hasUnsavedChanges
|
|
105
|
+
* );
|
|
106
|
+
*
|
|
107
|
+
* return <form>...</form>;
|
|
108
|
+
* }
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* ```tsx
|
|
113
|
+
* // With function condition
|
|
114
|
+
* function EditPage() {
|
|
115
|
+
* const isDirty = useFormDirty();
|
|
116
|
+
*
|
|
117
|
+
* usePrompt('Discard unsaved changes?', () => isDirty);
|
|
118
|
+
* }
|
|
119
|
+
* ```
|
|
120
|
+
*/
|
|
121
|
+
declare function usePrompt(message: string, when: boolean | (() => boolean)): void;
|
|
122
|
+
/**
|
|
123
|
+
* Hook variant that accepts options object
|
|
124
|
+
*
|
|
125
|
+
* @param options - Prompt configuration
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* ```tsx
|
|
129
|
+
* usePromptWithOptions({
|
|
130
|
+
* message: 'Leave without saving?',
|
|
131
|
+
* when: hasChanges
|
|
132
|
+
* });
|
|
133
|
+
* ```
|
|
134
|
+
*/
|
|
135
|
+
declare function usePromptWithOptions(options: UsePromptOptions): void;
|
|
136
|
+
|
|
137
|
+
export { type UseNavigationBlockerOptions, type UsePromptOptions, useNavigationBlocker, usePrompt, usePromptWithOptions };
|
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
import { useRef, useState, useCallback, useEffect, useMemo } from 'react';
|
|
2
|
+
import { useBlocker } from 'react-router-dom';
|
|
3
|
+
import { useIsBlocked } from '@okyrychenko-dev/react-action-guard';
|
|
4
|
+
|
|
5
|
+
// src/react-router/useNavigationBlocker.ts
|
|
6
|
+
|
|
7
|
+
// src/core/utils.ts
|
|
8
|
+
function resolveCondition(condition) {
|
|
9
|
+
return typeof condition === "function" ? condition() : condition;
|
|
10
|
+
}
|
|
11
|
+
var hasThen = (value) => typeof value === "object" && value !== null && "then" in value;
|
|
12
|
+
function isThenable(value) {
|
|
13
|
+
if (!hasThen(value)) {
|
|
14
|
+
return false;
|
|
15
|
+
}
|
|
16
|
+
return typeof value.then === "function";
|
|
17
|
+
}
|
|
18
|
+
function resolveConfirmResult(message, onConfirm, fallbackConfirm) {
|
|
19
|
+
if (!onConfirm) {
|
|
20
|
+
return { kind: "sync", confirmed: fallbackConfirm(message) };
|
|
21
|
+
}
|
|
22
|
+
const result = onConfirm(message);
|
|
23
|
+
if (isThenable(result)) {
|
|
24
|
+
return { kind: "async", promise: Promise.resolve(result) };
|
|
25
|
+
}
|
|
26
|
+
return { kind: "sync", confirmed: result };
|
|
27
|
+
}
|
|
28
|
+
function isDefined(value) {
|
|
29
|
+
return value !== void 0 && value !== null;
|
|
30
|
+
}
|
|
31
|
+
function normalizeScope(scope) {
|
|
32
|
+
if (!scope) {
|
|
33
|
+
return [];
|
|
34
|
+
}
|
|
35
|
+
return Array.isArray(scope) ? scope : [scope];
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// src/core/useBeforeUnload.ts
|
|
39
|
+
var DEFAULT_UNLOAD_MESSAGE = "Changes you made may not be saved.";
|
|
40
|
+
function useBeforeUnload(when, message = DEFAULT_UNLOAD_MESSAGE) {
|
|
41
|
+
useEffect(() => {
|
|
42
|
+
const shouldBlock = resolveCondition(when);
|
|
43
|
+
if (!shouldBlock) {
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
const handleBeforeUnload = (event) => {
|
|
47
|
+
event.preventDefault();
|
|
48
|
+
if ("returnValue" in event) {
|
|
49
|
+
event.returnValue = message;
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
window.addEventListener("beforeunload", handleBeforeUnload);
|
|
53
|
+
return () => {
|
|
54
|
+
window.removeEventListener("beforeunload", handleBeforeUnload);
|
|
55
|
+
};
|
|
56
|
+
}, [when, message]);
|
|
57
|
+
}
|
|
58
|
+
function useShouldBlock(when, scope) {
|
|
59
|
+
const scopes = useMemo(() => normalizeScope(scope), [scope]);
|
|
60
|
+
const isScopeBlocked = useIsBlocked(scopes.length === 1 ? scopes[0] : scopes);
|
|
61
|
+
const warnedMissingConditionRef = useRef(false);
|
|
62
|
+
const warnedFunctionRef = useRef(false);
|
|
63
|
+
useEffect(() => {
|
|
64
|
+
if (process.env.NODE_ENV !== "development") {
|
|
65
|
+
return;
|
|
66
|
+
}
|
|
67
|
+
if (!warnedMissingConditionRef.current && !isDefined(when) && !scope) {
|
|
68
|
+
warnedMissingConditionRef.current = true;
|
|
69
|
+
console.warn(
|
|
70
|
+
'[react-action-guard-router] useShouldBlock: Neither "when" nor "scope" provided. This hook will always return false. Please provide at least one condition.'
|
|
71
|
+
);
|
|
72
|
+
}
|
|
73
|
+
if (!warnedFunctionRef.current && typeof when === "function") {
|
|
74
|
+
warnedFunctionRef.current = true;
|
|
75
|
+
console.warn(
|
|
76
|
+
'[react-action-guard-router] useShouldBlock: "when" is a function. Make sure to wrap it with useCallback to avoid unnecessary re-computations.'
|
|
77
|
+
);
|
|
78
|
+
}
|
|
79
|
+
}, [when, scope]);
|
|
80
|
+
const shouldBlock = useMemo(() => {
|
|
81
|
+
let blockCondition = false;
|
|
82
|
+
if (isDefined(when)) {
|
|
83
|
+
blockCondition = resolveCondition(when);
|
|
84
|
+
}
|
|
85
|
+
if (scope && isScopeBlocked) {
|
|
86
|
+
blockCondition = true;
|
|
87
|
+
}
|
|
88
|
+
return blockCondition;
|
|
89
|
+
}, [when, scope, isScopeBlocked]);
|
|
90
|
+
return shouldBlock;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
// src/react-router/useNavigationBlocker.ts
|
|
94
|
+
function useNavigationBlocker(options) {
|
|
95
|
+
const {
|
|
96
|
+
when,
|
|
97
|
+
scope,
|
|
98
|
+
message,
|
|
99
|
+
blockBrowserUnload = true,
|
|
100
|
+
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
|
101
|
+
block,
|
|
102
|
+
// deprecated, for backwards compatibility
|
|
103
|
+
onBlock,
|
|
104
|
+
onAllow,
|
|
105
|
+
onConfirm
|
|
106
|
+
} = options;
|
|
107
|
+
const confirmSeqRef = useRef(0);
|
|
108
|
+
const [pendingConfirm, setPendingConfirm] = useState(null);
|
|
109
|
+
const shouldBlock = useShouldBlock(when ?? block, scope);
|
|
110
|
+
const blocker = useBlocker(
|
|
111
|
+
useCallback(() => {
|
|
112
|
+
if (!shouldBlock) {
|
|
113
|
+
return false;
|
|
114
|
+
}
|
|
115
|
+
onBlock?.();
|
|
116
|
+
if (!message) {
|
|
117
|
+
return true;
|
|
118
|
+
}
|
|
119
|
+
const confirmation = resolveConfirmResult(
|
|
120
|
+
message,
|
|
121
|
+
onConfirm,
|
|
122
|
+
(value) => window.confirm(value)
|
|
123
|
+
);
|
|
124
|
+
if (confirmation.kind === "async") {
|
|
125
|
+
const id = ++confirmSeqRef.current;
|
|
126
|
+
setPendingConfirm({ id, promise: confirmation.promise });
|
|
127
|
+
return true;
|
|
128
|
+
}
|
|
129
|
+
if (confirmation.confirmed) {
|
|
130
|
+
onAllow?.();
|
|
131
|
+
return false;
|
|
132
|
+
}
|
|
133
|
+
return true;
|
|
134
|
+
}, [shouldBlock, message, onBlock, onConfirm, onAllow])
|
|
135
|
+
);
|
|
136
|
+
useEffect(() => {
|
|
137
|
+
if (!pendingConfirm) {
|
|
138
|
+
return;
|
|
139
|
+
}
|
|
140
|
+
let active = true;
|
|
141
|
+
const { id, promise } = pendingConfirm;
|
|
142
|
+
promise.then((confirmed) => {
|
|
143
|
+
if (!active || id !== confirmSeqRef.current) {
|
|
144
|
+
return;
|
|
145
|
+
}
|
|
146
|
+
if (confirmed) {
|
|
147
|
+
onAllow?.();
|
|
148
|
+
blocker.proceed?.();
|
|
149
|
+
} else {
|
|
150
|
+
blocker.reset?.();
|
|
151
|
+
}
|
|
152
|
+
}).catch(() => {
|
|
153
|
+
if (active && id === confirmSeqRef.current) {
|
|
154
|
+
blocker.reset?.();
|
|
155
|
+
}
|
|
156
|
+
}).finally(() => {
|
|
157
|
+
if (active && id === confirmSeqRef.current) {
|
|
158
|
+
setPendingConfirm(null);
|
|
159
|
+
}
|
|
160
|
+
});
|
|
161
|
+
return () => {
|
|
162
|
+
active = false;
|
|
163
|
+
};
|
|
164
|
+
}, [pendingConfirm, blocker, onAllow]);
|
|
165
|
+
useBeforeUnload(blockBrowserUnload && shouldBlock, message ?? DEFAULT_UNLOAD_MESSAGE);
|
|
166
|
+
return {
|
|
167
|
+
isBlocking: shouldBlock,
|
|
168
|
+
isIntercepting: blocker.state === "blocked"
|
|
169
|
+
};
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
// src/react-router/usePrompt.ts
|
|
173
|
+
function usePrompt(message, when) {
|
|
174
|
+
useNavigationBlocker({
|
|
175
|
+
when,
|
|
176
|
+
message,
|
|
177
|
+
blockBrowserUnload: true
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
function usePromptWithOptions(options) {
|
|
181
|
+
useNavigationBlocker({
|
|
182
|
+
...options,
|
|
183
|
+
blockBrowserUnload: options.blockBrowserUnload ?? true
|
|
184
|
+
});
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
export { useNavigationBlocker, usePrompt, usePromptWithOptions };
|
|
188
|
+
//# sourceMappingURL=index.js.map
|
|
189
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/core/utils.ts","../../src/core/useBeforeUnload.ts","../../src/core/useShouldBlock.ts","../../src/react-router/useNavigationBlocker.ts","../../src/react-router/usePrompt.ts"],"names":["useEffect","useRef"],"mappings":";;;;;;;AAMO,SAAS,iBAAiB,SAAA,EAA+C;AAC9E,EAAA,OAAO,OAAO,SAAA,KAAc,UAAA,GAAa,SAAA,EAAU,GAAI,SAAA;AACzD;AAMA,IAAM,OAAA,GAAU,CAAC,KAAA,KACf,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,MAAA,IAAU,KAAA;AAKpD,SAAS,WAAc,KAAA,EAAyC;AACrE,EAAA,IAAI,CAAC,OAAA,CAAQ,KAAK,CAAA,EAAG;AACnB,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,MAAM,IAAA,KAAS,UAAA;AAC/B;AAiBO,SAAS,oBAAA,CACd,OAAA,EACA,SAAA,EACA,eAAA,EACe;AACf,EAAA,IAAI,CAAC,SAAA,EAAW;AACd,IAAA,OAAO,EAAE,IAAA,EAAM,MAAA,EAAQ,SAAA,EAAW,eAAA,CAAgB,OAAO,CAAA,EAAE;AAAA,EAC7D;AAEA,EAAA,MAAM,MAAA,GAAS,UAAU,OAAO,CAAA;AAChC,EAAA,IAAI,UAAA,CAAoB,MAAM,CAAA,EAAG;AAC/B,IAAA,OAAO,EAAE,IAAA,EAAM,OAAA,EAAS,SAAS,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAA,EAAE;AAAA,EAC3D;AAEA,EAAA,OAAO,EAAE,IAAA,EAAM,MAAA,EAAQ,SAAA,EAAW,MAAA,EAAO;AAC3C;AAqBO,SAAS,UAAa,KAAA,EAAyC;AACpE,EAAA,OAAO,KAAA,KAAU,UAAa,KAAA,KAAU,IAAA;AAC1C;AAQO,SAAS,eAAe,KAAA,EAA0D;AACvF,EAAA,IAAI,CAAC,KAAA,EAAO;AACV,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,MAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAA,GAAQ,CAAC,KAAK,CAAA;AAC9C;;;ACvFO,IAAM,sBAAA,GAAyB,oCAAA;AAmC/B,SAAS,eAAA,CACd,IAAA,EACA,OAAA,GAAU,sBAAA,EACJ;AACN,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,WAAA,GAAc,iBAAiB,IAAI,CAAA;AAEzC,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,kBAAA,GAAqB,CAAC,KAAA,KAAmC;AAE7D,MAAA,KAAA,CAAM,cAAA,EAAe;AAGrB,MAAA,IAAI,iBAAiB,KAAA,EAAO;AAE1B,QAAA,KAAA,CAAM,WAAA,GAAc,OAAA;AAAA,MACtB;AAAA,IACF,CAAA;AAEA,IAAA,MAAA,CAAO,gBAAA,CAAiB,gBAAgB,kBAAkB,CAAA;AAE1D,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,CAAO,mBAAA,CAAoB,gBAAgB,kBAAkB,CAAA;AAAA,IAC/D,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,IAAA,EAAM,OAAO,CAAC,CAAA;AACpB;ACpDO,SAAS,cAAA,CACd,MACA,KAAA,EACS;AAET,EAAA,MAAM,MAAA,GAAS,QAAQ,MAAM,cAAA,CAAe,KAAK,CAAA,EAAG,CAAC,KAAK,CAAC,CAAA;AAG3D,EAAA,MAAM,cAAA,GAAiB,aAAa,MAAA,CAAO,MAAA,KAAW,IAAI,MAAA,CAAO,CAAC,IAAI,MAAM,CAAA;AAG5E,EAAA,MAAM,yBAAA,GAA4B,OAAO,KAAK,CAAA;AAC9C,EAAA,MAAM,iBAAA,GAAoB,OAAO,KAAK,CAAA;AAEtC,EAAAA,UAAU,MAAM;AACd,IAAA,IAAI,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,aAAA,EAAe;AAC1C,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,0BAA0B,OAAA,IAAW,CAAC,UAAU,IAAI,CAAA,IAAK,CAAC,KAAA,EAAO;AACpE,MAAA,yBAAA,CAA0B,OAAA,GAAU,IAAA;AACpC,MAAA,OAAA,CAAQ,IAAA;AAAA,QACN;AAAA,OAEF;AAAA,IACF;AAEA,IAAA,IAAI,CAAC,iBAAA,CAAkB,OAAA,IAAW,OAAO,SAAS,UAAA,EAAY;AAC5D,MAAA,iBAAA,CAAkB,OAAA,GAAU,IAAA;AAC5B,MAAA,OAAA,CAAQ,IAAA;AAAA,QACN;AAAA,OAEF;AAAA,IACF;AAAA,EACF,CAAA,EAAG,CAAC,IAAA,EAAM,KAAK,CAAC,CAAA;AAIhB,EAAA,MAAM,WAAA,GAAc,QAAQ,MAAM;AAChC,IAAA,IAAI,cAAA,GAAiB,KAAA;AAGrB,IAAA,IAAI,SAAA,CAAU,IAAI,CAAA,EAAG;AACnB,MAAA,cAAA,GAAiB,iBAAiB,IAAI,CAAA;AAAA,IACxC;AAGA,IAAA,IAAI,SAAS,cAAA,EAAgB;AAC3B,MAAA,cAAA,GAAiB,IAAA;AAAA,IACnB;AAEA,IAAA,OAAO,cAAA;AAAA,EACT,CAAA,EAAG,CAAC,IAAA,EAAM,KAAA,EAAO,cAAc,CAAC,CAAA;AAEhC,EAAA,OAAO,WAAA;AACT;;;ACLO,SAAS,qBACd,OAAA,EACyB;AACzB,EAAA,MAAM;AAAA,IACJ,IAAA;AAAA,IACA,KAAA;AAAA,IACA,OAAA;AAAA,IACA,kBAAA,GAAqB,IAAA;AAAA;AAAA,IAErB,KAAA;AAAA;AAAA,IACA,OAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACF,GAAI,OAAA;AAEJ,EAAA,MAAM,aAAA,GAAgBC,OAAO,CAAC,CAAA;AAC9B,EAAA,MAAM,CAAC,cAAA,EAAgB,iBAAiB,CAAA,GAAI,SAGlC,IAAI,CAAA;AAGd,EAAA,MAAM,WAAA,GAAc,cAAA,CAAe,IAAA,IAAQ,KAAA,EAAO,KAAK,CAAA;AAGvD,EAAA,MAAM,OAAA,GAAU,UAAA;AAAA,IACd,YAAY,MAAM;AAEhB,MAAA,IAAI,CAAC,WAAA,EAAa;AAChB,QAAA,OAAO,KAAA;AAAA,MACT;AAGA,MAAA,OAAA,IAAU;AAGV,MAAA,IAAI,CAAC,OAAA,EAAS;AACZ,QAAA,OAAO,IAAA;AAAA,MACT;AAEA,MAAA,MAAM,YAAA,GAAe,oBAAA;AAAA,QAAqB,OAAA;AAAA,QAAS,SAAA;AAAA,QAAW,CAAC,KAAA,KAC7D,MAAA,CAAO,OAAA,CAAQ,KAAK;AAAA,OACtB;AAEA,MAAA,IAAI,YAAA,CAAa,SAAS,OAAA,EAAS;AACjC,QAAA,MAAM,EAAA,GAAK,EAAE,aAAA,CAAc,OAAA;AAC3B,QAAA,iBAAA,CAAkB,EAAE,EAAA,EAAI,OAAA,EAAS,YAAA,CAAa,SAAS,CAAA;AACvD,QAAA,OAAO,IAAA;AAAA,MACT;AAEA,MAAA,IAAI,aAAa,SAAA,EAAW;AAC1B,QAAA,OAAA,IAAU;AACV,QAAA,OAAO,KAAA;AAAA,MACT;AAEA,MAAA,OAAO,IAAA;AAAA,IACT,GAAG,CAAC,WAAA,EAAa,SAAS,OAAA,EAAS,SAAA,EAAW,OAAO,CAAC;AAAA,GACxD;AAEA,EAAAD,UAAU,MAAM;AACd,IAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,MAAA;AAAA,IACF;AAEA,IAAA,IAAI,MAAA,GAAS,IAAA;AACb,IAAA,MAAM,EAAE,EAAA,EAAI,OAAA,EAAQ,GAAI,cAAA;AAExB,IAAA,OAAA,CACG,IAAA,CAAK,CAAC,SAAA,KAAc;AACnB,MAAA,IAAI,CAAC,MAAA,IAAU,EAAA,KAAO,aAAA,CAAc,OAAA,EAAS;AAC3C,QAAA;AAAA,MACF;AACA,MAAA,IAAI,SAAA,EAAW;AACb,QAAA,OAAA,IAAU;AACV,QAAA,OAAA,CAAQ,OAAA,IAAU;AAAA,MACpB,CAAA,MAAO;AACL,QAAA,OAAA,CAAQ,KAAA,IAAQ;AAAA,MAClB;AAAA,IACF,CAAC,CAAA,CACA,KAAA,CAAM,MAAM;AACX,MAAA,IAAI,MAAA,IAAU,EAAA,KAAO,aAAA,CAAc,OAAA,EAAS;AAC1C,QAAA,OAAA,CAAQ,KAAA,IAAQ;AAAA,MAClB;AAAA,IACF,CAAC,CAAA,CACA,OAAA,CAAQ,MAAM;AACb,MAAA,IAAI,MAAA,IAAU,EAAA,KAAO,aAAA,CAAc,OAAA,EAAS;AAC1C,QAAA,iBAAA,CAAkB,IAAI,CAAA;AAAA,MACxB;AAAA,IACF,CAAC,CAAA;AAEH,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,GAAS,KAAA;AAAA,IACX,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,cAAA,EAAgB,OAAA,EAAS,OAAO,CAAC,CAAA;AAGrC,EAAA,eAAA,CAAgB,kBAAA,IAAsB,WAAA,EAAa,OAAA,IAAW,sBAAsB,CAAA;AAEpF,EAAA,OAAO;AAAA,IACL,UAAA,EAAY,WAAA;AAAA,IACZ,cAAA,EAAgB,QAAQ,KAAA,KAAU;AAAA,GACpC;AACF;;;AClIO,SAAS,SAAA,CAAU,SAAiB,IAAA,EAAuC;AAChF,EAAA,oBAAA,CAAqB;AAAA,IACnB,IAAA;AAAA,IACA,OAAA;AAAA,IACA,kBAAA,EAAoB;AAAA,GACrB,CAAA;AACH;AAeO,SAAS,qBAAqB,OAAA,EAAiC;AACpE,EAAA,oBAAA,CAAqB;AAAA,IACnB,GAAG,OAAA;AAAA,IACH,kBAAA,EAAoB,QAAQ,kBAAA,IAAsB;AAAA,GACnD,CAAA;AACH","file":"index.js","sourcesContent":["/**\n * Resolves a condition value (boolean or function returning boolean)\n *\n * @param condition - Boolean value or function\n * @returns Resolved boolean value\n */\nexport function resolveCondition(condition: boolean | (() => boolean)): boolean {\n return typeof condition === \"function\" ? condition() : condition;\n}\n\ninterface Thenable {\n then: (...args: Array<unknown>) => unknown;\n}\n\nconst hasThen = (value: unknown): value is Thenable =>\n typeof value === \"object\" && value !== null && \"then\" in value;\n\n/**\n * Checks if a value behaves like a Promise (thenable)\n */\nexport function isThenable<T>(value: unknown): value is PromiseLike<T> {\n if (!hasThen(value)) {\n return false;\n }\n return typeof value.then === \"function\";\n}\n\nexport interface ConfirmResultSync {\n kind: \"sync\";\n confirmed: boolean;\n}\n\nexport interface ConfirmResultAsync {\n kind: \"async\";\n promise: Promise<boolean>;\n}\n\nexport type ConfirmResult = ConfirmResultSync | ConfirmResultAsync;\n\n/**\n * Normalizes custom confirm result into sync or async branch.\n */\nexport function resolveConfirmResult(\n message: string,\n onConfirm: ((message: string) => boolean | PromiseLike<boolean>) | undefined,\n fallbackConfirm: (message: string) => boolean\n): ConfirmResult {\n if (!onConfirm) {\n return { kind: \"sync\", confirmed: fallbackConfirm(message) };\n }\n\n const result = onConfirm(message);\n if (isThenable<boolean>(result)) {\n return { kind: \"async\", promise: Promise.resolve(result) };\n }\n\n return { kind: \"sync\", confirmed: result };\n}\n\n/**\n * Generates a unique blocker ID based on scope and timestamp\n *\n * @param prefix - Prefix for the ID\n * @param scope - Optional scope\n * @returns Unique blocker ID\n */\nexport function createBlockerId(prefix: string, scope?: string | Array<string>): string {\n const scopePart = scope ? `-${Array.isArray(scope) ? scope.join(\"-\") : scope}` : \"\";\n const timestamp = String(Date.now());\n return `${prefix}${scopePart}-${timestamp}`;\n}\n\n/**\n * Checks if a value is defined and not empty\n *\n * @param value - Value to check\n * @returns True if value is defined and not empty\n */\nexport function isDefined<T>(value: T | undefined | null): value is T {\n return value !== undefined && value !== null;\n}\n\n/**\n * Normalizes scope to an array\n *\n * @param scope - String or array of strings\n * @returns Array of scope strings\n */\nexport function normalizeScope(scope: string | Array<string> | undefined): Array<string> {\n if (!scope) {\n return [];\n }\n return Array.isArray(scope) ? scope : [scope];\n}\n","import { useEffect } from \"react\";\nimport { resolveCondition } from \"./utils\";\n\n/**\n * Default message shown when preventing browser unload\n */\nexport const DEFAULT_UNLOAD_MESSAGE = \"Changes you made may not be saved.\";\n\n/**\n * Blocks browser tab close/refresh when condition is met.\n *\n * This hook adds a `beforeunload` event listener to warn users\n * before they close or refresh the browser tab. Modern browsers\n * may ignore custom messages and show their own generic warning.\n *\n * @param when - Boolean or function returning boolean to determine if blocking should be active\n * @param message - Optional custom message (may be ignored by browsers)\n *\n * @example\n * ```tsx\n * function MyForm() {\n * const [hasUnsavedChanges, setHasUnsavedChanges] = useState(false);\n *\n * useBeforeUnload(hasUnsavedChanges, 'You have unsaved changes');\n *\n * return <form>...</form>;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // With function condition\n * function EditPage() {\n * const isFormDirty = useIsBlocked('form');\n *\n * useBeforeUnload(() => isFormDirty);\n *\n * return <div>...</div>;\n * }\n * ```\n */\nexport function useBeforeUnload(\n when: boolean | (() => boolean),\n message = DEFAULT_UNLOAD_MESSAGE\n): void {\n useEffect(() => {\n const shouldBlock = resolveCondition(when);\n\n if (!shouldBlock) {\n return;\n }\n\n const handleBeforeUnload = (event: BeforeUnloadEvent): void => {\n // Prevent default to trigger the browser's confirmation dialog\n event.preventDefault();\n\n // Fallback for legacy browsers/WebViews that still rely on returnValue.\n if (\"returnValue\" in event) {\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n event.returnValue = message;\n }\n };\n\n window.addEventListener(\"beforeunload\", handleBeforeUnload);\n\n return () => {\n window.removeEventListener(\"beforeunload\", handleBeforeUnload);\n };\n }, [when, message]);\n}\n","import { useIsBlocked } from \"@okyrychenko-dev/react-action-guard\";\nimport { useEffect, useMemo, useRef } from \"react\";\nimport { isDefined, normalizeScope, resolveCondition } from \"./utils\";\n\n/**\n * Shared hook to determine if blocking should be active based on\n * condition and/or scope state.\n *\n * This hook uses `useMemo` for optimal performance, ensuring blocking state\n * is computed synchronously without additional re-renders.\n *\n * @param when - Optional condition (boolean or function)\n * @param scope - Optional scope(s) to check\n * @returns Whether blocking should be active\n *\n * @internal\n */\nexport function useShouldBlock(\n when?: boolean | (() => boolean),\n scope?: string | Array<string>\n): boolean {\n // Memoize scope normalization to avoid recalculation on every render\n const scopes = useMemo(() => normalizeScope(scope), [scope]);\n\n // Check if any specified scopes are blocked\n const isScopeBlocked = useIsBlocked(scopes.length === 1 ? scopes[0] : scopes);\n\n // Development-only validation\n const warnedMissingConditionRef = useRef(false);\n const warnedFunctionRef = useRef(false);\n\n useEffect(() => {\n if (process.env.NODE_ENV !== \"development\") {\n return;\n }\n\n if (!warnedMissingConditionRef.current && !isDefined(when) && !scope) {\n warnedMissingConditionRef.current = true;\n console.warn(\n '[react-action-guard-router] useShouldBlock: Neither \"when\" nor \"scope\" provided. ' +\n \"This hook will always return false. Please provide at least one condition.\"\n );\n }\n\n if (!warnedFunctionRef.current && typeof when === \"function\") {\n warnedFunctionRef.current = true;\n console.warn(\n '[react-action-guard-router] useShouldBlock: \"when\" is a function. ' +\n \"Make sure to wrap it with useCallback to avoid unnecessary re-computations.\"\n );\n }\n }, [when, scope]);\n\n // Compute blocking state synchronously using useMemo\n // This avoids the useState + useEffect pattern which causes an extra render\n const shouldBlock = useMemo(() => {\n let blockCondition = false;\n\n // Check manual condition\n if (isDefined(when)) {\n blockCondition = resolveCondition(when);\n }\n\n // Check scope-based blocking (OR logic - block if either condition is true)\n if (scope && isScopeBlocked) {\n blockCondition = true;\n }\n\n return blockCondition;\n }, [when, scope, isScopeBlocked]);\n\n return shouldBlock;\n}\n","import { useCallback, useEffect, useRef, useState } from \"react\";\nimport { useBlocker } from \"react-router-dom\";\nimport {\n DEFAULT_UNLOAD_MESSAGE,\n resolveConfirmResult,\n useBeforeUnload,\n useShouldBlock,\n} from \"../core\";\nimport type { UseNavigationBlockerOptions } from \"./types\";\nimport type { NavigationBlockerReturn } from \"../core/types\";\n\n/**\n * Blocks navigation in React Router v6+ applications based on conditions or scope state.\n *\n * This hook integrates React Router's `useBlocker` with react-action-guard's scope system,\n * allowing you to prevent navigation when certain conditions are met or when specific\n * scopes are blocked.\n *\n * **Features:**\n * - Block navigation based on boolean condition or function\n * - Automatically block when react-action-guard scopes are active\n * - Support for browser `beforeunload` event (tab close/refresh)\n * - Customizable confirmation dialog configuration\n * - Callbacks for block/allow events\n *\n * @param options - Configuration options\n * @returns Object with `isBlocking` state\n *\n * @example\n * ```tsx\n * // Block based on scope\n * function EditForm() {\n * useNavigationBlocker({\n * scope: 'form',\n * message: 'You have unsaved changes. Leave anyway?',\n * });\n *\n * return <form>...</form>;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // Block based on condition\n * function UnsavedChanges() {\n * const [hasChanges, setHasChanges] = useState(false);\n *\n * useNavigationBlocker({\n * when: hasChanges,\n * message: 'Discard changes?',\n * onBlock: () => console.log('Navigation blocked'),\n * });\n * }\n * ```\n *\n * @example\n * ```tsx\n * // Block with custom dialog\n * function CheckoutFlow() {\n * useNavigationBlocker({\n * scope: 'checkout',\n * message: 'Your items will still be in your cart.',\n * blockBrowserUnload: true,\n * });\n * }\n * ```\n */\nexport function useNavigationBlocker(\n options: UseNavigationBlockerOptions\n): NavigationBlockerReturn {\n const {\n when,\n scope,\n message,\n blockBrowserUnload = true,\n // eslint-disable-next-line @typescript-eslint/no-deprecated\n block, // deprecated, for backwards compatibility\n onBlock,\n onAllow,\n onConfirm,\n } = options;\n\n const confirmSeqRef = useRef(0);\n const [pendingConfirm, setPendingConfirm] = useState<{\n id: number;\n promise: Promise<boolean>;\n } | null>(null);\n\n // Use shared logic to determine if blocking should be active\n const shouldBlock = useShouldBlock(when ?? block, scope);\n\n // Use React Router's blocker\n const blocker = useBlocker(\n useCallback(() => {\n // Early return if not blocking\n if (!shouldBlock) {\n return false;\n }\n\n // Trigger onBlock callback\n onBlock?.();\n\n // If no message, just block\n if (!message) {\n return true;\n }\n\n const confirmation = resolveConfirmResult(message, onConfirm, (value) =>\n window.confirm(value)\n );\n\n if (confirmation.kind === \"async\") {\n const id = ++confirmSeqRef.current;\n setPendingConfirm({ id, promise: confirmation.promise });\n return true;\n }\n\n if (confirmation.confirmed) {\n onAllow?.();\n return false;\n }\n\n return true;\n }, [shouldBlock, message, onBlock, onConfirm, onAllow])\n );\n\n useEffect(() => {\n if (!pendingConfirm) {\n return;\n }\n\n let active = true;\n const { id, promise } = pendingConfirm;\n\n promise\n .then((confirmed) => {\n if (!active || id !== confirmSeqRef.current) {\n return;\n }\n if (confirmed) {\n onAllow?.();\n blocker.proceed?.();\n } else {\n blocker.reset?.();\n }\n })\n .catch(() => {\n if (active && id === confirmSeqRef.current) {\n blocker.reset?.();\n }\n })\n .finally(() => {\n if (active && id === confirmSeqRef.current) {\n setPendingConfirm(null);\n }\n });\n\n return () => {\n active = false;\n };\n }, [pendingConfirm, blocker, onAllow]);\n\n // Also block browser unload if requested\n useBeforeUnload(blockBrowserUnload && shouldBlock, message ?? DEFAULT_UNLOAD_MESSAGE);\n\n return {\n isBlocking: shouldBlock,\n isIntercepting: blocker.state === \"blocked\",\n };\n}\n","import { useNavigationBlocker } from \"./useNavigationBlocker\";\nimport type { UsePromptOptions } from \"./types\";\n\n/**\n * Simple prompt API similar to React Router v5's `usePrompt`.\n *\n * Shows a confirmation dialog when the user tries to navigate away\n * while the condition is true.\n *\n * This is a simpler API compared to `useNavigationBlocker` for cases\n * where you just want to show a prompt without advanced configuration.\n *\n * @param message - Message to show in confirmation dialog\n * @param when - Condition to determine when to show the prompt\n *\n * @example\n * ```tsx\n * function MyForm() {\n * const [hasUnsavedChanges, setHasUnsavedChanges] = useState(false);\n *\n * usePrompt(\n * 'You have unsaved changes. Are you sure you want to leave?',\n * hasUnsavedChanges\n * );\n *\n * return <form>...</form>;\n * }\n * ```\n *\n * @example\n * ```tsx\n * // With function condition\n * function EditPage() {\n * const isDirty = useFormDirty();\n *\n * usePrompt('Discard unsaved changes?', () => isDirty);\n * }\n * ```\n */\nexport function usePrompt(message: string, when: boolean | (() => boolean)): void {\n useNavigationBlocker({\n when,\n message,\n blockBrowserUnload: true,\n });\n}\n\n/**\n * Hook variant that accepts options object\n *\n * @param options - Prompt configuration\n *\n * @example\n * ```tsx\n * usePromptWithOptions({\n * message: 'Leave without saving?',\n * when: hasChanges\n * });\n * ```\n */\nexport function usePromptWithOptions(options: UsePromptOptions): void {\n useNavigationBlocker({\n ...options,\n blockBrowserUnload: options.blockBrowserUnload ?? true,\n });\n}\n"]}
|