useRoutePaths

[Tobbe]

Users are requesting more introspection possibilities for the router.
This PR adds two hooks to get the path declared in the router for a given route.
You can use useRoutePaths() to get a map of all route names to their literal routes (e.g. { editPost: '/posts/{id:Int}/edit', post: '/posts/{id:Int}' }).
Or you can use useRoutePath('editPost') to get the path of a single route by its name

Copy/paste from the docs updates:

useRoutePaths

useRoutePaths() is a React hook you can use to get a map of all routes mapped to their literal paths, as they're defined in your routes file.

Example usage:

const routePaths = useRoutePaths()

return <pre><code>{JSON.stringify(routePaths, undefined, 2)}</code></pre>

Example output:

{
  "home": "/"
  "about": "/about",
  "login": "/login",
  "signup": "/signup",
  "forgotPassword": "/forgot-password",
  "resetPassword": "/reset-password",
  "newContact": "/contacts/new",
  "editContact": "/contacts/{id:Int}/edit",
  "contact": "/contacts/{id:Int}",
  "contacts": "/contacts",
}

useRoutePath

This is a convenience hook for when you only want the path for a single route.

const aboutPath = useRoutePath('about') // returns "/about"

is the same as

const routePaths = useRoutePaths()
const aboutPath = routePaths.about // Also returns "/about"