src/utils/useSearchParams.ts

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import {
  getRouteApi,
  type RegisteredRouter,
  type RouteIds,
  useNavigate,
} from '@tanstack/react-router';
import { useCallback } from 'react';



export type RouteTreeIds = RouteIds<RegisteredRouter['routeTree']>;

export const useSearchParams = <T extends RouteTreeIds, P extends object>(
  routeId: T
) => {
  const { useSearch } = getRouteApi<T>(routeId);
  const navigate = useNavigate();
  const params = useSearch() as P;

  const setParams = useCallback(
    (props: Partial<P>) => {
      return navigate({
        to: '.',
        search: (prev) => ({ ...prev, ...props }),
      });
    },
    [navigate]
  );
  const resetParams = useCallback(
    () => navigate({ to: '.', search: {}, replace: true }),
    [navigate]
  );

  return { params, setParams, resetParams } as const;
};

export type UseSearchParams<
  T extends RouteTreeIds,
  P extends object
> = ReturnType<typeof useSearchParams<T, P>>;