import { matchPath, useLocation } from 'react-router-dom';
import { AnyRouteNode } from '../routeNode';

/**
 * Returns true if the given route is currently active
 *
 * @example
 * ```tsx
 * const router = Router(route => ({
 *  login: route('login', { component: Login }),
 *  home: route('home', { component: Home }),
 * }));
 *
 * const active = useRouteActive(router.login);
 * ```
 *
 * @param route     The RouteNode to use.
 *
 * @returns         true if the given `route` is active or false if not
 */
export const useRouteActive = (route: AnyRouteNode): boolean => {
  const { pathname } = useLocation();
  return (
    matchPath(
      {
        path: route.fullTemplate,
      },
      pathname
    ) != null
  );
};