19 lines
1.3 KiB
TypeScript
19 lines
1.3 KiB
TypeScript
import { StructuralSharingOption, ValidateSelected } from './structuralSharing.cjs';
|
|
import { AnyRouter, RegisteredRouter, RouterState } from '@tanstack/router-core';
|
|
export interface UseLocationBaseOptions<TRouter extends AnyRouter, TSelected, TStructuralSharing extends boolean = boolean> {
|
|
select?: (state: RouterState<TRouter['routeTree']>['location']) => ValidateSelected<TRouter, TSelected, TStructuralSharing>;
|
|
}
|
|
export type UseLocationResult<TRouter extends AnyRouter, TSelected> = unknown extends TSelected ? RouterState<TRouter['routeTree']>['location'] : TSelected;
|
|
/**
|
|
* Read the current location from the router state with optional selection.
|
|
* Useful for subscribing to just the pieces of location you care about.
|
|
*
|
|
* Options:
|
|
* - `select`: Project the `location` object to a derived value
|
|
* - `structuralSharing`: Enable structural sharing for stable references
|
|
*
|
|
* @returns The current location (or selected value).
|
|
* @link https://tanstack.com/router/latest/docs/framework/react/api/router/useLocationHook
|
|
*/
|
|
export declare function useLocation<TRouter extends AnyRouter = RegisteredRouter, TSelected = unknown, TStructuralSharing extends boolean = boolean>(opts?: UseLocationBaseOptions<TRouter, TSelected, TStructuralSharing> & StructuralSharingOption<TRouter, TSelected, TStructuralSharing>): UseLocationResult<TRouter, TSelected>;
|