検証コントロールの通知機能について解説します。
概要
検証コントロールによる検証結果を通知する方法として、以下の3つのプロパティを提供しています。
ツールチップ(tip)
アイコン(icon)
コントロールの外観(controlState)
検証コントロールでは、複数の検証アイテムを配列として登録することができますが、通知設定の設定方法については、それぞれの検証アイテムごとにnotifyプロパティに設定する方法と、すべての検証アイテムに対して有効となるdefaultNotifyプロパティに設定する方法があります。
これらのプロパティに上記3つの通知方法を設定することで、通知機能をカスタマイズすることが可能です。なお、それぞれの設定は検証成功時(success)と検証失敗時(fail)のそれぞれに設定することができます。
ツールチップ
tipプロパティ(boolean/object)を使用して、検証結果を通知するツールチップを表示するかどうかを設定できます。なお、表示の可否だけではなく、表示位置などの細かな設定も可能です。ツールチップの詳細な設定については「ツールチップ通知」サンプルをご覧ください。
アイコン
iconプロパティ(boolean/object)を使用して、検証結果を通知するアイコンを表示するかどうかを設定できます。なお、表示の可否だけではなく、表示位置などの細かな設定も可能です。アイコンの詳細な設定については「アイコン通知」サンプルをご覧ください。
コントロールの外観
controlStateプロパティ(boolean)を使用して、検証結果に応じてコントロール自体の外観(枠線や文字色等)を変更するどうかを設定できます。このプロパティをtrueに設定した場合、検証成功時には緑、検証失敗時には赤のスタイルがコントロールに適用されます。
import '@grapecity/inputman/CSS/gc.inputman-js.css';
import { InputMan } from '@grapecity/inputman';
InputMan.appearanceStyle = InputMan.AppearanceStyle.Modern;
const gcTextBox1 = new InputMan.GcTextBox(document.getElementById('gcTextBox1'));
const gcTextBox2 = new InputMan.GcTextBox(document.getElementById('gcTextBox2'), {
text: 'テキスト'
});
var validator;
const update = () => {
if (validator) {
validator.destroy();
}
validator = new GCIM.GcValidator({
items: [
{
control: gcTextBox1,
ruleSet: [
{
rule: InputMan.ValidateType.Required
}
],
},
{
control: gcTextBox2,
ruleSet: [
{
rule: InputMan.ValidateType.Required
}
],
}
],
defaultNotify: {
fail: {
tip: document.getElementById('failTip').checked,
icon: document.getElementById('failIcon').checked ? {
direction: InputMan.IconDirection.Inside
} : false,
controlState: document.getElementById('failControlState').checked
},
success: {
tip: document.getElementById('successTip').checked,
icon: document.getElementById('successIcon').checked ? {
direction: InputMan.IconDirection.Inside
} : false,
controlState: document.getElementById('successControlState').checked
}
}
});
validator.validate();
}
update();
var checkboxArr = document.querySelectorAll('input[type="checkbox"]');
for (var i = 0; i < checkboxArr.length; i++) {
checkboxArr[i].addEventListener('change', (e) => {
update();
});
}
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>検証コントロール - 通知</title>
<!-- SystemJS -->
<script src="node_modules/systemjs/dist/system.src.js"></script>
<script src="systemjs.config.js"></script>
<script>
System.import('./src/app');
</script>
</head>
<body>
<input id="gcTextBox1"><br><br>
<input id="gcTextBox2">
<table class="sample">
<tr>
<th>検証失敗の通知</th>
<td>
<label><input type="checkbox" id="failTip" checked>ツールチップ</label><br>
<label><input type="checkbox" id="failIcon" checked>アイコン</label><br>
<label><input type="checkbox" id="failControlState" checked>コントロール状態</label><br>
</td>
</tr>
<tr>
<th>検証成功の通知</th>
<td>
<label><input type="checkbox" id="successTip" checked>ツールチップ</label><br>
<label><input type="checkbox" id="successIcon" checked>アイコン</label><br>
<label><input type="checkbox" id="successControlState" checked>コントロール状態</label><br>
</td>
</tr>
</table>
</body>
</html>
System.config({
transpiler: 'plugin-babel',
babelOptions: {
es2015: true
},
meta: {
'*.css': { loader: 'css' }
},
paths: {
// paths serve as alias
'npm:': 'node_modules/'
},
// map tells the System loader where to look for things
map: {
'@grapecity/inputman': 'npm:@grapecity/inputman/index.js',
'@grapecity/inputman/CSS': 'npm:@grapecity/inputman/CSS',
'css': 'npm:systemjs-plugin-css/css.js',
'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel/systemjs-babel-browser.js'
},
// packages tells the System loader how to load when no filename and/or no extension
packages: {
src: {
defaultExtension: 'js'
},
"node_modules": {
defaultExtension: 'js'
},
}
});