Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface A8ConnectInitOptions

A8Connect init explanations

Hierarchy

  • A8ConnectInitOptions

Index

Properties

chainType: ChainType

chainType select supported chains for dapps

cleanWalletCache?: boolean

cleanWalletCache to clean wallet cache. Enable this option to force open Connect Wallet popup since the wallet cache is disabled.

disableCloseButton?: boolean

disableCloseButton to disable close button, so the popup won't be able to be closed manually until user completes the onboarding flow.

forceConnectWallet?: boolean

Enable forceConnectWallet to force connecting wallet regardless the wallet is connected or not.

globalContext?: Window & typeof globalThis

globalContext provide window context. Sometimes you need to directly pass window when init A8Connect.

initAppFlow?: AppFlow

initAppFlow select the initial onboarding flow, default will be Login/Connect Flow.

networkType: NetworkType

networkType select supported cluster for dapps

withCredential?: string

withCredential replace current jwt credential. Usually useful for LOST_WALLET_FLOW flow.

Methods

  • onAuth callback will be triggered when user is authenticated during the onboarding flow.

    Parameters

    Returns void

  • onClose(): void
  • onClose callback will be triggered when user complete onboarding flow or close the A8Connect popup.

    Returns void

  • onConnected callback will be triggered when user connect to a wallet during the onboarding flow.

    Parameters

    Returns void

  • onDisconnected(): void
  • onDisconnected callback will be triggered when user disconnected the wallet during the onboarding flow. Currently, only Lost Wallet flow emits this event.

    Returns void

  • onError(error: Error): void
  • onError callback will be triggered when errors occur during the onboarding flow.

    Parameters

    • error: Error

    Returns void

  • onLoggedOut(): void
  • onLoggedOut callback will be triggered when user logged out from the current session during the onboarding flow.

    Returns void

Generated using TypeDoc