Launching the pre-built UI

The Web SDK can be used to launch the pre-built UI.

const result = await authsignal.launch(url, {
  mode: "popup",
});

authsignal.launch(url, {
  mode: "redirect",
});

const result = await authsignal.launch(url, {
  mode: "window",
});

Parameters

url

string

The URL obtained on your server by tracking an action.

options

LaunchOptions Object

The options used when launching the pre-built UI.

Show child attributes

mode

popup | redirect | window

How the pre-built UI should launch: popup opens it in an overlay, window opens it in a separate browser window, and redirect triggers a full page redirect. If no value is supplied, mode defaults to redirect.

Only available when mode is popup.

Hide child attributes

width

string

Any valid CSS value for the width property.

height

string

Any valid CSS value for the height property. If not set, the popup will auto-adjust to the height of the content.

isClosable

boolean

Whether the popup is closable with the escape key and by clicking the backdrop.

windowOptions

Object

Only available when mode is window.

Hide child attributes

width

number

The width of the window in pixels.

height

number

The height of the window in pixels.

onError

function

Called when an unexpected API error occurs in the pre-built UI. Available when mode is popup or window.

Hide child attributes

errorCode

string

The error code returned by the API.

statusCode

number

The HTTP status code of the failed request.

Response

Promise<TokenPayload>

When mode is set as popup or window it returns a Promise<TokenPayload> that resolves when the popup or window closes.

Hide child attributes

token

string

The token that can be used to verify the outcome of the user action.

For more information on launching the pre-built UI see our detailed guide.

​Parameters

​Response

Parameters

Response