[v6] [Feature]: usePrompt() should have callback to check 'desired' path before warning

[onionhammer]

What is the new or updated feature that you are suggesting?

Currently usePrompt gives no way to not show the prompt if the user is simply navigating to another path in the same area where a warning wouldnt necessarily be needed or wanted.. for example, if I have 3 tabs on the same page in the same form, navigating between tabs does not clear the state (the user loses no data), but if they navigate out a level ('..') they would lose state.

It would be great to be able to check the 'next' path that the user is trying to go to to decide if they should be prompted.

function usePrompt(message: string, when?: boolean | (to: To) => boolean): void

Why should this feature be included?

This would allow users to change to SOME paths without prompting, but but prompt instead when users are fully leaving an area of your application

[timdorr]

That's what the to argument is on the function version of the when parameter. It represents the next location you're going to.

[onionhammer]

@timdorr that's the proposed function signature, not the current signature, which is:

function usePrompt(message: string, when?: boolean): void

[timdorr]

Sorry, wasn't paying attention...

[philals]

Hi. Where are the docs for usePrompt? I cannot find it in the repo or on the dev branch. Thanks

Edit: Found it! GitHub search was not finding it

https://github.com/remix-run/react-router/blob/dev/packages/react-router-dom/index.tsx#L321

[onionhammer]

@philals I've only been using this blog post as a reference:

https://reacttraining.com/blog/react-router-v6-pre/

[timdorr]

Closing since this API is no longer in the library. #8139 will track when it's added back.

[uthbees]

usePrompt was added back in #9932, any chance this can be reopened?