Udemy 10. ログイン前のレイアウト構築 #09
2020年08月16日に公開

Nuxt.js Vuetifyのv-text-fieldを使った会員登録フォームのバリデーション設定(4/4)

会員登録ページは全4回に渡って構築します。

1/4 レイアウトファイルの作成

2/4 名前、メールアドレス、パスワードコンポーネントの作成

3/4 親子コンポーネント間のデータ通信設定

4/4 Vuetityのv-text-fieldを使ったバリデーション設定(今ここ)

今回達成すること

Vuetifyを使い、各フォームにバリデーションを設定します。

今回の完成イメージ

2020-08-15 18-41-00

この回で会員登録ページが完成しますよー!

途中でつまづいた方

このページ下、#最終的なコード を置いていますので、コピペして次へ進んでください。

nameのバリデーションを追加する

名前の入力フォームには、

  • 入力必須
  • 30文字まで

2つのバリデーションを設定します。

Vuetifyの<v-text-field>にバリデーションを設定するには、rulesキーに配列を渡します。

front/components/user/userFormName.vue
<template>
  <!-- rulesキー 追加 -->
  <v-text-field
    v-model="setName"
    :rules="rules"
    label="ユーザー名を入力"
    placeholder="あなたの表示名"
    outlined
  />
</template>

<script>
export default {
  ...
  // data () 追加
  data () {
    const max = 30
    return {
      max,
      rules: [
        v => !!v || '',
        v => (!!v && max >= v.length) || `${max}文字以内で入力してください`
      ]
    }
  },
  // ここまで
  computed: {
  ...
</script>
  • rules: [] … バリデーションを格納した配列。

    1つ目は入力必須、2つ目は文字数制限となります。

  • v => !!v || ''vはvalueの略で、ユーザーが入力した値が入ります。

    バリデーションの書き方はこんな感じで分解できます。

    • !!v … バリデーション成功条件(valueが存在する)
    • || … そうでない場合
    • '' … バリデーションのエラーメッセージ

    ユーザーのストレスになるため、入力必須のバリデーションにはエラーメッセージ無しとしています。

  • v => (!!v && max >= v.length) || '${max}文字以内で入力してください'

    例えば上記の場合は、

    • !!v … valueが存在する、
    • && … かつ
    • max >= v.length … 文字数が30文字以下
    • || … でない場合、
    • 「30文字以内で入力してください」とメッセージを出す

    という内容です。

文字カウンターを追加する

文字数要件がある場合は、「今何文字なのか、何文字まで入力できるのか」をユーザーに明記してあげると親切です。

これは、Vuetifyのcounterキーに最大許容文字数を渡すことで実現します。

front/components/user/userFormName.vue
<template>
  <!-- counterキー 追加 -->
  <v-text-field
    ...
    :counter="max"
    label="ユーザー名を入力"
    placeholder="あなたの表示名"
    outlined
  />
</template>
...

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

名前を入力すると、カウントとエラーメッセージが表示されるようになりました。

2020-08-15 14-30-51

nameのバリデーションはこれにて完了です。

emailのバリデーションを追加する

メールアドレスのバリデーションは、

  • 入力必須
  • メールの書式チェック

を行います。

front/components/user/userFormEmail.vue
<template>
  <!-- rulesキー 追加 -->
  <v-text-field
    v-model="setEmail"
    :rules="rules"
    label="メールアドレスを入力"
    placeholder="your@email.com"
    outlined
  />
</template>

<script>
export default {
  ...
  // data () 追加
  data () {
    return {
      rules: [
        v => !!v || '',
        v => /.+@.+\..+/.test(v) || ''
      ]
    }
  },
  // ここまで
  computed: {
    ...
</script>
  • v => /.+@.+\..+/.test(v) || '' … 正規表現でのメールアドレス書式チェック。

    JavaScriptのtest()メソッドを使い、正しければtrueを返します。

    この正規表現は、「@.が含まれているか」の簡易チェックとなります。

(コラム)書式チェックにエラーメッセージを表示させない理由

フロントサイドのバリデーションは、リアルタイムで行うためどうしてもユーザーが入力中にエラーメッセージが表示されます

書式チェックの場合、「@.」が入力されるまでエラーメッセージが表示されます。

2020-08-15 15-23-17

筆者的には、「今入力しとるちゅうねん!!」と叫んでしまうほど不快に感じます。

こんなUI設計は極力辞めましょう。

ユーザーはフォームの色でエラーかどうかを十分に判断できるので、このメッセージは不要です。

あ、でもサーバーサイドから返ってくるエラーメッセージは必要ですよ。

これはユーザーが入力を完了した後に返されるエラーなので。

(コラムおわり)

このコンポーネントはログインでも使用する

このメールアドレスコンポーネントは、ログイン時にも使用します。

ログイン時にはプレースホルダーは必要ありません。

そこでnoValidationというフラグを用意し、プレースホルダーの表示・非表示を切り替えます。

front/components/user/userFormEmail.vue
<template>
  <!-- placeholder を書き換え -->
  <v-text-field
    ...
    :placeholder="form.placeholder"
    outlined
  />
</template>

<script>
export default {
  props: {
    ...
    // 追加
    noValidation: {
      type: Boolean,
      default: false
    }
  },
  ...
  computed: {
    ...
    // 追加
    form () {
      const placeholder = this.noValidation ? undefined : 'your@email.com'
      return { placeholder }
    }
  }
}
</script>

確認してみよう

試しにsignup.vue<user-form-email>に、no-validationキーを追加してみましょう。

front/pages/signup.vue
<template>
  ...
  <!-- no-validation 追加 -->
  <user-form-email
    no-validation
    :email.sync="params.user.email"
  />
  ...

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

プレースホルダーが無くなって、ログインフォームっぽくなりましたね。

2020-08-15 15-07-19

確認が取れたら、追加したno-validationは削除しておいてください。

front/pages/signup.vue
<template>
  ...
  <!-- no-validation 削除 -->
  <user-form-email
    :email.sync="params.user.email"
  />
  ...

このロジックを使えば、「ログイン時にはバリデーションをしない」という設定も可能です。

しかし今回は、Railsへ無駄なAPIを投げないようにするため、ログイン時にも「入力必須」と「書式チェック」のバリデーションは残します。

passwordのバリデーションを追加する

最後はパスワードフォームですね。

パスワードのバリデーションは、

  • 入力必須
  • 8文字以上
  • 72文字以下
  • 半角英数字、ハイフン、アンダーバーのみ使用可能

です。これらは正規表現でチェックしていきます。

ログインフォームにも対応する設定を行う

パスワードコンポーネントもログイン時に使用するので、フラグを用意し、それぞれの要素を切り替えていきます。

会員登録フォーム ログインフォーム
バリデーション 8 ~ 72文字の文字数、書式チェック 入力必須のみ
文字数カウンター 必要 不要
入力のヒント 8文字以上。半角英数字•ハイフン•アンダーバーが使えます undefined
プレースホルダー 8文字以上 undefined

userFormPassword.vueはこのように編集してください。

front/components/user/userFormPassword.vue
<template>
  <!-- まるっと書き換え -->
  <v-text-field
    v-model="setPassword"
    :rules="form.rules"
    :counter="!noValidation"
    :hint="form.hint"
    label="パスワードを入力"
    :placeholder="form.placeholder"
    :hide-details="noValidation"
    outlined
  />
</template>

<script>
export default {
  props: {
    ...
    // 追加
    noValidation: {
      type: Boolean,
      default: false
    }
  },
  computed: {
    ...
    // 追加
    form () {
      const min = '8文字以上'
      const msg = `${min}。半角英数字•ハイフン•アンダーバーが使えます`
      const required = v => !!v || ''
      const format = v => /^[\w-]{8,72}$/.test(v) || msg

      const rules = this.noValidation ? [required] : [format]
      const hint = this.noValidation ? undefined : msg
      const placeholder = this.noValidation ? undefined : min
      return { rules, hint, placeholder }
    }
  }
}
</script>

:rules

noValidation

  • true(ログイン) => 入力必須
  • false(会員登録) => 文字数、書式チェック

:counter

入力文字数をカウントします。

noValidation

  • true(ログイン) => カウントしない
  • false(会員登録) => カウントする

:hint

フォームにフォーカスされた時に入力のヒントを表示します。

noValidation

  • true(ログイン) => undefined
  • false(会員登録) => ‘8文字以上。半角英数字•ハイフン•アンダーバーが使えます’

:hide-details(ハイド-ディティルズ)

フォーム下に表示されるメッセージの余白が無くなります。

noValidation

  • true(ログイン) => 隠す
  • false(会員登録) => 隠さない

ヒントやエラーメッセージがあっても、このキーがtrueの場合はメッセージが隠されます。

ログインフォームの場合、表示するエラーメッセージが無いのでtrueとします。

hide-detailsがtrueの場合、余白が無くなる

2020-08-15 18-23-39

passwordの表示・非表示ボタンの設定

Vuetifyを使えばパスワードの表示・非表示が簡単に切り替えられます。

<v-text-field>に新しいキーを追加しましょう。

front/components/user/userFormPassword.vue
<template>
  <!-- 追加 -->
  <v-text-field
    ...
    :append-icon="toggle.icon"
    :type="toggle.type"
    outlined
    autocomplete="on"
    @click:append="show = !show"
  />
</template>

<script>
export default {
  ...
  // 追加
  data () {
    return {
      show: false
    }
  },
  computed: {
    ...
    // 追加
    toggle () {
      const icon = this.show ? 'mdi-eye' : 'mdi-eye-off'
      const type = this.show ? 'text' : 'password'
      return { icon, type }
    }
  }
}
</script>

:append-icon

フォームの隣に表示するアイコンを指定します。

:type

フォームタイプを指定します。

autocomplete=“on”

フォームタイプがパスワードの場合、このキーを追加しないとGoogleが警告を出します。恐らくGoogleのパスワード予測機能を使うために必要なキーだと思います。

@click:append

append-iconがクリックされた時のイベントを指定します。

これでパスワードフォームが完成しました。

2020-08-15 18-39-24

登録ボタンのクリックイベントを追加する

最後の作業です。

signup.vueの「登録する」ボタンにクリックイベントを追加しましょう。

今はまだRailsに送信できないので、仮イベントとなります。

   ...
    <!-- ref 追加 -->
    <v-form
      ref="form"
      v-model="isValid"
    >
      ...
      <!-- :disabled, :loading, @click 追加 -->
      <v-btn
        :disabled="!isValid || loading"
        :loading="loading"
        block
        color="myblue"
        class="white--text"
        @click="signup"
      >
        登録する
      </v-btn>
      ...
</template>

<script>
export default {
  layout: 'beforeLogin',
  data () {
    return {
      ...
      // loading 追加
      loading: false,
      params: { user: { name: '', email: '', password: '' } }
    }
  },
  // 追加
  methods: {
    signup () {
      this.loading = true
      setTimeout(() => {
        this.formReset()
        this.loading = false
      }, 1500)
    },
    formReset () {
      this.$refs.form.reset()
      this.params = { user: { name: '', email: '', password: '' } }
    }
  }
  // ここまで
}
</script>
  • :loading … 送信時にボタンがくるくるする。
  • this.$refs.form.reset() … Vuetifyのメソッド。

    <v-form ref="form"> タグ内のフォームの、全ての入力を削除し、かつバリデーションエラーも削除します。

    ちなみに、ref="form"$refs.formの「form」の部分は、一致していないとVuetifyが正しく認識してくれませんのでご注意ください。

    参考 Validation with submit & clear - Vuetify

ボタンイベントの確認

ボタンイベントを確認してみましょう。

  • バリデーションエラー時
  • データ送信中

はクリックできなくなっています。

そして、バリデーション成功時にだけボタンが有効になっていますね。

2020-08-16 09-56-38

コミットしとく

今回の作業は以上です。

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

root $ cd front && git commit -am "finishe_signup_page" && cd ..

まとめ

今回は、会員登録の各フォームに、Vuetifyを使ったバリデーション設定を行いました。

これにて会員登録ページの完成です。

お疲れっした!

次回は?

ログインページの構築です。

もう今回で段取り作業は終わっていますので、次は簡単ですよ。

どうぞお楽しみに。

最終的なコード

会員登録ページ

front/pages/signup.vue
<template>
  <bef-login-form-card #form-card-content>
    <v-form
      ref="form"
      v-model="isValid"
    >
      <user-form-name
        :name.sync="params.user.name"
      />
      <user-form-email
        :email.sync="params.user.email"
      />
      <user-form-password
        :password.sync="params.user.password"
      />
      <v-btn
        :disabled="!isValid || loading"
        :loading="loading"
        block
        color="myblue"
        class="white--text"
        @click="signup"
      >
        登録する
      </v-btn>
    </v-form>

    <v-card-text>
      {{ params }}
    </v-card-text>
  </bef-login-form-card>
</template>

<script>
export default {
  layout: 'beforeLogin',
  data () {
    return {
      isValid: false,
      loading: false,
      params: { user: { name: '', email: '', password: '' } }
    }
  },
  methods: {
    signup () {
      this.loading = true
      setTimeout(() => {
        this.formReset()
        this.loading = false
      }, 1500)
    },
    formReset () {
      this.$refs.form.reset()
      this.params = { user: { name: '', email: '', password: '' } }
    }
  }
}
</script>

nameコンポーネント

front/components/user/userFormName.vue
<template>
  <v-text-field
    v-model="setName"
    :rules="rules"
    :counter="max"
    label="ユーザー名を入力"
    placeholder="あなたの表示名"
    outlined
  />
</template>

<script>
export default {
  props: {
    name: {
      type: String,
      default: ''
    }
  },
  data () {
    const max = 30
    return {
      max,
      rules: [
        v => !!v || '',
        v => (!!v && max >= v.length) || `${max}文字以内で入力してください`
      ]
    }
  },
  computed: {
    setName: {
      get () { return this.name },
      set (newVal) { return this.$emit('update:name', newVal) }
    }
  }
}
</script>

emailコンポーネント

front/components/user/userFormEmail.vue
<template>
  <v-text-field
    v-model="setEmail"
    :rules="rules"
    label="メールアドレスを入力"
    :placeholder="form.placeholder"
    outlined
  />
</template>

<script>
export default {
  props: {
    email: {
      type: String,
      default: ''
    },
    noValidation: {
      type: Boolean,
      default: false
    }
  },
  data () {
    return {
      rules: [
        v => !!v || '',
        v => /.+@.+\..+/.test(v) || ''
      ]
    }
  },
  computed: {
    setEmail: {
      get () { return this.email },
      set (newVal) { return this.$emit('update:email', newVal) }
    },
    form () {
      const placeholder = this.noValidation ? undefined : 'your@email.com'
      return { placeholder }
    }
  }
}
</script>

passwordコンポーネント

front/components/user/userFormPassword.vue
<template>
  <v-text-field
    v-model="setPassword"
    :rules="form.rules"
    :counter="!noValidation"
    :hint="form.hint"
    label="パスワードを入力"
    :placeholder="form.placeholder"
    :hide-details="noValidation"
    :append-icon="toggle.icon"
    :type="toggle.type"
    outlined
    autocomplete="on"
    @click:append="show = !show"
  />
</template>

<script>
export default {
  props: {
    password: {
      type: String,
      default: ''
    },
    noValidation: {
      type: Boolean,
      default: false
    }
  },
  data () {
    return {
      show: false
    }
  },
  computed: {
    setPassword: {
      get () { return this.password },
      set (newVal) { return this.$emit('update:password', newVal) }
    },
    form () {
      const min = '8文字以上'
      const msg = `${min}。半角英数字•ハイフン•アンダーバーが使えます`
      const required = v => !!v || ''
      const format = v => /^[\w-]{8,72}$/.test(v) || msg

      const rules = this.noValidation ? [required] : [format]
      const hint = this.noValidation ? undefined : msg
      const placeholder = this.noValidation ? undefined : min
      return { rules, hint, placeholder }
    },
    toggle () {
      const icon = this.show ? 'mdi-eye' : 'mdi-eye-off'
      const type = this.show ? 'text' : 'password'
      return { icon, type }
    }
  }
}
</script>
あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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開発
ブログ構築
小ネタ集