Vue.jsで軽量、シンプルなスムーススクロール実装する「vue2-smooth-scroll」

vue2-smooth-scrollとは

vue2-smooth-scrollは、vue-smooth-scrollから拡張された軽量、シンプルなスムースクロールライブラリです。

垂直、水平、どちらにも設定が可能です。

【動画サイズ：43KB】

環境

この記事は、以下の管理人の検証環境にて記事にしています。

ライブラリの取得

ライブラリを取得するには、npm, CDNのどれか一つを使用します。

npm install --save vue2-smooth-scroll

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/vue-smooth-scroll.min.js"></script>

gitリポジトリは以下から取得できます。

導入手順

管理人が行った、動作確認サンプルを実装するために、以下の手順でソースコードを導入していきます。
このサンプルでは、垂直方向のスムースクロールを実装します。

step
1ライブラリの呼び出し

まずライブラリを呼び出す為に、以下の２通りのケースで呼び出します。

ES6等で実装する場合

import VueSmoothScroll from 'vue2-smooth-scroll'

UMDで実装する場合

const VueSmoothScroll = window['VueSmoothScroll'].default;

step
2メソッドを設定

Vue.use(VueSmoothScroll);

new Vue({
  el: '#app'
});

step
3テンプレートを準備

v-smooth-scroll プロパティを配置します。

サンプルはケバブケースで記載しています。

<div id="app">
  <h2 id="sec-3">Top Section</h2>
  <div style="height: 2000px;"></div>
  <a href="#sec-3" v-smooth-scroll>Go To Top</a>
</div>

サンプル

今回のソースを実際に触って確認できるようにデモを用意しました。

See the Pen Vue.jsで軽量、シンプルなスムーススクロール実装する「vue2-smooth-scroll」 by カバの樹 (@kabanoki) on CodePen.dark

さいごに

軽量、シンプルなスムースクロールライブラリでした。

今日はこの辺でー