在 Capacitor SDK 中展示用户引导

如果您已使用编辑工具自定义了用户引导,则无需担心在移动应用代码中渲染它以向用户展示。此类用户引导包含应在引导中显示的内容以及显示方式。

在开始之前,请确保:

  1. 您已创建用户引导
  2. 您已将用户引导添加到版位

展示用户引导

要展示用户引导,请对由 createOnboardingView 方法创建的 view 调用 view.present() 方法。每个 view 只能使用一次。如果您需要再次展示用户引导,请再次调用 createOnboardingView 以创建一个新的 view 实例。

在未重新创建的情况下重复使用同一个 view 可能会导致错误。

import { adapty, createOnboardingView } from '@adapty/capacitor';

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 展示样式

通过向 present() 方法传递 iosPresentationStyle 参数,可以配置用户引导在 iOS 上的展示方式。该参数接受 'full_screen'(默认值)或 'page_sheet' 值。

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

自定义用户引导中链接的打开方式需要 Adapty SDK v.3.15 及以上版本支持。

默认情况下,用户引导中的链接会在应用内浏览器中打开。这通过在应用内显示网页,提供无缝的用户体验,使用户无需切换应用即可查看网页。

如果您希望改为在外部浏览器中打开链接,可以通过将 openIn 参数设置为 browser_out_app 来自定义此行为:

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

后续步骤

展示用户引导后,您需要处理用户交互和事件。了解如何处理用户引导事件,以响应用户操作并跟踪分析数据。