Plusプラン限定レッスン

カスタムイベントを作成しよう

本レッスンでは、カスタムイベントについて学習します。たとえばボタンのコンポーネントを考えるとき、これまではクリックイベントの内容をコンポーネントに書いていました。しかし、カスタムイベントを用いるとイベントの中身を別のコンポーネントで定義できるようになります。

名前からは仕様がイメージしにくいカスタムイベントですが、具体的な例を交えつつ学習してきましょう。

イベントの抽象化

次のようなボタンのコンポーネントを作ることを考えてください。

  • 見た目やインタラクションはコンポーネントが持っている
  • クリックイベントの内容は呼び出し元で定義したい

ButtonComponentというコンポーネントを作成し、それを元に解説します。

▼ButtonComponent.vueファイル

<template>
  <button class="btn" @click="clickEvent">{{ text }}</button>
</template>

<script>
export default {
  name: "ButtonComponent",
  props: {
    text: String,
  },
  methods: {
    clickEvent() {
      this.$emit("emitEvent");
    },
  },
};
</script>

<style scoped>
.btn {
  /*----好きなスタイル----*/
}
</style>

クリックイベントによって呼び出されるclickEventメソッドの中身には、具体的な処理が書かれていません。代わりに、this.$emit("emitEvent")という記述があります。これは「クリックイベントによってemitEventを発火させる」という意味です。ではemitEventの処理はどこで定義されるのでしょう。

それは、呼び出し元のコンポーネントです。App.vueでButtonComponentを呼び出す例を以下に示します。

この続きはPlusプラン限定です