Udemy 10. ログイン前のレイアウト構築 #01
2021年03月13日に更新

Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう

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

チャプター「ログイン前のレイアウト構築」では、3つのページのレイアウトを完成させます。

状態 ページの内容 パス ファイル
1 ログイン前 ウェルカムページ / index.vue
2 “” 新規会員登録ページ /signup signup.vue
3 “” ログインページ /login login.vue

layouts

今回達成すること

Nuxt.jsで効率の良いレイアウトを行うには、レイアウト・ページ・コンポーネントファイルについて理解する必要があります。

今回はそれぞれのファイルの役割、その使い方について解説します。

実装に入る前に、Nuxt.jsのレイアウトの知識を深めましょう。

ページを構成する3つのファイル

Nuxt.jsのページは基本的に3つのファイル構成で成り立っています。

  1. レイアウトファイル(赤)
  2. ページファイル(黄)
  3. コンポーネントファイル(緑)

それぞれの関係性はこのようになります。

  • レイアウト > ページ > コンポーネント

2020-07-29 17-13-21

1. レイアウトファイルの役割

レイアウトファイルにはページの外観を構成するパーツを配置します。

どのページにも表示されるヘッダーやフッター、サイドバーなどを配置することでHTMLの2度書きを防ぎます。

このファイルは「layouts」ディレクトリ以下で管理します。

ページファイルの呼び出し

レイアウトファイルから各ページファイルを呼び出すには<nuxt /> タグを使用します。

<nuxt /> タグは、現在のパスと一致するページファイルを呼び出します。

layouts/default.vue
<template>
  <div>
    <nuxt /> <!-- パスと一致するページファイルが呼び出しされる -->
  </div>
</template>

2. ページファイルの役割

ページファイルにはページごとに表示するHTMLを記述します。

このファイルは「pages」ディレクトリ以下で管理します。

ページによってレイアウトを変更する

ページ単位でレイアウトファイルを変更することができます。

layoutプロパティ内でファイル名と一致する文字列を指定します。

export default {
  // layouts/welcome.vueファイルが呼ばれる
  layout () {
    return 'welcome'
  }
}

また、下記のように省略して書くこともできます。

2021年3月13日 スペルミスを修正しました。

export default {
  layout: 'welcome'
}

ファイル名によって生成されるパス

Nuxt.jsはファイル名によって自動的にパスを生成します。

pagesファイル 生成されるパス
Index.vue /
login.vue /login
account/settings.vue /account/settings

3. コンポーネントファイルの役割

コンポーネントファイルには、ページ内で使用するテキストフォームやボタンのHTMLを記述します。

一言で言えば小さな部品です。

レイアウトファイルもページファイルも、このコンポーネントファイルが集まって構成されています。

asyncDataは使用できない

コンポーネントファイル内では、ページが描画される前にデータを取得する「asyncData」が使用できません。

「asyncData」内で取得するデータが必要な場合は、ページファイルで取得したデータをコンポーネントファイルに渡すことで実現します。

コンポーネントファイルをどこまで小さくするか争論

小さくするメリット

例えば下記のようなコンポーネントファイルを作成した場合。

components/myH1.vue
<template>
  <h1 class="my-h1">
    <slot name="title" />
  </h1>
</template>

<style lang="css" scoped>
  .my-h1 {
    font-size: 24px;
  }
</style>

コンポーネントを小さくすればするほど使い勝手が良く、どのページにも使用することができます。

多くのページに使用出来るということは「タイトルやっぱフォント18pxで!」と後から変更があった場合に、このコンポーネントを使用する全てのページを変更することができます。

小さくするデメリット

一方、あまりに小さくすると

  • ファイルが膨大な数になって保守性が下がる
  • JavaScriptが複雑になる

といったデメリットがあります。

Vue.jsのコンポーネント間でのデータのやり取りは、propsemitを使って行うため、1つのデータをやり取りするのに何行ものJavaScriptを書く必要があります。

それにフォントサイズの変更などは共通のCSSクラスを作成すれば対応可能です。

そもそもコンポーネントファイルが必要か?疑問が残ります。

結論

コンポーネントファイルは小さくし過ぎず、1コンポーネント = 1役割で切り分けることをおすすめします。

例えばダッシュボードの場合、5つのコンポーネントファイルを使用しています。

  1. ツールバー(黄)

  2. ナビゲーション(赤)

  3. ヘッダー(黄 + 赤)

    ツールバー + ナビゲーションを置いたコンポーネントファイル。

    ナビゲーションの開閉にツールバーのボタンを使用するため共通のデータを保有している。

  4. バンくずリスト(緑)

  5. ページコンテンツ(青)

2020-07-29 22-01-31

その他、

  • 2つ以上のページで使用するUIの場合
  • 1ページあたりのコード数が多くなる場合

に該当した場合もコンポーネントファイルの切り分けを検討すべきです。

認証アプリのレイアウトファイル設計

認証アプリでは、ログイン前・ログイン後のレイアウトが大きく変わります。

そのため、レイアウトファイルを切り替えてページデザインを行った方が効率の良い開発ができます。

Nuxt.jsのデフォルトのレイアウトファイル

Nuxt.jsは、レイアウトファイルを指定しない限りdefault.vueを使用します。

default.vueは、より多くのページを生成するログイン後のレイアウトとして使用した方が、JavaScriptのコードが減り、記述漏れのミスを回避するメリットがあります。

今回のレイアウトファイルは5つ

2020年8月24日追記

ログアウトページのレイアウトを追加しました。

今回のアプリでは5つのレイアウトファイルを使用します。

内容 状態 layouts
ウェルカムページ ログイン前 welcome.vue
会員登録・ログインページ ログイン前 beforeLogin.vue
プロジェクト一覧ページ ログイン後 loggedIn.vue
ダッシュボード ログイン後 default.vue
ログアウト ログイン前 logout.vue

1. ウェルカムページ => welcome.vue

ログイン前のトップページで使用します。

このレイアウトファイルはウェルカムページでしか使用しないため、レイアウトファイル内でページを完成させます。

2. 会員登録・ログインページ => beforeLogin.vue

ログイン前のページを構成するレイアウトファイルになります。

会員登録やログイン以外にもドキュメントやプライバシーポリシーなどに使用します。

3. プロジェクト一覧ページ => loggedIn.vue

プロジェクトの選択画面です。

ユーザーは複数のプロジェクトを持てることを前提としています。

4. ダッシュボード => default.vue

プロジェクト選択後の画面です。

5. ログアウトページ => logout.vue

ログアウト時に表示される空白のレイアウトです。

まとめ

今回はページを構成する3つのファイル

  • レイアウト
  • ページ
  • コンポーネント

の解説を行いました。


ここに書いた知識は、筆者がNuxt.jsを作って壊してを繰り返した結果辿り着いた答えです。

まずはページファイルに書いてみて「これ切り分けた方がええな〜」て感じる部分はどんどんコンポーネント化していきましょう。

筆者は今でもそんなやり方です。

次回は?

次回より実装に入ります。

まずはウェルカムページの構築から!

お楽しみあれ(↓のリストGO)

修正情報

  • 2021年03月13日

    スペルミスを修正しました。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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に保存しよう
12. サーバーサイドのログイン認証 #01
JWTとは何か?(ruby-jwtのインストール)
12. サーバーサイドのログイン認証 #02
【Rails×JWT】ログイン認証解説とJWT初期設定ファイルの作成
12. サーバーサイドのログイン認証 #03
【Rails×JWT】トークン発行とデコードを行うAuthTokenクラスの作成
12. サーバーサイドのログイン認証 #04
【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成
12. サーバーサイドのログイン認証 #05
【Rails×JWT】UserクラスからJWTを扱うTokenizableモジュールの作成
12. サーバーサイドのログイン認証 #06
【Rails×JWT】AuthTokenクラスとAuthenticatorモジュールをテストする
12. サーバーサイドのログイン認証 #07
【Rails×JWT】JWTをCookieに保存するログインコントローラーの実装
12. サーバーサイドのログイン認証 #08
【Rails×JWT】ログインコントローラーのテストとHerokuデプロイ
13. フロントエンドのログイン認証 #01
【Rails×Nuxt.js】クロスオリジン通信でのCookie共有設定
13. フロントエンドのログイン認証 #02
【Nuxt.js】Railsからのログイン成功レスポンスをVuexに保存する
13. フロントエンドのログイン認証 #03
【Nuxt.js】ローカルストレージの有効期限を暗号化する(crypto-js解説)
13. フロントエンドのログイン認証 #04
【Nuxt.js】JWT有効期限内のユーザーをログインしたままにする実装
13. フロントエンドのログイン認証 #05
【Nuxt.js】ログイン前後のリダイレクト処理をミドルウェアで実装する
13. フロントエンドのログイン認証 #06
【Nuxt.js】ログイン失敗時のトースターをグローバルイベントとして作成する
13. フロントエンドのログイン認証 #07
【Nuxt.js】エラーページを作成する
13. フロントエンドのログイン認証 #08
【Rails×Nuxt.js】デモプロジェクトの作成とHerokuデプロイ(ログイン認証完)
14. 本番環境への対応 #01
【Rails×Nuxt.js】SafariのクロスサイトCookie保存拒否に対応する
SPA開発
ブログ構築
小ネタ集