検証コントロールのツールチップ通知機能について解説します。
概要
notify(またはdefaultNotify)プロパティのtipプロパティを使用することで、検証結果を通知するツールチップの表示可否(boolean)を設定できますが、このtipプロパティには、通知の方向や配置位置などを調整する機能もあります。また、通知のレイアウトに適用するテンプレートもこのプロパティから設定可能です。
通知の方向
通知の方向は、directionプロパティから設定可能です。設定可能な値(TipDirection列挙体)は、以下の通りです。
値
説明
Bottom
ツールチップをコントロールの下側に表示します。
Left
ツールチップをコントロールの左側に表示します。
Right
ツールチップをコントロールの右側に表示します。(既定値)
Top
ツールチップをコントロールの上側に表示します。
なお、InputManJSでは、ツールチップを表示する方向の優先順位もdirectionPriorityプロパティで設定することが可能です。directionPriorityプロパティには、TipDirection列挙体の配列を設定します。
たとえば、通知の方向を左に設定し、通知を表示する方向の優先順位を「左→下→上→右」とする場合のサンプルコードは、以下の通りです。(tipプロパティの設定部分のみ抜粋)
通知の配置
positionプロパティを使用することで、ツールチップ通知の配置(表示する位置)をコントロールのどの位置に揃えるかを設定できます。設定可能な値(TipPosition列挙体)は、以下の通りです。
値
説明
Balanced
ツールチップとコントロールを中央で揃えます。(既定値)
End
ツールチップとコントロールを終端で揃えます。通知の方向を上または下に設定している場合は右端を揃え、通知の方向を左または右に設定している場合は下端を揃えます。
Start
ツールチップとコントロールを先端で揃えます。通知の方向を上または下に設定している場合は左端を揃え、通知の方向を左または右に設定している場合は上端を揃えます。
通知の配置を設定するサンプルコードは、以下の通りです。(tipプロパティの設定部分のみ抜粋)
通知のテンプレート
templateプロパティを使用することで、ツールチップ通知の外観にHTMLで定義したテンプレートを適用することが可能です。
以下は、ツールチップ通知の背景色と文字色などをテンプレートで設定したサンプルコードです。
import '@grapecity/inputman/CSS/gc.inputman-js.css';
import { InputMan } from '@grapecity/inputman';
InputMan.appearanceStyle = InputMan.AppearanceStyle.Modern;
const gcTextBox = new InputMan.GcTextBox(document.getElementById('gcTextBox'));
document.getElementById('direction').addEventListener('change', (e) => {
update();
});
document.getElementById('position').addEventListener('change', (e) => {
update();
});
var validator;
const update = () => {
if (validator) {
validator.destroy();
}
validator = new GCIM.GcValidator({
items: [
{
control: gcTextBox,
ruleSet: [
{
rule: InputMan.ValidateType.Required
}
],
}
],
defaultNotify: {
tip: {
direction: tipDirections[document.getElementById('direction').selectedIndex],
position: tipPositions[document.getElementById('position').selectedIndex],
template: document.getElementById('template').checked ? '<div style="color:red;min-width:10.5rem;">{!message}</div>' : ''
}
}
});
validator.validate();
}
const tipDirections = [
InputMan.TipDirection.Top,
InputMan.TipDirection.Bottom,
InputMan.TipDirection.Left,
InputMan.TipDirection.Right
];
const tipPositions = [
InputMan.TipPosition.Start,
InputMan.TipPosition.Balanced,
InputMan.TipPosition.End
];
update();
document.getElementById('template').addEventListener('change', 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="gcTextBox" style="margin: 3rem 15rem">
<table class="sample">
<tr>
<th>通知の方向</th>
<td>
<select id="direction" class="update">
<option>上</option>
<option>下</option>
<option>左</option>
<option selected>右</option>
</select>
</td>
</tr>
<tr>
<th>通知の配置</th>
<td>
<select id="position" class="update">
<option>先頭</option>
<option selected>中央</option>
<option>末尾</option>
</select>
</td>
</tr>
<tr>
<th>通知のテンプレート</th>
<td>
<label><input type="checkbox" id="template" class="update">テンプレートを使って表示</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'
},
}
});