Udemy 9. Nuxt.jsフロント開発事前準備 #03
2020年07月22日に公開

VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る

今回達成すること

今回は2つのCSS設定を行います。

  • 前回インストールしたVuetifyにカスタムCSSを導入
  • Nuxt.jsが読み込むメインCSSファイルの設定

Vuetifyのブレイクポイント

Vuetifyのデフォルトで用意されているブレイクポイントは5つあります。

CSSクラス ブレイクポイント
xs 600px未満
sm 600 ~ 960px未満
md 960 ~ 1264px未満
lg 1264 ~ 1904px未満
xl 1904以上

今回はカスタムCSSを使って、さらにipadとモバイルを判定する2つのブレイクポイントを追加します。

CSSクラス ブレイクポイント
ipad 768px
mobile 426px

ブレイクポイントを追加することで、ipadとモバイルで表示・非表示を切り替えるCSSクラスが使えるようになります。

完成イメージ

2020-07-21 21-19-39

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

2つのCSSファイルを作成する

  1. Vuetifyが参照するカスタムCSSファイルvariables.scssと、

  2. Nuxt.jsが参照するメインCSSファイルmain.scssを作成します。

「assets」ディレクトリに「sass」を作成し、その直下に2つのファイル置きます。

root $ mkdir front/assets/sass && touch $_/{variables.scss,main.scss}

VuetifyのカスタムCSSの導入方法

カスタムCSSの導入は簡単です。

nuxt.config.jsvuetifyプロパティに、カスタムCSSのオプションを追加するだけです。

front/nuxt.config.js
...
vuetify: {
  // 追加
  // 開発環境でcustomVariablesを有効にするフラグ
  // Doc: https://vuetifyjs.com/ja/customization/a-la-carte/
  treeShake: true,
  customVariables: ['~/assets/sass/variables.scss'],
  // ここまで
  theme: {
    themes: {
      light: {
        primary: '4080BE',
        info: '4FC1E9',
        success: '44D69E',
        warning: 'FEB65E',
        error: 'FB8678',
        background: 'f6f6f4'
      }
    }
  }
},
  • treeShake: <Boolean>(ツリーシェイク) … Vuetifyコンポーネントを使用する場所で自動的にインポートするvuetify-loaderの機能。

    ビルド時間を大幅に短縮する効果があります。

    デフォルトでは本番環境でのみ有効ですが、開発環境でもカスタムCSSを有効にするためにtrueを指定します。

    参考 A-la-carte (treeshaking)

  • customVariables: ['cssパス'](カスタム ヴァリアブルス) … Vuetifyに追加するカスタムCSSのファイルパスを指定する。

    このプロパティはtreeShake: trueの場合にのみ機能します。

    参考 vuetify-module - GitHub

カスタムCSSファイルの編集

今回変更する点は以下の3つです。

  • lightテーマのバックグラウンドカラーをホワイトからグレーに変更
  • 独自のブレイクポイントを追加
  • ブレイクポイントで表示・非表示を切り替えるCSSクラスの追加

作成したvariables.scssを編集しましょう。

front/assets/scss/variables.scss
// custom変数 => https://vuetifyjs.com/en/customization/sass-variables/#sass-variables
$material-light: (
  'background': #f6f6f4
);

$grid-breakpoints: (
  'ipad': 768px,
  'mobile': 426px
);

$display-breakpoints: (
  'ipad-and-down':
  'only screen and (max-width: #{map-get($grid-breakpoints, 'ipad') - 1})',
  'ipad-and-up':
  'only screen and (min-width: #{map-get($grid-breakpoints, 'ipad')})',
  'mobile-and-down':
  'only screen and (max-width: #{map-get($grid-breakpoints, 'mobile') - 1})',
  'mobile-and-up':
  'only screen and (min-width: #{map-get($grid-breakpoints, 'mobile')})'
);
  • $material-light … Vuetifyのテーマlightのバックグラウンドカラーを変更。

  • $grid-breakpointsipad(768px)mbuile(426px)のブレイクポイントを追加。

  • $display-breakpoints … ブレイクポイントで表示・非表示を切り替えるCSSクラスを作成。

    これにより4つのブレイクポイントクラスが追加されました。

    1. ipad-and-down
    2. ipad-and-up
    3. mobile-and-down
    4. mobile-and-up

Nuxt.js v2.13以降@import '~vuetify/src/styles/styles.sass';の記載は必要ありません。

index.vueにオリジナルクラスを追加

カスタムCSSの設定の確認をしましょう。

index.vueにブレイクポイントで色が変化するBOXを追加します。

front/pages/index.vue
<template>
  <v-container fluid>
    <v-card
      flat
      tile
      color="transparent"
    >
      ...
      <!-- 追加 -->
      <v-card-title>
        VuetifyカスタムCSSの検証
      </v-card-title>
      <v-card-text>
        ipad(768px)とmobile(426px)で表示・非表示
      </v-card-text>
      <v-card-text>
        <v-card
          v-for="(cls, i) in customClass"
          :key="`cls-${i}`"
          :color="cls.color"
          :class="cls.name"
        >
          <v-card-text>
            {{ cls.des }}
          </v-card-text>
        </v-card>
      </v-card-text>
      <!-- ここまで -->
    </v-card>
  </v-container>
</template>

<script>
export default {
 ...
  data () {
    return {
      colors: ['primary', 'info', 'success', 'warning', 'error', 'background'],
      // 追加
      customClass: [
        { name: 'hidden-ipad-and-down', color: 'error', des: 'ipad未満で隠す' },
        { name: 'hidden-ipad-and-up', color: 'info', des: 'ipad以上で隠す' },
        { name: 'hidden-mobile-and-down', color: 'success', des: 'mobile未満で隠す' },
        { name: 'hidden-mobile-and-up', color: 'warning', des: 'mobile以上で隠す' }
      ]
    }
  },
 ...
}
</script>

それではコンテナを起動して、http://localhost:8080/ にアクセスしましょう。

root $ docker-compose up

バックグラウンドカラーの変更と、ブレイクポイントで正常に表示が切り替わっているかを確認してください。

2020-07-21 21-19-39

Nuxt.js起動時に大量のエラーが出た場合

コンテナ起動時に下記のようなエラーが出た場合。

ERROR  ## There is an issue with node-fibers ##
`/app/node_modules/fibers/bin/linux-x64-83-musl/fibers.node` is missing.
Try running this to fix the issue: /usr/local/bin/node /app/node_modules/fibers/build
ERROR  Error: Cannot find module '/app/node_modules/fibers/bin/linux-x64-83-musl/fibers'
Require stack:
- /app/node_modules/fibers/fibers.js
- /app/node_modules/sass-loader/dist/getSassOptions.js
- /app/node_modules/sass-loader/dist/index.js
- /app/node_modules/sass-loader/dist/cjs.js
...

エラーの原因

これはvuetify-loaderが正常に動いていないためコンポーネントが読み込めないよ!というエラーです。

treeShakeを有効にした際にvuetify-loaderが稼働するためこのエラーが発生します。

筆者の場合、Nuxt.jsにデフォルトで入っているfibersモジュールが正常にインストールされていないことが原因でした。

エラー対応

fibersを再インストールすることでエラーは直ります。

再インストールには$ yarn upgradeコマンドを使用します。

root $ docker-compose run --rm front yarn upgrade fibers

参考 Meteor bundle fails because fibers.node is missing - StackOverflow

Nuxt.jsメインCSSの設定

次はNuxt.jsが読み込むプロジェクトのメインCSSファイル、main.scssを編集します。

英語の文字列がはみ出さないようにするCSSをbodyに追加しましょう。

front/assets/sass/main.scss
// commons ///////////////////////////////
body {
  word-wrap: break-word;
  overflow-wrap: break-word;
}
// commons end ///////////////////////////

このファイルをNuxt.jsが読み込むよう設定します。

nuxt.config.jsに上記のファイルパスを追加します。

front/nuxt.config.js
...
css: [
  '~/assets/sass/main.scss' // 追加
],

以上でメインCSSの設定ができました。

Herokuにpush

以上で、2つのCSS設定を終わります。

ここまでの変更をHerokuにpushして本番環境での稼働も確かめましょう。

root $ cd front
front $ git add -A
front $ git commit -m "add_vuetify_custom_css"
front $ git checkout master
front $ git merge 20200719_add_vuetify <自分のブランチ名>
front $ git push
front $ git push heroku

「root」ディレクトリもpushしておきましょう。

front $ cd ..
root $ git commit -am "finished_front_add_vuetify"
root $ git push

ブラウザを開いて開発環境と同じ表示が出れば成功です。

root $ heroku open

くるくるのままの場合

最初のロードが長引くのは、RailsをデプロイしたHerokuの起動に時間がかかっているためです。

RailsをデプロイしたURLにアクセスしてRailsを目覚めさせましょう。

https://<Rails側のHerokuアプリ名>.herokuapp.com/api/v1/users

まとめ

今回は、VuetifyへカスタムCSSの導入とNuxt.jsにメインCSSの設定を行いました。

これでフロント側のCSS設定は完璧です。

VuetifyのカスタムCSSは、その他にもいろんな変数を設定できるので自分だけのオリジナルスタイルを作ってみてください。(暇なときにでも)

// src/sass/variables.scss

// Globals
$body-font-family: 'Work Sans', serif;
$border-radius-root: 6px;
$font-size-root: 14px;

// Variables must come before the import
$btn-letter-spacing: 0;
$btn-font-weight: 400;
$list-item-title-font-size: 0.929rem;
$list-item-dense-title-font-size: 0.929rem;
$list-item-dense-title-font-weight: initial;
$fab-icon-sizes: (
  'small': 20
);
$btn-sizes: (
  'default': 41,
  'large': 54
);

$headings: (
  'h1': (
    'size': 3.3125rem,
    'line-height': 1.15em
  ),
  'h2': (
    'size': 2.25rem,
    'line-height': 1.5em
  )
);

参考 SASS variables - Vuetify

次回は?

Nuxt.jsの翻訳モジュールnuxt-i18nを導入します。

このモジュールを導入することで配列の値やパスを日本語変換できるので、スッキリとしたコードを書くことができます。

下↓に記事が用意されています。お進みください。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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
ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
新着
10. 認証アプリのレイアウト設計 #03
ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
新着
10. 認証アプリのレイアウト設計 #04
addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
新着
10. 認証アプリのレイアウト設計 #05
ウェルカムページをレスポンシブデザインに対応させよう(4/4)
新着
SPA開発
ブログ構築
小ネタ集