Отображение онбординга в Capacitor SDK

Warning

Онбординги устарели начиная с Adapty SDK v4. Используйте флоу: в отличие от онбордингов, которые работают внутри WebView, флоу рендерятся нативно на устройстве — плавные анимации, нативный внешний вид, быстрая загрузка и никакой зависимости от WebView.

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

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

Создали онбординг.
Добавили онбординг в плейсмент.

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

Чтобы отобразить онбординг, вызовите метод view.present() на объекте view, созданном методом createOnboardingView. Каждый view можно использовать только один раз. Если нужно показать онбординг повторно, снова вызовите createOnboardingView, чтобы создать новый экземпляр view.

Warning

Повторное использование одного и того же view без его пересоздания может привести к ошибке.


try {
  const view = await createOnboardingView(onboarding);
  
  view.setEventHandlers({
    onClose: (actionId, meta) => {
      console.log('Onboarding closed:', actionId);
      return true; // Allow the onboarding to close
    },
    onCustom: (actionId, meta) => {
      console.log('Custom action:', actionId);
      return false; // Don't close the onboarding
    }
  });
  
  await view.present();
  console.log('Onboarding presented successfully');
} catch (error) {
  console.error('Failed to present onboarding:', error);
}

Настройка стиля отображения на iOS

Настройте способ отображения онбординга на iOS, передав параметр iosPresentationStyle в метод present(). Параметр принимает значения 'full_screen' (по умолчанию) или 'page_sheet'.

await view.present({ iosPresentationStyle: 'page_sheet' });

Настройте открытие ссылок в онбординге

Important

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

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

Если вы хотите открывать ссылки во внешнем браузере, задайте параметру openIn значение browser_out_app:

await view.present({ openIn: 'browser_out_app' }); // default — browser_in_app

Дальнейшие шаги

После отображения онбординга вам потребуется обрабатывать действия пользователя и события. Узнайте, как работать с событиями онбординга, чтобы реагировать на действия пользователей и отслеживать аналитику.