Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

3.3 KB
Raw Blame
import { AppRouterInstance } from "next/dist/shared/lib/app-router-context.shared-runtime";
import {
  ReadonlyURLSearchParams,
  usePathname,
  useRouter,
  useSearchParams,
} from "next/navigation";
import { useCallback } from "react";

/** Scroll container for app dashboard main column (`MainNav`); not `window`. */
export const DUB_DASHBOARD_MAIN_SCROLL_ID = "dub-dashboard-main-scroll";

let pendingDashboardScrollTop: number | null = null;

/** Call after URL updates (e.g. in `useLayoutEffect`) to restore nested scroll. */
export function consumePendingDashboardScrollTop(): number | null {
  const top = pendingDashboardScrollTop;
  pendingDashboardScrollTop = null;
  return top;
}

export function useRouterStuff() {
  const pathname = usePathname();
  const router = useRouter();
  const searchParams = useSearchParams();
  const searchParamsObj = Object.fromEntries(searchParams);

  const getQueryString = (
    kv?: Record<string, any>,
    opts?: {
      include?: string[];
      exclude?: string[];
    },
  ) => {
    let newParams = new URLSearchParams(searchParams);
    if (opts?.include && Array.isArray(opts.include)) {
      const filteredParams = new URLSearchParams();
      searchParams.forEach((value, key) => {
        if (opts.include?.includes(key)) {
          filteredParams.set(key, value);
        }
      });
      newParams = filteredParams;
    }
    if (opts?.exclude && Array.isArray(opts.exclude)) {
      opts.exclude.forEach((k) => newParams.delete(k));
    }
    if (kv) {
      Object.entries(kv).forEach(([k, v]) => newParams.set(k, v));
    }
    const queryString = newParams.toString();
    return queryString.length > 0 ? `?${queryString}` : "";
  };

  const queryParams = useCallback(
    ({
      set,
      del,
      replace,
      scroll = false,
      getNewPath,
      arrayDelimiter = ",",
    }: {
      set?: Record<string, string | string[]>;
      del?: string | string[];
      replace?: boolean;
      scroll?: boolean;
      getNewPath?: boolean;
      arrayDelimiter?: string;
    }) => {
      const newParams = new URLSearchParams(searchParams);
      if (set) {
        Object.entries(set).forEach(([k, v]) =>
          newParams.set(k, Array.isArray(v) ? v.join(arrayDelimiter) : v),
        );
      }
      if (del) {
        if (Array.isArray(del)) {
          del.forEach((k) => newParams.delete(k));
        } else {
          newParams.delete(del);
        }
      }
      const queryString = newParams.toString();
      const newPath = `${pathname}${
        queryString.length > 0 ? `?${queryString}` : ""
      }`;
      if (getNewPath) return newPath;

      // Nested overflow container scroll is not preserved by Next's `scroll: false` (window-only).
      if (scroll === false && typeof document !== "undefined") {
        const el = document.getElementById(DUB_DASHBOARD_MAIN_SCROLL_ID);
        if (el) pendingDashboardScrollTop = el.scrollTop;
      }

      if (replace) {
        router.replace(newPath, { scroll: false });
      } else {
        router.push(newPath, { scroll });
      }
    },
    [searchParams, pathname, router],
  );

  return {
    pathname: pathname as string,
    router: router as AppRouterInstance,
    searchParams: searchParams as ReadonlyURLSearchParams,
    searchParamsObj,
    queryParams,
    getQueryString,
  };
}