@vowel.to/client v0.3.3-beta

---

@vowel.to/client / index / createNextJSAdapters

Function: createNextJSAdapters()

function createNextJSAdapters(router, options?): {
  navigationAdapter: NavigationAdapter;
  automationAdapter?: AutomationAdapter;
};

Defined in: lib/vowel/adapters/helpers.ts:269

Quick setup for Next.js

Parameters

Parameter	Type
router	{ push: (path) => void; }
router.push	(path) => void
options?	{ routes?: VowelRoute[]; enableAutomation?: boolean; }
options.routes?	VowelRoute[]
options.enableAutomation?	boolean

Returns

{
  navigationAdapter: NavigationAdapter;
  automationAdapter?: AutomationAdapter;
}

Name	Type	Defined in
navigationAdapter	NavigationAdapter	lib/vowel/adapters/helpers.ts:273
automationAdapter?	AutomationAdapter	lib/vowel/adapters/helpers.ts:274

Example

import { createNextJSAdapters } from '@vowel.to/client/adapters/helpers';
import { useRouter } from 'next/navigation';

const router = useRouter();
const adapters = createNextJSAdapters(router, {
  routes: [{ path: '/', description: 'Home' }]
});