router-query/repository-context/docs/router/api/router/useLocationHook.md

id: useLocationHook title: useLocation hook

The useLocation method is a hook that returns the current location object. This hook is useful for when you want to perform some side effect whenever the current location changes.

useLocation options

The useLocation hook accepts an optional options object.

opts.select option

• Type: (state: ParsedLocationType) => TSelected
• Optional
• If supplied, this function will be called with the location object and the return value will be returned from useLocation.

useLocation returns

• The current location object or TSelected if a select function is provided.

Examples

import { useLocation } from '@tanstack/react-router'

function Component() {
  const location = useLocation()
  //    ^ ParsedLocation

  // OR

  const pathname = useLocation({
    select: (location) => location.pathname,
  })
  //    ^ string

  // ...
}