Lottieアニメーションでユーザーの進捗を表示する

このレシピに従って、ユーザーの進捗をLottieアニメーションとして表示しましょう。たとえば、デイリーストリークを示すリングが徐々に塗りつぶされるような表現が可能です。アプリはカスタム要素内でネイティブのLottieビューとしてアニメーションをレンダリングします。

Tip

このレシピは iOS アプリのみを対象としています。他のフレームワークで構築されたアプリでは、カスタム要素のフォールバックコンテンツのみが表示されます。Android およびクロスプラットフォームフレームワークのサポートは近日公開予定です。

始める前に

  • Adapty iOS SDK 4.4 以降にアップデートしてください。それより前のバージョンでは、すべてのカスタム要素にフォールバックコンテンツが表示されます。
  • アプリにフローを取得して表示するための設定を行ってください。
  • Swift Package Manager を使用して、https://github.com/airbnb/lottie-spm.git から Lottie をアプリに追加してください。
  • Lottie アニメーションを .json 形式で用意するか、サンプルの streak_ring.json をダウンロードしてください。アプリはアニメーションを最初から再生し、進捗に応じた位置で停止します(50% であれば中間で停止)。進捗を正確に表示するには、アニメーションに以下の条件が必要です:
    • 最初のフレームでは進捗がゼロで、最後のフレームで進捗が 100% になること。
    • イージングなしの一定速度であること。アニメーションがゆっくり始まって加速する場合、50% の時点で実際よりも少ない進捗しか表示されません。

1. カスタム要素をスクリーンに追加する

Flow & Paywall Builder で、フロースクリーンにカスタム要素を追加し、アニメーション用に設定します:

  • Type: lottie_animation。
  • ID: streak_ring。このレシピでは、ID はアニメーションファイル名にもなります。
  • Height: デフォルトの Fixed の高さを維持します。アニメーションはカスタム要素に合わせてスケーリングされます。

カスタム要素内に、リングの静止画像として Image を追加します。アニメーションを再生できないバージョンのアプリを使用しているユーザーは、この画像をフォールバックとして表示します。

2. アニメーションファイルをアプリに追加する

Xcode で、アニメーションファイルをアプリのターゲットに追加します。.json を除いたファイル名は、カスタム要素の ID と一致している必要があります。例えば streak_ring に対しては streak_ring.json のようにします。

3. アニメーションビューを作成する

ストリークのモデルと、アニメーションを再生する SwiftUI ビューを作成します。アプリはストリークが変化したときにモデルを更新します。ビューはモデルを読み取るため、画面を開いたときにリングが現在のストリークを表示します:

.playing(.fromProgress(0, toProgress: progress, loopMode: .playOnce)) はリングを空の状態から progress まで一度だけ塗りつぶします。アプリがすでに ObservableObject でストリークを管理している場合は、StreakStore の代わりにそのオブジェクトを使用してください。

4. アニメーションをカスタム要素に紐付ける

アプリ全体のリゾルバーに、ストリークモデル用のプロパティを追加します。次に、lottie_animation タイプと streak_ring ID に対して StreakRingView を返すケースを追加します。ハイライトされている行が追加箇所です。アプリにまだアプリ全体のリゾルバーがない場合は、コード全体をコピーしてください。

streak_ring のケースを他の lottie_animation ケースよりも前に置いてください。Swift は最初にマッチしたケースしか実行しないためです。アプリバンドルにそのIDのファイルが存在しない場合、リゾルバーは nil を返し、ユーザーにはフォールバックが表示されます。

ストリークモデルでリゾルバーを作成し、アプリ全体のリゾルバーとして設定します。AdaptyUI.setCustomElementsResolver(_:) はアプリ起動時など、一度だけ呼び出してください:

5. デバイスでテストする

フロー & ペイウォールビルダーはアプリのコードを実行できないため、キャンバスにはフォールバックのみが表示されます。アニメーションをプレビューするには、次の手順を実行します。

  1. フローを公開する。キャッシュ済みのバージョンではなく最新の公開バージョンを確認するには、デバイスをテストデバイスとして登録してください。
  2. リゾルバーを含むアプリのビルドを実行します。ストリークを 0 日、4 日、7 日など、いくつかの値に設定します。各値でスクリーンを開き、リングがその値まで埋まることを確認してください。

フォールバックをテストするには、アニメーションファイルをビルドから削除し、再度スクリーンを開いてください。

デバイスでのテスト方法については、iOSガイドのデバイスでテストするセクションをご覧ください。