目次
vue-typicalとは
vue-typical は、タイピング風にテキストを表示するアニメーションを実装するための軽量ライブラリです。
容易な実装が可能で、ライブラリも軽量な為、ちょっとサイトに動きを付けたいなと言う時に簡単に実装することが可能です。
【動画サイズ:24KB】
環境
この記事は、以下の管理人の検証環境にて記事にしています。
| vue.js | 2.6.10 |
| vue-typical | 1.6.2 |
ライブラリの取得
ライブラリを取得するには、npm, CDNのどれか一つを使用します。
npm
npm install vue-typical
CDN
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/typical.umd.min.js"></script>
gitリポジトリは以下から取得できます。
導入手順
管理人が行った、動作確認サンプルを実装するために、以下の手順でソースコードを導入していきます。
このサンプルでは、タイピング風のアニメーションを実装します。
step
1ライブラリの呼び出し
まずライブラリを呼び出す為に、以下の2通りのケースで呼び出します。
ES6等で実装する場合
import typical from './typical.js'
UMDで実装する場合
const typical = window['typical'];
step
2Vueインスタンスを設定
new Vue({
el: '#app',
components: {
typical
}
});
step
3テンプレートを準備
<typical>を設置します。
プロパティとして、steps を必須としてloop wrapper を設定します。
steps
必須プロパティです。
値は、配列で行います。
配列の中には、テキスト・数値・関数を設定することができます。
loop
テキストの表示回数を設定することが可能です。
回数の設定を数値で設定することもできますし、「Infinity」を設定することで無限にループさせることもできます。
wrapper
テキストを表示するときに、テキストを囲むタグを設定することができます。
サンプルはケバブケースで記載しています。
<div id="app">
<typical
:steps="['Hello', 1000, 'Hello world!', 500]"
:wrapper="'h2'"
></typical>
<typical
class="typicalWrapper"
:steps="['こんにちは', 1000,'みなさん!', 1000, 'カバノキです!', 3000]"
:loop="Infinity"
:wrapper="'h3'"
></typical>
</div>
サンプル
今回のソースを実際に触って確認できるようにデモを用意しました。
See the Pen
「vue-typical」でタイピング風に表示されるテキストを作る by カバの樹 (@kabanoki)
on CodePen.0
プロパティ
| プロパティ | 必須 | 型 | 入力例 |
| steps | 必須 | Array<String | Number | Function> | ['Hello', 1000, () => alert('Word')] |
| loop | Number | 1 or 'Infinity' | |
| wrapper | String | 'div' |
さいごに
タイピング風にテキストを表示するアニメーションを実装するためのライブラリでした。
今日はこの辺でー