Function useLinkClickHandler

  • useLinkClickHandler<E>(to, __namedParameters?): ((event: React.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
    • __namedParameters: {
          preventScrollReset?: boolean;
          relative?: RelativeRoutingType;
          replace?: boolean;
          state?: any;
          target?: HTMLAttributeAnchorTarget;
          viewTransition?: boolean;
      } = {}
      • OptionalpreventScrollReset?: boolean
      • Optionalrelative?: RelativeRoutingType
      • Optionalreplace?: boolean
      • Optionalstate?: any
      • Optionaltarget?: HTMLAttributeAnchorTarget
      • OptionalviewTransition?: boolean

    Returns ((event: React.MouseEvent<E, MouseEvent>) => void)

      • (event): void

      • Parameters

        • event: React.MouseEvent<E, MouseEvent>

        Returns void

Settings

Member Visibility