Skip to content

API Reference / @gtkx/navigation / usePreventRemove

Function: usePreventRemove()

usePreventRemove(preventRemove, callback): void

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/usePreventRemove.d.ts:8

Hook to prevent screen from being removed. Can be used to prevent users from leaving the screen.

Parameters

preventRemove

boolean

Boolean indicating whether to prevent screen from being removed.

callback

(options) => void

Function which is executed when screen was prevented from being removed.

Returns

void

Released under the MPL-2.0 License.