@atlaskit/app-provider/dist/es2019/router-link-provider/hooks/use-router-link.js

A top level provider for the Design System.

import { useContext } from 'react';
import { RouterLinkProviderContext } from '../index';

/**
 * __useRouterLink()__
 *
 * Hook: Returns app-configured router link component.
 *
 * A generic can be passed to define advanced link configuration:
 * ```
 * type MyRouterLinkConfig = {
 *  to: string;
 *  replace?: boolean;
 * }
 *
 * const RouterLink = useRouterLink<MyRouterLinkConfig>();
 * ```
 */
export const useRouterLink = () => {
  const {
    routerLinkComponent
  } = useContext(RouterLinkProviderContext);
  if (routerLinkComponent) {
    return routerLinkComponent;
  }
  return;
};