Показ онбординга в iOS SDK

Если вы настроили онбординг с помощью билдера, вам не нужно беспокоиться о его рендеринге в коде мобильного приложения. Такой онбординг содержит как то, что должно отображаться, так и то, как именно это должно отображаться.

Прежде чем начать, убедитесь, что:

  1. Вы установили Adapty iOS SDK версии 3.8.0 или выше.
  2. Вы создали онбординг.
  3. Вы добавили онбординг в плейсмент.

Показ онбординга в Swift

Чтобы отобразить визуальный онбординг на экране устройства, выполните следующие шаги:

  1. Получите конфигурацию представления онбординга с помощью метода .getOnboardingConfiguration.

  2. Инициализируйте визуальный онбординг, который хотите отобразить, используя метод .onboardingController:

    Параметры запроса:

    ПараметрОбязательностьОписание
    onboarding configurationобязательныйОбъект AdaptyUI.OnboardingConfiguration, содержащий все свойства онбординга. Используйте метод AdaptyUI.getOnboardingConfiguration для его получения.
    delegateобязательныйAdaptyOnboardingControllerDelegate для прослушивания событий онбординга.

    Возвращает:

    ОбъектОписание
    AdaptyOnboardingControllerОбъект, представляющий запрошенный экран онбординга
  3. После того как объект успешно создан, вы можете отобразить его на экране устройства:

    import Adapty
    import AdaptyUI
    
    // 0. Get an onboarding if you haven't done it yet     
    let onboarding = try await Adapty.getOnboarding(placementId: "YOUR_PLACEMENT_ID")
    
    // 1. Obtain the onboarding view configuration:
    let configuration = try AdaptyUI.getOnboardingConfiguration(forOnboarding: onboarding)
    
    // 2. Create Onboarding View Controller
    let onboardingController = try AdaptyUI.onboardingController(
        with: configuration,
        delegate: <AdaptyOnboardingControllerDelegate>
    ) 
    
    // 3. Present it to the user
    present(onboardingController, animated: true)

Показ онбординга в SwiftUI

Чтобы отобразить визуальный онбординг на экране устройства в SwiftUI:

// 1. Obtain the onboarding view configuration:
let configuration = try AdaptyUI.getOnboardingConfiguration(forOnboarding: onboarding)

// 2. Display the Onboarding View within your view hierarchy
AdaptyOnboardingView(
    configuration: configuration,
    placeholder: { Text("Your Placeholder View") },
    onCloseAction: { action in
        // hide the onboarding view
    },
    onError: { error in
         // handle the error
    }
)

Плавные переходы между сплэш-экраном и онбордингом

По умолчанию между сплэш-экраном и онбордингом отображается экран загрузки, пока онбординг полностью не загрузится. Однако если вы хотите сделать переход плавнее, вы можете настроить его: либо продлить показ сплэш-экрана, либо отобразить что-то другое.

Для этого определите placeholder — то, что будет отображаться во время загрузки онбординга. Если placeholder задан, онбординг будет загружаться в фоне и автоматически отобразится, как только будет готов.

Настройка открытия ссылок в онбординге поддерживается начиная с Adapty SDK v.3.15.1.

По умолчанию ссылки в онбординге открываются во встроенном браузере. Это обеспечивает бесшовный пользовательский опыт: веб-страницы отображаются прямо внутри приложения, и пользователю не нужно переключаться между приложениями.

Если вы предпочитаете открывать ссылки во внешнем браузере, вы можете изменить это поведение, установив параметр externalUrlsPresentation в значение .externalBrowser:


let configuration = try AdaptyUI.getOnboardingConfiguration(
    forOnboarding: onboarding,
    externalUrlsPresentation: .externalBrowser // default – .inAppBrowser
)