Documentation
    Preparing search index...

    Interface TonConnectUiOptionsWithConnector

    Reuse an externally-built ITonConnect. Useful when the dApp drives @tonconnect/sdk directly and only wants the UI layer on top, or when server-side rendering supplies the connector through a custom factory.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    actionsConfiguration?: ActionConfiguration

    Modal / notification behavior and the return strategy for action deep links (sendTransaction, signData, signMessage). See ActionConfiguration.

    analytics?: AnalyticsSettings

    Analytics configuration forwarded to the underlying TonConnect instance. See AnalyticsSettings from @tonconnect/sdk.

    buttonRootId?: null | string

    HTML element id under which the "Connect Wallet" button mounts. With null (default) the button is not rendered — use this when the dApp triggers the modal from a custom control via tonConnectUI.openModal().

    null
    connector?: ITonConnect

    Pre-built ITonConnect instance. The UI does not create its own connector; option fields like manifestUrl are ignored.

    enableAndroidBackHandler?: boolean

    Close modals and notifications when the Android system back button is pressed. Disable when the dApp manages browser history manually.

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

    Custom event dispatcher for both SDK- and UI-layer user-action events. Defaults to window.dispatchEvent (BrowserEventDispatcher).

    language?: Locales

    Language for the strings shown inside SDK-rendered UI.

    'en'
    restoreConnection?: boolean

    Attempt to restore the previous session from storage on mount. Set to false for flows that prefer an explicit connect step.

    true
    uiPreferences?: UIPreferences

    Visual configuration — theme, border radius, color overrides.

    walletsListConfiguration?: WalletsListConfiguration

    Wallets-list overrides — include extra wallets, reorder existing ones. See WalletsListConfiguration.

    walletsPreferredFeatures?: RequiredFeatures

    Soft preference filter — non-matching wallets are still clickable but sorted below the separator. Same shape as walletsRequiredFeatures; the SDK does NOT enforce the match at connect time, so the dApp must handle missing features itself.

    walletsRequiredFeatures?: RequiredFeatures

    Hide wallets that don't advertise the listed features. Non-matching entries are greyed out below the separator on the "All wallets" screen and rejected at connect time with WalletMissingRequiredFeaturesError.

    Filter wallets by required features (docs)

    widgetRootId?: string

    HTML element id under which the SDK attaches its modal root. When omitted, the SDK creates div#tc-widget-root at the end of <body> and uses it.

    'tc-widget-root'

    Settings

    Member Visibility

    On This Page

    Properties