Documentation
    Preparing search index...

    Interface TonConnectUiOptions

    Runtime-tunable UI options. Pass on the constructor, or assign through tonConnectUI.uiOptions = { ... } to update them later — the setter merges the patch with the previous value and re-renders.

    interface TonConnectUiOptions {
        actionsConfiguration?: ActionConfiguration;
        analytics?: AnalyticsSettings;
        buttonRootId?: null | string;
        enableAndroidBackHandler?: boolean;
        language?: Locales;
        uiPreferences?: UIPreferences;
        walletsListConfiguration?: WalletsListConfiguration;
        walletsPreferredFeatures?: RequiredFeatures;
        walletsRequiredFeatures?: RequiredFeatures;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionsConfiguration? analytics? buttonRootId? enableAndroidBackHandler? language? uiPreferences? walletsListConfiguration? walletsPreferredFeatures? walletsRequiredFeatures?

    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
    enableAndroidBackHandler?: boolean

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

    true
    language?: Locales

    Language for the strings shown inside SDK-rendered UI.

    'en'
    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)

    Settings

    Member Visibility

    On This Page

    Properties