Function useLinkClickHandler

useLinkClickHandler<E extends Element = HTMLAnchorElement>(
    to: To,
    options?: {
        defaultShouldRevalidate?: boolean;
        mask?: To;
        preventScrollReset?: boolean;
        relative?: RelativeRoutingType;
        replace?: boolean;
        state?: any;
        target?: HTMLAttributeAnchorTarget;
        useTransitions?: boolean;
    } & Pick<NavigateOptions, "viewTransition">,
): (event: MouseEvent<E, MouseEvent>) => void
Handles the click behavior for router <Link> components.This is useful if you need to create custom <Link> components with the same click behavior we use in our exported <Link>.
Type Parameters
- E extends Element = HTMLAnchorElement
Parameters
- to: To
  The URL to navigate to, can be a string or a partial Path.
- options: {
      defaultShouldRevalidate?: boolean;
      mask?: To;
      preventScrollReset?: boolean;
      relative?: RelativeRoutingType;
      replace?: boolean;
      state?: any;
      target?: HTMLAttributeAnchorTarget;
      useTransitions?: boolean;
  } & Pick<NavigateOptions, "viewTransition"> = {}
  Options
  - OptionaldefaultShouldRevalidate?: boolean
    Specify the default revalidation behavior for the navigation. When not specified, loaders revalidate according to the router's standard revalidation behavior.
  - Optionalmask?: To
    Masked location to display in the browser instead of the router location. Defaults to undefined.
  - OptionalpreventScrollReset?: boolean
    Whether to prevent the scroll position from being reset to the top of the viewport on completion of the navigation when using the ScrollRestoration component. Defaults to false.
  - Optionalrelative?: RelativeRoutingType
    The relative routing type to use for the link. Defaults to "route".
  - Optionalreplace?: boolean
    Whether to replace the current History entry instead of pushing a new one. Defaults to false.
  - Optionalstate?: any
    The state to add to the History entry for this navigation. Defaults to undefined.
  - Optionaltarget?: HTMLAttributeAnchorTarget
    The target attribute for the link. Defaults to undefined.
  - OptionaluseTransitions?: boolean
    Wraps the navigation in React.startTransition for concurrent rendering. Defaults to false.
  - preventScrollReset
    Whether to prevent the scroll position from being reset to the top of the viewport on completion of the navigation when using the ScrollRestoration component. Defaults to false.
  - relative
    The RelativeRoutingType | relative routing type to use for the link. Defaults to "route".
  - replace
    Whether to replace the current History entry instead of pushing a new one. Defaults to false.
  - state
    The state to add to the History entry for this navigation. Defaults to undefined.
  - target
    The target attribute for the link. Defaults to undefined.
  - viewTransition
    Deprecated. Use React's <ViewTransition> component instead. See the migration guide.
  - defaultShouldRevalidate
    Specify the default revalidation behavior for the navigation. When not specified, loaders revalidate according to the router's standard revalidation behavior.
  - mask
    Masked location to display in the browser instead of the router location. Defaults to undefined.
  - useTransitions
    Wraps the navigation in React.startTransition for concurrent rendering. Defaults to false.
Returns (event: MouseEvent<E, MouseEvent>) => void
A click handler function that can be used in a custom Link component.
- Defined in packages/react-router/lib/dom/lib.tsx:2192