Udemy 11. ログイン後のレイアウト構築 #01
2020年08月24日に公開

Nuxt.js ログイン後のツールバーを作成しよう(inject解説)

このチャプターで達成すること

チャプター「ログイン後のレイアウト構築」では、ログイン後の各ページを作成します。

それと同時に、

  • inject機能を使った共通メソッドの作成
  • ページファイルの子コンポーネント化

など、Nuxt.jsの実務的な知識と実装方法を学びます。

ログイン後のレイアウトファイル設計

ログイン後に使用するレイアウトファイルは3つあります。

レイアウトファイル 使用するページ
loggedIn.vue プロジェクト一覧ページ、アカウントページ
logout.vue ログアウトページ専用
default.vue プロジェクトページ

layout loggedIn

レイアウトファイル自体は何個作成しても問題ないですが、大切な事は「プロジェクトページとその他のページを分離することです。

上記のように分離することで、構築から運用までが楽に行えます。

今後のNuxtアプリ構築の参考にしてください。

本チャプターで構築するページ

なお、本チャプターで構築するページは、

  • プロジェクト一覧ページ
  • ログアウトページ
  • プロジェクトページ

の3つです。

アカウントページは作成しますが、レイアウト構築の予定はありません。

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

今回達成すること

ログイン後のツールバーを作成します。

また、Nuxt.jsのinjectを使った共通メソッドの作成方法についても解説します。

完成イメージ

2020-08-23 17-37-28

ログイン後のレイアウトファイルを表示する

まずは、ログイン後のレイアウトファイルを表示するところまでを行いましょう。

ここで作成するレイアウトファイルは、

  • トップページと
  • アカウントメニューページ

で使用します。

レイアウトファイルを作成する

「layouts」ディレクトリにloggedIn.vueを作成します。

root $ touch front/layouts/loggedIn.vue

loggedIn.vueから、これから作成するloggedInAppBar.vueを呼び出します。

front/layouts/loggedIn.vue
<template>
  <v-app>
    <logged-in-app-bar />
    <v-main>
      <nuxt />
    </v-main>
  </v-app>
</template>

<script>
export default {
}
</script>

ツールバーコンポーネントを作成する

呼び出されたloggedInAppBar.vueファイルを作成します。

ログイン後のコンポーネントファイルは「loggedIn」ディレクトリで管理します。

「components」ディレクトリに、

  • 「loggedIn」ディレクトリと、
  • その下に「header」ディレクトリを作成し、
  • その直下にloggedInAppBar.vueを作成しましょう。
front $ mkdir -p front/components/loggedIn/header && touch $_/loggedInAppBar.vue
  • -p … 子ディレクトリも一度に作成する。

作成したloggedInAppBar.vueにVuetifyのツールバーを表示します。

front/components/loggedIn/header/loggedInAppBar.vue
<template>
  <v-app-bar
    app
    dense
    elevation="1"
    clipped-left
    color="white"
  >
    <nuxt-link
      to="/"
      class="text-decoration-none"
    >
      <app-logo />
    </nuxt-link>

    <app-title />
  </v-app-bar>
</template>

<script>
export default {
}
</script>

<app-logo />こちらで、<app-title />こちらの記事で作成しました。

ログインフラグをtrueにする

ログイン後のレイアウトを確認できるよう、index.jsに置いたログインフラグをtrueに変更しておきます。

この編集は一時的なものです。

front/store/index.js

export const state = () => ({
  // trueに変更
  loggedIn: true,
  ...
})
...

Index.vueのレイアウトを編集する

トップページのレイアウトメソッドを編集します。

現状はログイン後のレイアウトがdefaultになっているので、これをloggedInに変更します。

front/pages/index.vue
...
<script>
export default {
  layout ({ store }) {
    // loggedInに変更
    return store.state.loggedIn ? 'loggedIn' : 'welcome'
    // return store.state.loggedIn ? 'default' : 'welcome'
  }
}
</script>

確認してみよう

コンテナを起動して、http://localhost:8080/ にアクセスしてください。

トップページにloggedIn.vueのレイアウトファイルが適用されていますね。

2020-08-23 16-13-18

ツールバーにアカウントメニューを作成する

作成したツールバーに、アカウントメニューへのリンクを作成します。

<app-title />下に、Vuetifyの<v-menu>を追加します。

front/components/loggedIn/header/loggedInAppBar.vue
<template>
    ...
    <app-title />
    
    <!-- 追加 -->
    <v-spacer />

    <v-menu
      app
      offset-x
      offset-y
      max-width="200"
    >
      <template v-slot:activator="{ on }">
        <v-btn
          icon
          v-on="on"
        >
          <v-icon>
            mdi-account-circle
          </v-icon>
        </v-btn>
      </template>
      <v-list dense>
        <v-subheader>
          ログイン中のユーザー
        </v-subheader>

        <v-list-item>
          <v-list-item-content>
            <v-list-item-subtitle>
              <!-- TODO -->
              ユーザー名が表示されます
            </v-list-item-subtitle>
          </v-list-item-content>
        </v-list-item>

        <v-divider />

        <v-subheader>
          アカウント
        </v-subheader>

        <template v-for="(menu, i) in accountMenus">
          <v-divider
            v-if="menu.divider"
            :key="`menu-divider-${i}`"
          />

          <v-list-item
            :key="`menu-list-${i}`"
            :to="{ name: menu.name }"
          >
            <v-list-item-icon class="mr-2">
              <v-icon size="22" v-text="menu.icon" />
            </v-list-item-icon>
            <v-list-item-title>
              {{ menu.name }}
            </v-list-item-title>
          </v-list-item>
        </template>
      </v-list>
    </v-menu>
    <!-- ここまで -->
  </v-app-bar>
</template>

<script>
export default {
  // 追加
  data () {
    return {
      accountMenus: [
        { name: 'account-settings', icon: 'mdi-account-cog' },
        { name: 'account-password', icon: 'mdi-lock-outline' },
        { name: 'logout', icon: 'mdi-logout-variant', divider: true }
      ]
    }
  }
}
</script>

ツールバーの右端にアカウントメニューが表示されました。

2020-08-23 16-44-07

injectを使ってアプリ共通メソッドを追加する

現在のアカウントメニューは、正しく日本語化できていません。

そこでNuxt.jsのinjectの機能を使って、ルート名を日本語化するアプリ共通メソッドを作成します。

injectとは?

injectとは、オリジナルクラスをNuxt.jsに追加できる機能です。

クラス内で作成したメソッドは、Nuxtアプリのどこからでも呼び出せます。

主に、アプリ全体で使用するメソッドを管理するために使います。

プラグインファイルを作成する

injectはプラグインファイルとして作成します。

「plugins」ディレクトリ以下にmyInject.jsを作成しましょう。

root $ touch front/plugins/myInject.js

オリジナルクラスを宣言する

myInject.jsを編集します。

front/plugins/myInject.js
class MyInject {
  constructor (app) {
    this.app = app
  }
}

export default ({ app }, inject) => {
  inject('my', new MyInject(app))
}

injectの使い方

まず、injectでNuxtに追加するオリジナルクラスを宣言します。

そのクラスをinject()内で初期化します。

その時の第一引数のmyがVueファイルからの呼び出し名となります。

この場合、this.$my.メソッド名で呼び出すことができます。

Nuxt.jsのコンテキストも取得可能

コンテキストとは、asyncData()などの引数で取れるappstoreオブジェクトのことを言います。

Nuxt.jsが初めから用意しているものもあれば、モジュールの追加で使えるものもあります。

オリジナルクラスでコンテキストを使用する場合は、

  • クラスを初期化する際に引数として渡し … new MyInject(app)
  • constructor内で代入します。 … this.app = app

これにより、Nuxt.jsのappがクラス内で使用できます。

日本語化メソッドの追加

アカウントメニューを日本語化するメソッドを追加しましょう。

front/plugins/myInject.js
class MyInject {
  constructor (app) {
    this.app = app
  }

  // 追加
  // i18nページタイトル変換
  pageTitle (routeName) {
    const jsonPath = `pages.${routeName.replace(/-/g, '.')}`
    const title = this.app.i18n.t(jsonPath)
    return (typeof (title) === 'object') ? title.index : title
  }
}

export default ({ app }, inject) => {
  inject('my', new MyInject(app))
}

i18nを使用して、多階層のルート名を日本語化するメソッドです。

プラグインファイルを登録する

プラグインファイルの読み込みは、nuxt.config.jsに登録する必要があります。

pluginsプロパティに追加してください。

front/nuxt.config.js
...
plugins: [
  'plugins/axios',
  // 追加
  'plugins/myInject'
],

これでinjectを使ったアプリ共通メソッドの完成です。

アカウントメニューを日本語化する

それではloggedInAppBar.vueに戻り、injectで追加したメソッドを使いましょう。

front/components/loggedIn/header/loggedInAppBar.vue
           ...
       <v-list-item-title>
              <!-- 追加 -->
              {{ $my.pageTitle(menu.name) }}
              <!-- 削除 -->
              <!-- {{ menu.name }} -->
            </v-list-item-title>
          </v-list-item>
        </template>
      </v-list>
    </v-menu>
  </v-app-bar>
</template>

ja.jsonに日本語の設定をする

ja.jsonに変換後の日本語を用意します。

front/locales/ja.json
{
  ...
  "pages": {
    "signup": "会員登録",
    "login": "ログイン",
    // 追加
    "logout": "ログアウト",
    "account": {
      "settings": "アカウント設定",
      "password": "パスワード変更"
    }
  }
}

これでアカウントメニューが日本語化されました。

コミットする

以上で作業は終了です。

「front」ディレクトリをコミットしておきましょう。

root $ cd front
front $ git add -A
front $ git commit -m "add_loggedIn_toolbar"
front $ cd ..
root $

まとめ

今回はログイン後のツールバーを作成しました。

Nuxt.jsの共通メソッドの作成は、injectの他にもVuexのgettersを使う方法やVueのfilter機能を使う方法があります。

しかし、

  • gettersはコンテキストが参照できない、
  • filterはメソッドというか値変換用の機能

というように、共通メソッドの作成に向いていない点があります。

やはり共通メソッドの作成は、1つのクラスとして管理する「inject」がおすすめです。

次回は?

アカウントメニューページとログアウト機能を実装します。

子コンポーネントを使ったページのレイアウト方法も解説していきます。

どうぞおたのしみに。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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開発
ブログ構築
小ネタ集