6.22.3
Branches
main (6.22.3)dev
Versions
6.22.3v4/5.xv3.x
useHref

useHref

Type declaration
declare function useHref(
  to: To,
  options?: { relative?: RelativeRoutingType }
): string;

The useHref hook returns a URL that may be used to link to the given to location, even outside of React Router.

You may be interested in taking a look at the source for the <Link> component in react-router-dom to see how it uses useHref internally to determine its own href value

Please see the Splat Paths section on the useResolvedPath docs for a note on the behavior of the future.v7_relativeSplatPath future flag for relative useHref() behavior within splat routes

Docs and examples CC 4.0