Widget Parameters

Some widgets have optional parameters that can be passed to them

Callbacks

Every method that shows a widget has an optional parameter called callbacks.

NameTypeDescription

onClose

Boolean

Called on closing of widget by user

onError

Boolean

Called on error inside widget

onSuccess

Boolean

Called on success

Not all of the callbacks are implemented by every method.

Usage Example

sdk.wallet.create({
  callbacks: {
    onClose: () => console.log('closed'),
    onError: (error) => console.log('error', error),
    onSuccess: () => console.log('success'),
  },
})

Settings

Every method that shows a widget has an optional parameter called settings.

NameTypeDefaultDescription

fullScreen

Boolean

false

Show the widget in a full screen

hideMenu

Boolean

false

Deprecated

preventClose

Boolean

false

Hide the X button

returnUrl

Boolean

false

Returning the URL of the widget instead of presenting it

redirectUri

Boolean

false

Redirects after the widget closes

isTopWindow

Boolean

false

Ensures widget Redirects is top-level window.

Usage Example

sdk.wallet.showRecoveryPhrase({ settings: { fullScreen: true } })

Last updated