dev
Viewing docs for dev branch, not the latest release. View latest
useHref

useHref

Resolves a full URL against the current location to be used as an href to a link. If a relative path is supplied, it will resolve to a full URL.

import { useHref } from "@remix-run/react";

function SomeComponent() {
  const href = useHref("some/where");

  return <a href={href}>Link</a>;
}

Signature

useHref(to, options)

to

Optional. The path to append to the resolved URL.

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

options

The only option is { relative: "route" | "path"}, which defines the behavior when resolving relative URLs.

  • route default - relative to the route hierarchy, not the URL
  • path - makes the action relative to the URL paths, so .. will remove one URL segment.
Docs and examples licensed under MIT