Documentation
    Preparing search index...

    Interface TonConnectUiOptionsWithConnector

    interface TonConnectUiOptionsWithConnector {
        actionsConfiguration?: ActionConfiguration;
        buttonRootId?: null | string;
        connector?: ITonConnect;
        enableAndroidBackHandler?: boolean;
        eventDispatcher?: EventDispatcher<
            | RequestVersionEvent
            | ResponseVersionEvent
            | ConnectionStartedEvent
            | ConnectionCompletedEvent
            | ConnectionErrorEvent
            | ConnectionRestoringStartedEvent
            | ConnectionRestoringCompletedEvent
            | ConnectionRestoringErrorEvent
            | DisconnectionEvent
            | TransactionSentForSignatureEvent
            | TransactionSignedEvent
            | TransactionSigningFailedEvent
            | DataSentForSignatureEvent
            | DataSignedEvent
            | DataSigningFailedEvent,
        >;
        language?: Locales;
        restoreConnection?: boolean;
        uiPreferences?: UIPreferences;
        walletsListConfiguration?: WalletsListConfiguration;
        walletsPreferredFeatures?: RequiredFeatures;
        walletsRequiredFeatures?: RequiredFeatures;
        widgetRootId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionsConfiguration? buttonRootId? connector? enableAndroidBackHandler? eventDispatcher? language? restoreConnection? uiPreferences? walletsListConfiguration? walletsPreferredFeatures? walletsRequiredFeatures? widgetRootId?

    Properties

    actionsConfiguration?: ActionConfiguration

    Configuration for action-period (e.g. sendTransaction) UI elements: modals and notifications and wallet behaviour (return strategy).

    buttonRootId?: null | string

    HTML element id to attach the wallet connect button. If not passed button won't appear.

    null.
    connector?: ITonConnect

    TonConnect instance. Can be helpful if you use custom ITonConnect implementation, or use both of @tonconnect/sdk and @tonconnect/ui in your app.

    enableAndroidBackHandler?: boolean

    Specifies whether the Android back button should be used to close modals and notifications on Android devices.

    true
    eventDispatcher?: EventDispatcher<
        | RequestVersionEvent
        | ResponseVersionEvent
        | ConnectionStartedEvent
        | ConnectionCompletedEvent
        | ConnectionErrorEvent
        | ConnectionRestoringStartedEvent
        | ConnectionRestoringCompletedEvent
        | ConnectionRestoringErrorEvent
        | DisconnectionEvent
        | TransactionSentForSignatureEvent
        | TransactionSignedEvent
        | TransactionSigningFailedEvent
        | DataSentForSignatureEvent
        | DataSignedEvent
        | DataSigningFailedEvent,
    >

    Event dispatcher to track user actions. By default, it uses window.dispatchEvent for browser environment.

    BrowserEventDispatcher.
    language?: Locales

    Language for the phrases it the UI elements.

    system
    restoreConnection?: boolean

    Try to restore existing session and reconnect to the corresponding wallet.

    true.
    uiPreferences?: UIPreferences

    UI elements configuration.

    walletsListConfiguration?: WalletsListConfiguration

    Configuration for the wallets list in the connect wallet modal.

    walletsPreferredFeatures?: RequiredFeatures

    Preferred features for wallets. If wallet doesn't support preferred features, it will be moved to the end of the list.

    walletsRequiredFeatures?: RequiredFeatures

    Required features for wallets. If wallet doesn't support required features, it will be disabled.

    widgetRootId?: string

    HTML element id to attach the modal window element. If not passed, div#tc-widget-root in the end of the will be added and used.

    div#tc-widget-root.

    Settings

    Member Visibility

    On This Page

    Properties