【Vuetify】v-skeleton-loaderのProps6種を検証してみた。

こんにちは、たかはしです。今回はVuetifyの理解を深めるため、UIコンポーネントの中でもあまりサンプルがなく、利用したことのない「Skeleton loaders」について、色々と検証したことを書いていこうと思います。

v-skeleton-loaderとは

主に、コンテンツがロードされていることを表現するためのコンポーネントです。例えば、画像の取得が終わらない時に代わりに画像を表示する予定のエリアに配置することで、「画像を読み込み中ですよ」と表現できます。

サンプル(読み込みしているように表現できる)

Propsを6種を検証してみる

Vuetifyの公式APIを確認してみると、v-skeleton-loaderのPropsは結構ありますが、それに対してサンプルがあまり用意されていません。実際に業務で使うことがなければ、どんな挙動をするのかわからないので、いくつかのPropsの挙動を検証してみたいと思います。

v-skeleton-loader API
API for the v-skeleton-loader component.
スケルトンローダー・コンポーネント
v-skeleton-loader コンポーネントは、プロジェクト内の多くの役割を満たすことができる多彩なツールです。 中心にあるコンポーネントは、何かが来ているが、まだ利用できないというユーザーへの指示を提供します。

boilerplate

読み込みアニメーションを無効にしてくれます。

無効時はアニメーションとマウスオーバー時にカーソルにアイコンがなくなっていますね。

左:boilerplate=false、右:boilerplate=true

loading

これは少し特殊でloadingがtrue時は特に変化はないのですが、falseの時にdefaultスロットにコンテンツを設定していると、そのコンテンツが表示されるようです。

loadingのtrue,falseを切り替えるサンプルを用意してみました、挙動が確認できると思います。

左:defaultスロットにコンテンツあり、右:コンテンツなし・loadingの追加のみ

transition

コンポーネントのトランジションを設定できます。どんな挙動になるのか検証したところ先ほどのloadingと組み合わせると、コンテンツの切り替え時にtransitionに設定した値が反映されるみたいです。読み込み完了時にコンテンツと入れ替える時に使えそうですね。サンプル用意してみました。

左:スケールするtransition、右:スライドするtransition

tile

各コンポーネントの四隅の丸みがなくなります、、、以上!。サンプルを用意しましたので、違いを確認できると思います。

左:tile=false、右:tile=true

type

表示するスケルトンの表示内容を設定できます。文字列で指定するのですが、事前に定義されているものがあるため、それを設定することで表示内容が変化します。また、カンマ区切りで複数の表示内容を組み合わせることもできます。

左から、type=”card”, type=”card-avatar”, type=”paragraph”, type=”paragraph, paragraph, paragraph”

VuetifyのUIコンポーネントと対応した表示形式が事前に定義されているので、スケルトンを配置したいコンポーネントに合わせて柔軟に対応できそうです。公式サイトに載っているものだけでも、30種類はあります。

types

先ほど述べた30種類の定義されているリストをカスタムできます。例えば 既存で{card: image, card-heading}という定義があるのですが、それを上書きすることができます。{card: image, card-heading, card-heading}というオブジェクトを用意してtypesにセット、typeにcardを指定してあげると内容が変化します。独自のスケルトンを作成して、共通で利用したい際に便利な気がします。

左:typesを指定、右:typesを未指定

以上が、v-skeleton-loaderのPropsでどのようなことができるのか検証した結果になります。割と触ったことのないUIコンポーネントを今回のように一つ一つ検証するのは、Vuetifyの理解に繋がりました。

まだまだVuetifyのUIコンポーネントはあるので、今後をやってみようかなと思います。

Reference

スケルトンローダー・コンポーネント
v-skeleton-loader コンポーネントは、プロジェクト内の多くの役割を満たすことができる多彩なツールです。 中心にあるコンポーネントは、何かが来ているが、まだ利用できないというユーザーへの指示を提供します。
v-skeleton-loader API
API for the v-skeleton-loader component.