Use router.subscribe in order to monitor route changes

[Miz85]

Hi!

I'd like to create a library to monitor and track routes changes. I noticed that the Router type has a subscribe method that allows you to subscribe to router state changes but it's marked as PRIVATE - do not use. Is it an absolute no-no or would it be okay in the context of creating tooling that integrates with React Router?

[Miz85]

I'm gonna close this question as I got an answer on the Remix discord

[jacobjuul]

would be nice to share here. That link is already dead

[sergiodxa]

The links work for me, but here's a copy:

router.subscribe is largely safe to use. Those are mostly marked private to avoid folks reaching for them inside their react router app - but that's a valid use-case to listen for changes from outside the react tree. We labelled them as such more as a precaution when we released that @remix-run/router package.
However, another option would be to use an effect on the useLocation value and trigger a custom DOM event - that way you avoid the router entirely.