Skip to content

@vowel.to/client v0.1.2-393


@vowel.to/client / index / createDirectAdapters

Function: createDirectAdapters()

ts
function createDirectAdapters(options): {
  navigationAdapter: NavigationAdapter;
  automationAdapter?: AutomationAdapter;
};

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

Create direct adapters for SPAs

Perfect for React, Vue, Next.js, Svelte, and other SPA frameworks.

Parameters

ParameterTypeDescription
optionsDirectAdaptersOptionsConfiguration options

Returns

ts
{
  navigationAdapter: NavigationAdapter;
  automationAdapter?: AutomationAdapter;
}

Navigation and automation adapters

NameTypeDefined in
navigationAdapterNavigationAdapterlib/vowel/adapters/helpers.ts:108
automationAdapter?AutomationAdapterlib/vowel/adapters/helpers.ts:109

Example

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

const router = useRouter();

const { navigationAdapter, automationAdapter } = createDirectAdapters({
  navigate: (path) => router.push(path),
  routes: [
    { path: '/', description: 'Home' },
    { path: '/about', description: 'About' }
  ],
  enableAutomation: true
});

const vowel = new Vowel({
  appId: 'app-id',
  navigationAdapter,
  automationAdapter
});