スクロールの振る舞い

Watch a free video course about Vue Router on Vue School

クライアントサイドのルーティングを使っている時に、新しいルートに対してスクロールをトップへ移動させたいかもしれません、もしくは実際のページリロードがしているように history 要素のスクロールポジションを保持したいこともあるかもしれません。 vue-router ではこれらをさらによく実現できます。ルートナビゲーションにおけるスクロールの挙動を完全にカスタマイズすることができます。

注意: この機能は ブラウザが history.pushState をサポートしている場合のみ動作します。

ルーターインスタンスを作る時に、 scrollBehavior 関数を提供できます。

const router = new VueRouter({
  routes: [...],
  scrollBehavior (to, from, savedPosition) {
    // 望みのポジションを返す
  }
})

scrollBehavior 関数は to と from のルートオブジェクトを受け取ります。第 3 引数の savedPosition は popstate ナビゲーション (ブラウザの戻る/進むボタンがトリガーされた) 時のみ利用可能です。

この関数はスクロールポジションオブジェクトを返すことができます。そのオブジェクトは以下のような形式です。

• { x: number, y: number }
• { selector: string }
• { selector: string, offset? : { x: number, y: number }} (2.6.0 以降においてだけ offset はサポート)

もし falsy な値や空のオブジェクトが返った場合、何もスクロールは起きません。

例:

scrollBehavior (to, from, savedPosition) {
  return { x: 0, y: 0 }
}

これは単純に全てのルートナビゲーションに対してページスクロールをトップにします。

savedPosition を返すことは結果的に戻る/進むボタンを押してナビゲーションした時にネイティブのような挙動になります。

scrollBehavior (to, from, savedPosition) {
  if (savedPosition) {
    return savedPosition
  } else {
    return { x: 0, y: 0 }
  }
}

もし"アンカーへスクロール"の振る舞いをシミュレートしたい場合は以下のようにしてください。

scrollBehavior (to, from, savedPosition) {
  if (to.hash) {
    return {
      selector: to.hash
      // , offset: { x: 0, y: 10 }
    }
  }
}

きめの細かいスクロールの挙動コントロールを実装するために ルートメタフィールド も利用可能です。詳細な例は こちら をご参照ください。

非同期なスクローリング

2.8.0 で新規

期待する位置記述子 (position descriptor) に解決されるプロミスを返すこともできます:

scrollBehavior (to, from, savedPosition) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve({ x: 0, y: 0 })
    }, 500)
  })
}

スクロールの振る舞いをページの遷移とうまく合わせるために、ページレベルのトランジションコンポーネントからのイベントにフックすることは可能ですが、ユースケースにおいて可能性のある食い違いと複雑さのために、単純に特定のユーザランド実装を可能にするために、このプリミティブな機能を提供します。