Installation#

Add @sigx/lynx-webauth to your project and register your callback scheme.

Install the package#

pnpm add @sigx/lynx-webauth

npm install @sigx/lynx-webauth

yarn add @sigx/lynx-webauth

bun add @sigx/lynx-webauth

Native setup#

Native modules are autolinked by @sigx/lynx-cli — run a prebuild after installing. On Android this also adds the androidx.browser (Custom Tabs) dependency:

sigx prebuild

Register your callback scheme#

The callbackScheme you pass to openAuthSession is your app's registered custom scheme — the same one Lynx already wires for Linking. Declare it once in signalx.config.ts and run sigx prebuild; the CLI registers it on both platforms (iOS CFBundleURLSchemes, an Android <intent-filter>):

// signalx.config.ts
import { defineLynxConfig } from '@sigx/lynx';

export default defineLynxConfig({
  name: 'My App',
  scheme: 'myapp', // registers myapp:// — used as the OAuth redirect target
});

Point your provider's redirect_uri at myapp://… (any path), and pass the bare scheme — 'myapp' — as the second argument to openAuthSession.

Verify#

import { isWebAuthAvailable } from '@sigx/lynx-webauth';

console.log(isWebAuthAvailable()); // true once the native module is linked