Vue.js カスタムディレクティブ

デフォルトで設定されているコアディレクティブ(v-model と v-show)に加えて、Vue ではカスタムディレクティブを登録することもできます。

以下で、ページ読み込み時に要素がフォーカスを取得する機能を持つ、グローバルディレクティブ v-focus を登録します。

実例

<div id="app"> <p>ページ読み込み時に、input 要素が自動的にフォーカスを取得します。</p> <input v-focus> </div> <script>// 注册一个全局自定义指令 v-focus Vue.directive('focus', { // 当绑定元素插入到 DOM 中。 inserted: function (el) { // 聚焦元素 el.focus() } }) // 创建根实例 new Vue({ el: '#app' })</script>

試してみる »

また、インスタンスで directives オプションを使用してローカルディレクティブを登録することもできます。これにより、このインスタンス内でのみそのディレクティブを使用できます。

実例

<div id="app"> <p>ページ読み込み時に、input 要素が自動的にフォーカスを取得します。</p> <input v-focus> </div> <script>// 创建根实例 new Vue({ el: '#app', directives: { // 注册一个局部の自定义指令 v-focus focus: { // 指令の定义 inserted: function (el) { // 聚焦元素 el.focus() } } } })</script>

試してみる »

フック

フック関数

ディレクティブ定義関数は、いくつかのフック関数(オプション)を提供します。

  • bind: 一度だけ呼び出されます。ディレクティブが初めて要素にバインドされたときに呼び出され、このフック関数を使用して、バインド時に一度だけ実行される初期化アクションを定義できます。

  • insertedバインドされた要素が親ノードに挿入されたときに呼び出されます(親ノードが存在すれば呼び出され、document 内に存在する必要はありません)。

  • update: バインドされた要素が含まれるテンプレートが更新されるときに呼び出されます。バインド値が変化したかどうかは関係ありません。更新前後のバインド値を比較することで、不要なテンプレート更新を無視できます(詳細なフック関数パラメータは下記参照)。

  • componentUpdated: バインドされた要素が含まれるテンプレートが 1 回の更新サイクルを完了したときに呼び出されます。

  • unbind: 一度だけ呼び出され、ディレクティブが要素からバインド解除されるときに呼び出されます。

フック関数のパラメータ

フック関数のパラメータは次のとおりです:

  • el: ディレクティブがバインドされている要素で、DOM を直接操作するために使用できます。
  • binding: 次のプロパティを含むオブジェクト:
    • name: ディレクティブ名。次のものは含みません:v-プレフィックス。
    • value: ディレクティブのバインド値。例:v-my-directive="1 + 1"、value の値は2。
    • oldValue: ディレクティブにバインドされた前の値。次の場合のみupdateとcomponentUpdatedフックで使用できます。値が変わっているかどうかに関係なく使用できます。
    • expression: バインド値の式または変数名。例:v-my-directive="1 + 1"、expression の値は"1 + 1"。
    • arg: ディレクティブに渡される引数。例:v-my-directive:foo、arg の値は"foo"。
    • modifiers: 修飾子を含むオブジェクト。例:v-my-directive.foo.bar、修飾子オブジェクト modifiers の値は{ foo: true, bar: true }。
  • vnode: Vue のコンパイルによって生成された仮想ノード。
  • oldVnode: 前の仮想ノード。次の場合のみupdateとcomponentUpdatedフックで使用できます。

以下の実例では、これらのパラメータの使用法を示しています:

実例

<div id="app" v-サンプル:hello.a.b="message"> </div> <script> Vue.directive('サンプル', { bind: function (el, binding, vnode) { var s = JSON.stringify el.innerHTML = 'name: ' + s(binding.name) + '<br>' + 'value: ' + s(binding.value) + '<br>' + 'expression: ' + s(binding.expression) + '<br>' + 'argument: ' + s(binding.arg) + '<br>' + 'modifiers: ' + s(binding.modifiers) + '<br>' + 'vnode keys: ' + Object.keys(vnode).join(', ') } }) new Vue({ el: '#app', data: { message: 'サンプル!' } })</script>

試してみる »

他のフック関数が必要ない場合は、関数を次のように簡略化できます:

Vue.directive('サンプル', function (el, binding) {
  // 设置指令的背景颜色
  el.style.backgroundColor = binding.value.color
})

ディレクティブ関数は有効な JavaScript 式をすべて受け入れることができます。以下の実例では、JavaScript オブジェクトを渡しています:

実例

<div id="app"> <div v-サンプル="{ color: 'green', text: 'サンプル!' }"></div> </div> <script>Vue.directive('サンプル', function (el, binding) { // 简写方式设置文本及背景颜色 el.innerHTML = binding.value.text el.style.backgroundColor = binding.value.color }) new Vue({ el: '#app' })</script>

試してみる »
その他の拡張