Skip to content

@vowel.to/client v0.3.3-beta


@vowel.to/client / index / createTanStackHookAdapter

Function: createTanStackHookAdapter()

ts
function createTanStackHookAdapter(navigate, pathname): NavigationAdapter;

Defined in: lib/vowel/adapters/navigation/tanstack-navigation-adapter.ts:196

Create a TanStack Router adapter using navigation hooks This version is for use within React components

Parameters

ParameterTypeDescription
navigate(opts) => Promise<void>navigate function from useNavigate() hook
pathnamestringcurrent pathname from useRouterState() or similar

Returns

NavigationAdapter

NavigationAdapter

Example

tsx
import { useNavigate, useRouterState } from '@tanstack/react-router';
import { createTanStackHookAdapter } from '@vowel.to/client/adapters/navigation';

function App() {
  const navigate = useNavigate();
  const pathname = useRouterState({ select: s => s.location.pathname });
  
  const navigationAdapter = useMemo(
    () => createTanStackHookAdapter(navigate, pathname),
    [navigate, pathname]
  );
  
  return <Vowel navigationAdapter={navigationAdapter} />;
}