Udemy 10. ログイン前のレイアウト構築 #04
2020年08月20日に更新

Nuxt.js addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)

ウェルカムページは、全4回に渡って構築します。

1/4 ウェルカムページを構築するコンポーネントファイルの作成

2/4 アイキャッチ画像の設置とツールバーの作成

3/4 スクロールイベントでツールバーの色を変える(今ここ)

4/4 レスポンシブデザインの対応(最終的なコード記載)

前回までのおさらい

前回はアイキャッチ画像を設置し、ツールバーにメニューボタンを用意しました。

2020-08-05 11-41-29

今回達成すること

ツールバーのスタイリングとメニューボタンの実装を行います。

ツールバーのスタイリング

ツールバーカラーは、スクロールを検知するイベントを設定し、

  • アイキャッチ上に表示されるときは透明で、
  • スクロールでアイキャッチを通過する場合は白色

変化させます。

2020-08-04 18-58-19 (2)

メニューボタンの実装

メニューボタンにはVuetifyのgoTo()メソッドを使用し、指定した場所までスクロールさせます。

2020-08-05 14-33-54 (4)

それでは実装に入りましょう。

スクロールを検知してツールバーの色を変える

下記の手順に沿って実装を行います。

  1. welcome.vueからアイキャッチ画像の高さを送り、
  2. スクロールを検知するイベントリスナーを追加。
  3. アプリ共通のツールバーの高さをVuexに保有する。
  4. スクロールポイントで色が切り替わる算出プロパティを追加する。

1. welcome.vueからアイキャッチの高さを送るんじゃ

welcome.vueで設定したimgHeight: 500を、welAppBar.vueに送ります。

front/layouts/welcome.vue
<template>
  <v-app>
    <!-- img-heightを追加 -->
    <wel-app-bar
      :menus="menus"
      :img-height="imgHeight"
    />
    ...

welAppBar.vueではpropsで受け取ります。

front/components/welcome/welAppBar.vue
<script>
export default {
  props: {
    menus: {
      type: Array,
      default: () => []
    },
    // 追加
    imgHeight: {
      type: Number,
      default: 0
    }
  },
  ...
}
</script>

2. addEventListenerを追加するんじゃ

welAppBar.vueaddEventListenerを追加します。

front/components/welcome/welAppBar.vue
      ...
      </v-btn>
    </v-toolbar-items>
    <!-- 確認のため追加 -->
    {{ scrollY }}
  </v-app-bar>
</template

<script>
export default {
  ...
  data ({ $config: { appName } }) {
    return {
      appName,
      // 追加
      scrollY: 0
    }
  },
  // 追加
  mounted () {
    window.addEventListener('scroll', this.onScroll)
  },
  beforeDestroy () {
    window.removeEventListener('scroll', this.onScroll)
  },
  methods: {
    onScroll () {
      this.scrollY = window.scrollY
    }
  }
  // ここまで
}
</script>
  • mounted () … Vueインスタンスがマウントされたに実行される。

    Vue内のデータや命令がHTML要素に紐付けされた後、つまりVueの実行準備が完全に整った後に実行されます。

  • addEventListener … スクロールを検知するとthis.onScrollメソッドが呼ばれる。

    これはJavaScriptのメソッドで、第一引数に指定したイベントが発生した時に第二引数の関数を実行します。

  • beforeDestroy () … Vueインスタンスが破壊されるに実行される。

    ページ遷移などにより、Vue内のデータや命令が削除される直前に実行されます。

  • removeEventListeneraddEventListenerで追加したイベントを削除する。

    addEventListenerによるメモリ消費を避けるために、追加したイベントは不要になるタイミングで削除しましょう。

  • onScroll () …データで用意した scrollYにウィンドウのスクロール値を代入する。
  • window … JavaScriptに用意されているオブジェクト。

    ブラウザ側だけで実行されるオブジェクトです。

    Nuxt.jsがUniversalモードの場合、サーバー側のレンダリング時にエラーになるため対応が必要です。

windowオブジェクトをクライアントサイドだけで実行する方法
export default {
  data () {
    return {
      isClient: process.client
    }
  },
  mounted () {
    if (this.isClient) {
      window.addEventListener('scroll', this.onScroll)
    }
  }
  ...
}

参考 window or document undefined - Nuxt.js

ブラウザでスクロール検知を確認してみましょう。

2020-08-05 09-34-45

ツールバー右の数字がスクロールによって変化していれば成功です。

確認が取れたらHTMLは削除します。

front/components/welcome/welAppBar.vue
     ....
     </v-btn>
    </v-toolbar-items>
    <!-- {{ scrollY }} 削除 -->
  </v-app-bar>
</template>

3. ツールバーの高さをVuexに保有するんじゃ

ツールバーの高さは、

  • ウェルカムページで使用するツールバーと、
  • ログイン・会員登録ページで使用するツールバー(まだ未作成)

同じ高さとなります。

そこで双方のコンポーネントから参照できるように、Vuexのindex.jsにデータを保有します。

front/store/index.js
export const state = () => ({
  loggedIn: false,
  // 追加
  styles: {
    beforeLogin: {
      appBarHeight: 56
    }
  }
})
...

4. 色を切り替える算出プロパティを追加するんじゃ

アイキャッチ画像の高さを基準に色を切り替える算出プロパティを作成します。

算出プロパティとは、computed内に宣言する関数のことです。

色を切り替えるタイミングは、「スクロール値がアイキャッチ画像からツールバーを引いた高さ」以上の場合に白、そうでなければ透明とします。

計算式で表すと、「スクロール値 > (500px - 56px) = 白」となります。

スクロールポイントでtrueを返す算出プロパティを追加する

welAppBar.vueにスクロールポイントでtrueを返す算出プロパティを追加します。

スクロールポイントは「アイキャッチ画像の高さ(500px) - ツールバーの高さ(56px) = 444px」となります。

front/components/welcome/welAppBar.vue
export default {
  ...
  // $storeを追加
  data ({ $config: { appName }, $store }) {
    return {
      appName,
      scrollY: 0,
      // 追加
      appBarHeight: $store.state.styles.beforeLogin.appBarHeight
    }
  },
  // computed追加
  computed: {
    isScrollPoint () {
      return this.scrollY > (this.imgHeight - this.appBarHeight)
    }
  },
  mounted () {
  ...
}

isScrollPointは、デフォルトでfalse

2020-08-05 10-15-51

スクロールポイントを経過するとtrueとなります。

2020-08-05 10-17-24

色を切り替える算出プロパティを追加する

isScrollPointを基準に色を切り替える算出プロパティを追加し、<v-app-bar>に新たなバインドキーを追加します。

front/components/welcome/welAppBar.vue
<template>
  <!-- 新たなバインドキーを追加 -->
  <v-app-bar
    app
    :dark="!isScrollPoint"
    :height="appBarHeight"
    :color="toolbarStyle.color"
    :elevation="toolbarStyle.elevation"
  >
    ...
  </v-app-bar>
</template>

<script>
export default {
  ...
  computed: {
    ...
    // 追加
    toolbarStyle () {
      const color = this.isScrollPoint ? 'white' : 'transparent'
      const elevation = this.isScrollPoint ? 4 : 0
      return { color, elevation }
    }
  },
  mounted () {
  ...
</script>
  • v-app-barのバインドキー

    • dark … ダークモードにする。

      スクロールポイントによってツールバー上の文字色を白か黒に切り替えています。

    • height … ツールバーの高さ指定。

    • color … ツールバーの色を指定。

    • elevation(エレベーション) … ツールバーの影の濃さ。0(影無し) ~ 24の値を指定可能。

      スクロールポイントによって0か4に切り替えています。

編集が終わったらブラウザで確認してみましょう。

ツールバーの色と影、文字色が変化します。

メニューボタンにスクロールメソッドを追加する

メニューボタンの実装に入ります。

クリックイベントを追加する

クリックすると下記の場所へスクロールするイベントを追加します。

  • 各メニューボタンは、指定の場所へ
  • アプリのロゴをクリックしたらページトップへ

welAppBar.vuegoTo()メソッドを追加し、HTMLには@clickイベントを追加します。

front/components/welcome/welAppBar.vue
<template>
  <v-app-bar
    app
    :dark="!isScrollPoint"
    :height="appBarHeight"
    :color="toolbarStyle.color"
    :elevation="toolbarStyle.elevation"
  >
    <!-- @click.native 追加 -->
    <app-logo 
      @click.native="goTo('scroll-top')"
    />

    ...

    <v-toolbar-items class="ml-2">
      <!-- @click 追加 -->
      <v-btn
        v-for="(menu, i) in menus"
        :key="`menu-btn-${i}`"
        text
        @click="goTo(menu.title)"
      >
        {{ $t(`menus.${menu.title}`) }}
      </v-btn>
    </v-toolbar-items>
  </v-app-bar>
</template>

<script>
export default {
  ...
  methods: {
    ...
    // 追加
    goTo (id) {
      this.$vuetify.goTo(`#${id}`)
    }
  }
}
</script>
  • @click.native(ネィティブ) … 子コンポーネントへクリックイベントを追加する場合は、native拡張子が必要。
  • this.$vuetify.goTo('ID') … 引数に指定したID要素までスクロールするVuetifyのメソッド。

スクロールポイントにIDを追加する

まだID要素を用意していないので、今のままクリックしてもエラーになります。

各メニューコンテンツを置いているwelcome.vueに移動し、v-imgv-colにIDを追加します。

front/layouts/welcome.vue
<template>
    ...
    <!-- id="scroll-top" 追加 -->
    <v-img
      id="scroll-top"
      dark
      src="https://picsum.photos/id/20/1920/1080?blur=5"
      gradient="to top right, rgba(19,84,122,.6), rgba(128,208,199,.9)"
      :height="imgHeight"
    >
      ...
        <v-row
          v-for="(menu, i) in menus"
          :key="`menu-${i}`"
        >
          <!-- :id="menu.title" 追加 -->
          <v-col
            :id="menu.title"
            cols="12"
          >
            <v-card flat>
             ...

(まだの方は)コンテナを起動してブラウザで確認してみましょう。

root $ docker-compose up

ボタンをクリックして所定の位置までスクロールすれば実装完了です。

コミットしとく

今回の作業はここまで。

ここまでの変更をコミットしておきましょう。

root $ cd front
front $ git commit -am "toolbar_add_scroll_event"
frong $ cd ..
root $ # 戻っておく

まとめ

今回は、ツールバーにスクロールを検知するイベントを追加し、メニューボタンへクリックイベントを追加しました。

今回作成したスクロールを検知するイベントはVue.js単体でも実装可能です。

「トップに戻る」ボタンも今回のテクニックが使用されています。

ぜひ今回の実装を参考に挑戦してみてください🤠

さて、次回は

次回はツールバーにログイン画面と会員登録画面に遷移するリンクボタンを設置し、フッターなどのレイアウトを完成させます。

次回でウェルカムページは完成でーす!(あと少し↓)

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】アプリケーション仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. ログイン前のレイアウト構築 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. ログイン前のレイアウト構築 #02
Nuxt.js ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
10. ログイン前のレイアウト構築 #03
Nuxt.js ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
10. ログイン前のレイアウト構築 #04
Nuxt.js addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
10. ログイン前のレイアウト構築 #05
Nuxt.js ウェルカムページをレスポンシブデザインに対応させよう(4/4)
10. ログイン前のレイアウト構築 #06
Nuxt.js 会員登録ページのレイアウトファイルを作成しよう(1/4)
10. ログイン前のレイアウト構築 #07
Nuxt.js 名前、メール、パスワードのコンポーネントファイルを作成しよう(2/4)
10. ログイン前のレイアウト構築 #08
Nuxt.js 親子コンポーネント間の双方向データバインディングを実装する(3/4)
10. ログイン前のレイアウト構築 #09
Nuxt.js Vuetifyのv-text-fieldを使った会員登録フォームのバリデーション設定(4/4)
10. ログイン前のレイアウト構築 #10
Nuxt.js ログインページ実装とHerokuデプロイまで(router. replaceとpushの違いとは)
11. ログイン後のレイアウト構築 #01
Nuxt.js ログイン後のツールバーを作成しよう(inject解説)
11. ログイン後のレイアウト構築 #02
Nuxt.js アカウントメニューページ・ログアウト機能を実装しよう(nuxt-child解説)
11. ログイン後のレイアウト構築 #03
Nuxt.js ログイン後のトップページにプロジェクト一覧を表示しよう
11. ログイン後のレイアウト構築 #04
Nuxt.js プロジェクトページにVuetifyのナビゲーションドロワーを追加しよう
11. ログイン後のレイアウト構築 #05
Nuxt.js paramsIDからプロジェクトを検索してVuexに保存しよう
SPA開発
ブログ構築
小ネタ集