Vue.js コンポーネント - カスタムイベント

親コンポーネントは props を使用して子コンポーネントにデータを渡しますが、子コンポーネントがデータを渡し返す必要がある場合は、カスタムイベントを使用する必要があります!

v-on を使用してカスタムイベントをバインドできます。各 Vue インスタンスはイベントインターフェース (Events interface) を実装しています。すなわち:

  • 使用$on(eventName)イベントをリッスン
  • 使用$emit(eventName)イベントをトリガー

さらに、親コンポーネントは子コンポーネントを使用する場所で v-on を直接使用して、子コンポーネントがトリガーしたイベントをリッスンできます。

以下の例では、子コンポーネントは外部と完全に切り離されています。子コンポーネントが行うのは、親コンポーネントが関心を持つ内部イベントをトリガーすることだけです。

例

<div id="app"> <div id="counter-event-example"> <p>{{ total }}</p> <button-counter v-on:increment="incrementTotal"></button-counter> <button-counter v-on:increment="incrementTotal"></button-counter> </div> </div> <script> Vue.component('button-counter', { template: '<button v-on:click="incrementHandler">{{ counter }}</button>', data: function () { return { counter: 0 } }, methods: { incrementHandler: function () { this.counter += 1 this.$emit('increment') } }, }) new Vue({ el: '#counter-event-example', data: { total: 0 }, methods: { incrementTotal: function () { this.total += 1 } } }) </script>

試してみる »

あるコンポーネントのルート要素でネイティブイベントをリッスンしたい場合は、.native 修飾子を v-on に使用できます。例:

<my-component v-on:click.native="doTheThing"></my-component>

data は関数でなければなりません

上記の例では、button-counter コンポーネントの data はオブジェクトではなく関数であることがわかります:

data: function () {
  return {
    count: 0
  }
}

この利点は、各インスタンスが返されたオブジェクトの独立したコピーを保持できることです。data がオブジェクトの場合、他のインスタンスに影響を与えます。次のようになります:

例

<div id="components-demo3" class="demo"> <button-counter2></button-counter2> <button-counter2></button-counter2> <button-counter2></button-counter2> </div> <script>var buttonCounter2Data = { count: 0 } Vue.component('button-counter2', { /* data: function () { // data オプションは関数であり、コンポーネントは互いに影響しません return { count: 0 } }, */ data: function () { // data オプションはオブジェクトであり、他のインスタンスに影響します return buttonCounter2Data }, template: '<button v-on:click="count++">{{ count }} 回クリックしました。</button>' }) new Vue({ el: '#components-demo3' }) </script>

試してみる »

カスタムコンポーネントの v-model

コンポーネントの v-model は、デフォルトで value という名前の prop と input という名前のイベントを利用します。

<input v-model="parentData">

次と同等です:

<input 
    :value="parentData"
    @input="parentData = $event.target.value"
>

以下の例では、カスタムコンポーネント サンプル-input を使用しています。親コンポーネントの num の初期値は 100 で、子コンポーネントの値を変更すると親コンポーネントの num がリアルタイムに更新されます:

例

<div id="app"> <サンプル-input v-model="num"></サンプル-input> <p>入力された数字:{{num}}</p> </div> <script> Vue.component('サンプル-input', { template: ` <p> <!--input という名前のイベントが含まれています--> <input ref="input" :value="value" @input="$emit('input', $event.target.value)" > </p>`, props: ['value'], // value という名前の prop }) new Vue({ el: '#app', data: { num: 100, } })</script>

試してみる »

v-model はデフォルトで value を渡すため、checked ではありません。そのため、チェックボックスやラジオボタンのコンポーネントでは、model オプションを使用する必要があります。model オプションは、現在のイベントタイプと渡される props を指定できます。

例

<div id="app"> <base-checkbox v-model="lovingVue"></base-checkbox> <div v-show="lovingVue">チェックボックスにチェックを入れると表示されます。</div> </div> <script>// 登録 Vue.component('base-checkbox', { model: { prop: 'checked', event: 'change' // onchange イベント }, props: { checked: Boolean }, template: `<input type="checkbox" v-bind:checked="checked" v-on:change="$emit('change', $event.target.checked)" >` }) // ルートインスタンスを作成 new Vue({ el: '#app', data: { lovingVue: true } })</script>

試してみる »

この例では、lovingVue の値は checked の prop に渡されます。また、<base-checkbox> が change イベントをトリガーすると、lovingVue の値も更新されます。

その他の拡張