Files
SnowLuma/.pnpm-store/v11/files/6d/8118ca0d396040ed1fcd22646d34a21618202f9ff7b4666c63cf8d641b19af6a5467ea5f933bf0ebd4118ae5546a420b2021daeb4f287ca37d1c2e88dadfb5
TanTan 2a69b23b47
Dev Build / cleanup (push) Canceled after 0s
Dev Build / typecheck (push) Canceled after 0s
Dev Build / build (linux-arm64, ubuntu-24.04-arm, linux-arm64) (push) Canceled after 0s
Dev Build / build (linux-x64, ubuntu-latest, linux-x64) (push) Canceled after 0s
Dev Build / build (win-x64, windows-latest, win32-x64) (push) Canceled after 0s
Dev Build / dispatch-dev-docker (push) Canceled after 0s
docs: 仓库链接指向本镜像仓库
2026-11-13 09:27:07 +08:00

91 lines
2.9 KiB
Plaintext

'use client'
import { useStore } from '@tanstack/react-store'
import { useRef } from 'react'
import { replaceEqualDeep } from '@tanstack/router-core'
import { isServer } from '@tanstack/router-core/isServer'
import { useRouter } from './useRouter'
import type {
AnyRouter,
RegisteredRouter,
RouterState,
} from '@tanstack/router-core'
import type {
StructuralSharingOption,
ValidateSelected,
} from './structuralSharing'
export type UseRouterStateOptions<
TRouter extends AnyRouter,
TSelected,
TStructuralSharing,
> = {
router?: TRouter
select?: (
state: RouterState<TRouter['routeTree']>,
) => ValidateSelected<TRouter, TSelected, TStructuralSharing>
} & StructuralSharingOption<TRouter, TSelected, TStructuralSharing>
export type UseRouterStateResult<
TRouter extends AnyRouter,
TSelected,
> = unknown extends TSelected ? RouterState<TRouter['routeTree']> : TSelected
/**
* Subscribe to the router's state store with optional selection and
* structural sharing for render optimization.
*
* Options:
* - `select`: Project the full router state to a derived slice
* - `structuralSharing`: Replace-equal semantics for stable references
* - `router`: Read state from a specific router instance instead of context
*
* @returns The selected router state (or the full state by default).
* @link https://tanstack.com/router/latest/docs/framework/react/api/router/useRouterStateHook
*/
export function useRouterState<
TRouter extends AnyRouter = RegisteredRouter,
TSelected = unknown,
TStructuralSharing extends boolean = boolean,
>(
opts?: UseRouterStateOptions<TRouter, TSelected, TStructuralSharing>,
): UseRouterStateResult<TRouter, TSelected> {
const contextRouter = useRouter<TRouter>({
warn: opts?.router === undefined,
})
const router = opts?.router || contextRouter
// During SSR we render exactly once and do not need reactivity.
// Avoid subscribing to the store (and any structural sharing work) on the server.
const _isServer = isServer ?? router.isServer
if (_isServer) {
const state = router.stores.__store.get() as RouterState<
TRouter['routeTree']
>
return (opts?.select ? opts.select(state) : state) as UseRouterStateResult<
TRouter,
TSelected
>
}
const previousResult =
// eslint-disable-next-line react-hooks/rules-of-hooks
useRef<ValidateSelected<TRouter, TSelected, TStructuralSharing>>(undefined)
// eslint-disable-next-line react-hooks/rules-of-hooks
return useStore(router.stores.__store, (state) => {
if (opts?.select) {
if (opts.structuralSharing ?? router.options.defaultStructuralSharing) {
const newSlice = replaceEqualDeep(
previousResult.current,
opts.select(state),
)
previousResult.current = newSlice
return newSlice
}
return opts.select(state)
}
return state
}) as UseRouterStateResult<TRouter, TSelected>
}