react-iii-validator
TypeScript icon, indicating that this package has built-in type declarations

1.0.8 • Public • Published

インストール

# npm
npm install -D react-iii-validator

# yarn
yarn add -D react-iii-validator





基本的な使い方

  1. バリデーション対象の input / select / textarea 要素に validate クラスを付与
  2. 1で validate クラスを付与した要素に validations::xxxx の形式で実行するバリデーションを指定したクラスを付与
  3. バリデーションを通過しなかった場合にエラーメッセージを表示する要素を用意し error-tip クラスを付与
  4. バリデーション対象要素と error-tip 要素を form-group クラスを付与した要素でラップ

上記のように要素を準備したら useValidator フックを使用して react-iii-validator のインスタンスを生成し、useEffect の中などDOMツリー生成が保証されているタイミングで initialize してください。

import * as React from 'react'
import { useValidator } from 'react-iii-validator'

export const SampleComponent = () => {
	const Validator = useValidator()
	React.useEffect(() => {
		Validator.initialize()
	}, [])
	return (
		<div class='form-group'>
			<input name='email' type='text' class='validate validations::required'>
			<div class='error-tip'></div>
		</div>
		<button type='button' onClick={() => Validator.validate()}>
	)
}

export default SampleComponent

validate() メソッドでバリデーションを実行できます。

element.addEventListener('click', () => Validator.validate())





ひとつのフォームに複数のバリデーションを実行したい場合

validations:: のあとに : 区切りでバリデーション名を列挙

例)

<div class='form-group'>
    <input name='email' type='text' class='validate validations::required:email'>
    <div class='error-tip'></div>
</div>





error-tip のスタイル

バリデーション実行後エラーとなった form-group の error-tip 内にはエラーメッセージが追加されますので .error-tip に任意のスタイルを定義してください。






エラーとなった要素のスタイル

バリデーション実行後エラーとなったバリデーション対象要素には is-invalid クラスが付与されますので .is-invalid に任意のスタイルを定義するか、 react-iii-validator のインスタンス生成時に次のように配列形式で invalidClasses を渡すことで is-invalid クラスに加えて任意のクラスを付与できます。

const Validator = useValidator({invalidClasses: ['bg-red-200', 'text-red']})





実装済みバリデーションと使用方法一覧

【required】

概要

入力必須項目のバリデーションです。

使用方法

バリデーション対象要素に validations::required クラスを付与します。




【multipleRequired】

概要

複数のバリデーション対象要素において、少なくともいずれかひとつに入力が必要な場合のバリデーションです。

使用方法

  1. 複数のバリデーション対象要素に validations::multipleRequired クラスを付与します。
  2. 1で対象とした各要素に multipleRequiredGroup::{groupId} クラスを付与します。 ※{groupId} には各要素共通の文字列を指定
  3. 1で対象とした各要素にエラーメッセージで表示する名前を multipleRequiredName::{name} クラスを付与します。 ※{name} は日本語使用可能

使用例

<div class='form-group flex'>
    <label>名前</label>
    <div>
        <input name='name' type='text' class='validate validations::multipleRequired multipleRequiredGroup::profile multipleRequiredName::名前'>
        <div class='error-tip'></div>
    </div>
</div>
<div class='form-group flex'>
    <label>メールアドレス</label>
    <div>
        <input name='email' type='text' class='validate validations::multipleRequired multipleRequiredGroup::profile multipleRequiredName::メールアドレス'>
        <div class='error-tip'></div>
    </div>
</div>

上記の状態でエラーとなった場合 名前、メールアドレスのいずれかの入力は必須です。 とエラーメッセージが表示されます。




【email】

概要

メールアドレス形式のバリデーションです。

使用方法

バリデーション対象要素に validations::email クラスを付与します。




【confirmation】

概要

メールアドレスや新規パスワード設定時などで使用する、確認入力時のバリデーションです。
入力値が確認元に指定した要素の値と異なる場合はエラーとなります。

使用方法

  1. バリデーション対象要素に validations::confirmation クラスを付与します。
  2. 1で対象とした要素に confirmationBase::{name} クラスを付与します。 ※{name} には確認元の要素のname属性の文字列を指定

使用例

<div class='form-group'>
    <input name='email' type='text' class='validate validations::empty:email'>
    <div class='error-tip'></div>
</div>
<div class='form-group'>
    <input name='email_confirmation' type='text' class='validate validations::confirmation confirmationBase::email'>
    <div class='error-tip'></div>
</div>



【minimumCharacters】

概要

最小文字数のバリデーションです。

使用方法

バリデーション対象要素に validations::minimumCharacters-{number} クラスを付与します。 ※{number} には最小文字数を指定

使用例

8文字未満の場合にエラーとなる場合の例

<div class='form-group'>
    <input name='password' type='password' class='validate validations::minimumCharacters-8'>
    <div class='error-tip'></div>
</div>



【maximumCharacters】

概要

最大文字数のバリデーションです。

使用方法

バリデーション対象要素に validations::maximumCharacters-{number} クラスを付与します。 ※{number} には最大文字数を指定

使用例

16文字を超える場合にエラーとなる場合の例

<div class='form-group'>
    <input name='password' type='password' class='validate validations::maximumCharacters-16'>
    <div class='error-tip'></div>
</div>



【charactersRange】

概要

xx文字以上、yy文字以下のバリデーションです。

使用方法

バリデーション対象要素に validations::charactersRange-{min}-{max} クラスを付与します。 ※{min} には最小文字数、 {max}に最大文字数を指定

使用例

8文字未満または16文字を超える場合にエラーとなる場合の例

<div class='form-group'>
    <input name='password' type='password' class='validate validations::charactersRange-8-16'>
    <div class='error-tip'></div>
</div>



【halfWidthNumber】

概要

半角数字のバリデーションです。

使用方法

バリデーション対象要素に validations::halfWidthNumber クラスを付与します。




【katakana】

概要

全角カタカナのバリデーションです。

使用方法

バリデーション対象要素に validations::katakana クラスを付与します。




【hiragana】

概要

ひらがなのバリデーションです。

使用方法

バリデーション対象要素に validations::hiragana クラスを付与します。






オプション一覧

インスタンス生成時

オプションはインスタンス生成時にオブジェクト形式で渡せます。
オプションのプロパティはすべてオプショナルなので、必要なものだけ渡してください。

オプション名 デフォルト値 説明
validClasses string[] undefined .validate を付与した要素がバリデーションに通過したときに付与したいクラス名を配列形式で指定できます。ひとつだけクラス名を渡す場合も配列形式にしてください。
invalidClasses string[] undefined .validate を付与した要素がバリデーションに通過しなかったときに付与したいクラス名を配列形式で指定できます。ひとつだけクラス名を渡す場合も配列形式にしてください。

initialize 実行時

バリデーション対象要素の探索ルートを指定できます。ページ内に複数の <form> があり、各 <form> ごとにバリデーションを行いたい場合には form 要素を渡すか、任意のHTMLElementを渡して探索ルートとしてください。

Ref を使って渡す場合)

Validator.initialize(AnyRef.current)





バリデーション実行方法

バリデーション実行時に任意の name を渡すことで特定のバリデーション対象要素にバリデーションを実行できます。

<div class='form-group flex'>
    <label>ユーザー名</label>
    <div>
        <input name='user_name' type='text' class='validate validations::required'>
        <div class='error-tip'></div>
    </div>
</div>
<div class='form-group flex'>
    <label>メールアドレス</label>
    <div>
        <input name='email' type='text' class='validate validations::required:email'>
        <div class='error-tip'></div>
    </div>
</div>
Validator.validate('user_name')
// [name=user_name] 属性を持つ要素にバリデーションをトリガー

Package Sidebar

Install

npm i react-iii-validator

Weekly Downloads

0

Version

1.0.8

License

MIT

Unpacked Size

68.8 kB

Total Files

27

Last publish

Collaborators

  • io-kobayashiii