Help us understand the problem. What is going on with this article?

vue-scrolltoの使い方(基本と別ページ遷移のケース)

はじめに

ページ内の特定のセクションに簡単にスムーズスクロールできるようにする vue-scrollto ですが、別ページから特定のページのアンカーリンクに飛ばしたい場合にどうすればいいのかまとめました。

通常の使い方

npmのインストール

公式はこちら → https://www.npmjs.com/package/vue-scrollto
ターミナルで vue-scrollto をインストールします。

$ yarn add vue-scrollto

pluginファイルを作成

/plugins 配下にvue-scrollto.jsを作成します。

/plugins/vue-scroll.js
import Vue from 'vue'
import VueScrollTo from 'vue-scrollto'

Vue.use(VueScrollTo, {
  /* オプション色々あります。公式サイトから確認できます。 */
  duration: 1000,
  easing: "ease"
})

nuxt.config.jsに追加

nuxt.config.jsplugins のところで上のjsファイルを読み込み。

nuxt.config.js
  plugins: [
    { src: '~/plugins/swiper.js', ssr: false },
    { src: '~/plugins/vue-scrollto'} /* こんな感じ */
  ],

vueファイルにvue-scrolltoを指定

指定のページでリンクの指定をします。これで、リンクをタップすると指定の位置までスクロールしてくれます。

hoge.vue
nuxt-link(v-scroll-to="'#aaa'", to)

section#aaa
 p ああああ

これだけです(*^^*)

別のページから遷移してきて指定のセクションまでスクロールしたい場合

さっきの例は同一ページでの遷移方法ですが別ページから遷移して指定の位置までスクロールしたい場合もあるかもしれません。そのやり方です。

hogeページの特定のセクションまでスクロールしたい場合、nuxt-linkのto属性に指定をいれます。

hoge.vue
nuxt-link(v-scroll-to="'#aaa'", to="/hoge/#aaa")

section#aaa
 p ああああ

そしてさらに同ページのscriptに下記を追加します。offsetとかは任意です。

hoge.vue
export default {
  mounted () {
    if ($nuxt.$route.hash) {
      this.scrollToHash()
    }
  },
  methods: {
    scrollToHash () {
      const hash=$nuxt.$route.hash
      this.$nextTick(() => {
        this.$scrollTo(hash, 0, { offset: -120 })
      })
    }
  }
};

これで、別ページからでも指定のセクションまでスクロールできるようになりました!

参考リンク

https://qiita.com/amishiro/items/f70aca4797cd57bc51b5
https://www.npmjs.com/package/vue-scrollto
https://github.com/rigor789/vue-scrollto/issues/100

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away