「Lottie」はベクター画像のアニメーションを実現できる技術・ファイルフォーマットです。
Lottieアニメーションの作り方編の記事(Figma編、After Effects編)では、Lottieの概要から作り方、ファイルの書き出し方までを紹介しました。本記事では、Lottieアニメーションの実装方法について紹介します。
Lottieの組み込みはプラットフォームに応じたさまざまな実装方法が用意されていますが、一般的なウェブの方法を例に紹介します。実装編の前編となる本記事では、手軽に組み込むことができるWeb Player(lottie-player、dotlottie-player)を使用して実装します。
iOS、Androidアプリケーション等のそのほかの実装方法は公式ドキュメントを参照ください。
アニメーションの実装
ウェブ向けの実装方法は大きく2パターンあります。HTMLメインの方法と、JavaScriptメインで実装する方法です。
-
HTMLメインで実装:Web Player(LottieFilesの提供)
- lottie-player:
.json
拡張子Lottieの表示に使用します。再生方法の調整など簡単な制御を行えます。 - dotlottie-player: dotLottie(
.lottie
拡張子Lottie)および.json
拡張子Lottieの表示に使用します。再生方法の調整など簡単な制御を行えます。 - Lottie Interactivity: よりインタラクティブなアニメーションを行う場合にlottie-playerと一緒に使用します。スクロールやカーソルの位置と組み合わせたアニメーションの制御などが行えます。
- 特長: HTMLメインで手軽に導入できます。
- lottie-player:
-
JavaScriptで実装:lottie-web(Airbnbの提供)
- lottie-web:
lottie.loadAnimation()
でアニメーションを実装します。 - 特長: JavaScriptメインで再生タイミングやパフォーマンスなど細かく制御できます。
- lottie-web:
Web Playerを使用した実装
まずはコピペでできる、組み込み方法を紹介します。もっとも簡単なのがLottieFiles Web PlayerのツールからスニペットをコピーしHTMLに貼り付ける方法です。
アニメーションのパラメーターを調整し、プレーヤーの形式を選択してから[Copy Code]ボタンでコードをコピーします。HTMLのbodyタグにスニペットを貼り付ければLottieが再生されます。
このツールを使用する場合はファイル形式(※)に紐づいたプレーヤーの種類でコードが生成されるので、dotLottie形式でもJSON形式のLottieでも、どちらでも問題ありません。後述のLottie Interactivityを併せて使用したい場合は、「Lottie JSON」を選択しましょう。
※Lottieのファイル形式の違いについては、記事『最新版! Lottieアニメーションの作り方 - Figma編』にて紹介していますので参照ください。
<script src="https://unpkg.com/@dotlottie/player-component@latest/dist/dotlottie-player.mjs" type="module"></script>
<dotlottie-player src="https://lottie.host/6bed0136-e3d6-42be-ab92-fcb3f29e3cf4/a8u7RGCyP6.json" background="transparent"
speed="1" style="width: 300px; height: 300px" direction="1" playMode="normal" loop controls autoplay></dotlottie-player>
続いて、より詳しく内容を理解したい方、アニメーションを細かく調整したいといった方向けに、一からコードベースで実装する手順を紹介します。
①ライブラリのインポート
ドキュメントにしたがってlottie-playerのライブラリをインポートします。
- CDNで読み込みたい場合
<script src="https://unpkg.com/@lottiefiles/lottie-player@latest/dist/lottie-player.js"></script>
- パッケージマネージャーの場合
npm install --save @lottiefiles/lottie-player
②lottie-player
タグを記述し、src
にLottieのパスを指定
<lottie-player
src="../assets/present-anim.json"
></lottie-player>
LottieFilesで公開されているLottieファイルを使用する場合は、URLを指定します。導入方法は、LottieFiles Japan公式noteの記事にも掲載されていますので必要に応じて参照ください。
<lottie-player
src="https://lottie.host/6bed0136-e3d6-42be-ab92-fcb3f29e3cf4/a8u7RGCyP6.json"
></lottie-player>
③目的に応じたプロパティを追加
準備ができたところで、アニメーションの再生を調整してみましょう。読み込み後にループ再生を自動で開始し、再生速度を0.5倍速に変更するアニメーションの場合は、以下のようにプロパティを追加します。
<lottie-player
src="../assets/present-anim.json"
autoplay loop speed="0.5"
></lottie-player>
参照:主要なプロパティ一覧
たった数行でLottieアニメーションを組み込めました。LottieFilesのツールでは設定できないパラメーターも調整できるのが実装の利点です。そのほかに指定できるプロパティは、作例にもまとめていますのでぜひご活用ください。
コラム:dotLottie形式
.lottie
拡張子の組み込み方法も紹介します。.lottie
拡張子は、通常の.json
拡張子Lottieの再生に使用するlottie-playerでは再生できません。代わりにdotlottie-playerもしくは、dotlottie-wcを使用する必要があります。
2024年6月現在、dotlottie-playerパッケージはメンテナンスされておらず、dotlottie-webパッケージに切り替えていくようです。dotlottie-playerの代替のウェブコンポーネントは、dotlottie-wcとして提供されています。
▼dotlottie-playerのインポート(CDN)
<script src="https://unpkg.com/@dotlottie/player-component@latest/dist/dotlottie-player.js"></script>
▼使用例
<dotlottie-player autoplay loop src="../assets/present-anim.lottie"></dotlottie-player>
Lottie Interactivityでインタラクティブなアニメーションを
よりインタラクティブにアニメーションを制御したい場合は、lottie-interactivityを導入しましょう。
どのようなことができるかは、Interactivity Guideをご覧ください。アニメーションとコードの例が丁寧に記載されています。
①ライブラリのインポート
lottie-interactivityのライブラリをインポートします。実装には前述のlottie-playerも使用しますので、ライブラリをインポートしておいてください。
- CDNで読み込みたい場合
<script src="https://unpkg.com/@lottiefiles/lottie-interactivity@latest/dist/lottie-interactivity.min.js"></script
- パッケージマネージャーの場合
npm install --save @lottiefiles/lottie-interactivity
②lottie-playerにid属性を追加
JavaScriptから参照するためのid
属性を追加します。
<lottie-player
id="lottie"
src="https://lottie.host/2dc80a15-d7f9-49d4-9be0-3d3450b826e6/0JAw6NYf0o.json"
></lottie-player>
③LottieInteractivityを使用してアニメーションを制御
LottieInteractivity.create()
を用意し、引数にオブジェクトを渡します。オブジェクトに指定できるメソッドは以下のとおりです。
mode
: イベントの種類。cursor
、scroll
、chain
が指定可能。cursor
:カーソルに応じてアニメーション。scroll
:スクロールに応じてアニメーション。chain
:複数のフレームを繋げるアニメーション。トランジション方法や再生方法が各セグメントごとに指定可能。
actions
: インタラクションを定義したアニメーションのオブジェクト配列。mode
メソッドに指定した値に応じて各オブジェクトには複数のプロパティが指定できます。player
: 参照するDOM要素・アニメーション。container
:スクロールアニメーションのコンテナー要素。mode
がscroll
の場合に使用されます。
LottieInteractivity.create({
player: "#lottie", // lottie-playerに追加したid
mode: "chain", // セグメントを加工し繋げるアニメーション
actions: [
// ここにアニメーションを追加
]
});
今回作成するアニメーションです。元のデータは一定のスピードでループするアニメーションですが、mode: "chain"
を使用して、クリックするたびに繋ぎのアニメーションとループアニメーションを挟みながら、アニメーションスピードが速くなるような加工をしてみます。
▼クリックでアニメーションが変化します。
④actionsにインタラクションを指定したアニメーションを追加
actions
にセグメントの配列を追加します。state
やtransition
等のパラメーターを指定し、インタラクティブなアニメーションを作ります。
- ループ再生アニメーションのセグメントでは、
state: "loop"
でループ再生指定し、frames: [0, 61]
で再生するフレームを指定します。また、transition
をclick
にすることで、次のセグメントへ移ります。 - 繋ぎのアニメーションセグメントでは、
state: "autoplay"
で自動再生にし、transition: "onComplete"
でアニメーション完了後、次のセグメントへ移動するようにしておきます。 - おおよそ手順1と同じパラメーターを指定し、
speed: 2
を追加することで倍速再生に加工します。 - これを繰り返し記述します。省略部分はサンプルコードをご確認ください。
LottieInteractivity.create({
player: "#lottie", // lottie-playerに追加したid
mode: "chain", // セグメントを加工し繋げるアニメーション
actions: [
// ループ再生
{
state: "loop",
transition: "click", // クリックした時に次のセグメントへ
frames: [0, 61],
},
// 繋ぎのアニメーション
{
state: "autoplay",
transition: "onComplete", // 指定フレームまでの再生終了後、次のセグメントへ
forceFlag: false,
frames: [61, 113],
},
// ループ再生
{
state: "loop",
transition: "click", // クリックした時に次のセグメントへ
forceFlag: false,
frames: [113, 174],
speed: 2, // 倍速に変更してみる
},
// …省略
]
});
おまけ
今回紹介は省略しますが、スクロールやマウスの位置に応じたアニメーションも、複雑なイベントリスナーなどを登録せずほんの数行で実装できます。ぜひお試しください。
まとめ
lottie-playerを使用したLottieアニメーションの実装方法を紹介しました。HTMLだけでも実装が行えたりと、手軽に組み込みやすくなりましたね!
一方で、細かい制御・パフォーマンスを考慮する場合は、実装時のケアも重要です。実装編の後編となる次回の記事『JSでLottieを配置する方法』では、アニメーションの制御やパフォーマンスを考慮した、JavaScriptメインで実装する方法を紹介予定です。
参考サイト
連載一覧
- アニメーション
- 実装