Skip to content

24. 自定义事件

  1. 一种组件间通信的方式,适用于:子组件 = = > 父组件

  2. 使用场景:A是父组件,B是子组件,B想给A传数据,那么要在A中给B绑定自定义事件(事件的回调 A 中)

  3. 绑定自定义事件:

    1. 第一种方式,在父组件中:<Demo @atguigu="test"/><Demo v-on:atguigu="test"/>

    2. 在第二种方式,在父组件中:

      vue
      <Demo ref="demo"/>
      ......
      mounted() {
      	this.$refs.xxx.$on('atguigu',this.test)
      }
    3. 若想让自定义事件值触发一次,可以使用 once 修饰符,或 $once 方法

  4. 触发自定义事件:this.$emit('atguitu',数据)

  5. 解绑自定义事件 this.$off('atguigu')

  6. 组件上也可以绑定原生DOM事件,需要使用 native 修饰符

  7. 注意:通过 this.$refs.xxx.$on('atguigu',回调) 绑定自定义事件时,回调要么配置在methods中,要么用箭头函数,否则 this 指向会出问题!

App.vue

vue
<template>
  <div class="app">
    <h1>{{ msg }},学生姓名是{{ studentName }}</h1>
    <!--🔴 通过父组件给子组件传递函数类型的props实现:子给父传递数据 -->
    <School :getSchoolName="getSchoolName"></School>

    <!--🔴 通过父组件给子组件绑定一个自定义事件实现:子给父传递数据(第一种写法:使用 @ 或 v-on) -->
    <!-- <Student :getStudentName="getStudentName" @demo="m1"></Student> -->

    <!--🔴 通过父组件给子组件绑定一个自定义事件实现:子给父传递数据 (第二种写法:使用ref) -->
    <Student ref="student" @click.native="show"></Student>
    <!--🔴 native-->
  </div>
</template>

<script>
import School from './components/School.vue'
import Student from './components/Student.vue'
export default {
  name: 'App',

  data() {
    return {
      msg: '你好啊',
      studentName: ''
    }
  },
  components: {
    Student,
    School
  },

  mounted() {
    setTimeout(() => {
      // this.$refs.student.$on('boluo', this.getStudentName)      // 绑定自定义事件
      // this.$refs.student.$once('boluo', this.getStudentName)    // 一次性事件
    }, 3000)
  },

  methods: {
    show() {
      alert(123)
    },
    getSchoolName(name) {
      console.log('App收到了学校名', name)
    },
    getStudentName(name, ...params) {
      console.log('App收到了学生名', name, params)
      this.studentName = name
    },
    m1() {
      console.log('demo事件被触发了')
    }
  }
}
</script>

<style lang="less" scoped>
.app {
  background-color: gray;
  padding: 5px;
}
</style>

Student.vue

vue
<template>
  <div class="student">
    <h2>学生姓名:{{ name }}</h2>
    <h2>学生性别:{{ sex }}</h2>
    <h2>当前求和为:{{ number }}</h2>
    <button @click="add">点我number++</button>
    <button @click="sendStudentName">把学生名给App</button>
    <button @click="unbind">解绑boluo事件</button>
    <button @click="death">销毁当前Student组件的实例</button>
  </div>
</template>

<script>
export default {
  name: 'School',

  data() {
    return {
      name: '张三',
      sex: '男',
      number: 0
    }
  },

  mounted() {},

  methods: {
    add() {
      console.log('add回调被调用了')
      this.number++
    },
    sendStudentName() {
      // 触发 Student组件实例身上的事件
      this.$emit('boluo', this.name, '666', '888')
      // this.$emit('demo')
    },
    unbind() {
      this.$off('boluo') // 解绑一个自定义事件
      // this.$off(['boluo', 'demo']) 解绑所有的事件
    },
    death() {
      this.$destroy() // 销毁了当前Student组件实例  销毁后所有Student实例的自定义事件全部不奏效了
    }
  }
}
</script>

<style scoped>
.student {
  background-color: pink;
  padding: 5px;
  margin-top: 30px;
}
</style>

School.vue

vue
<template>
  <div class="school">
    <h2>学校名称:{{ name }}</h2>
    <h2>学校名称:{{ address }}</h2>
    <button @click="sendSchoolName">把学校名给App</button>
  </div>
</template>

<script>
export default {
  name: 'School',

  data() {
    return {
      name: 'ETC',
      address: '武汉'
    }
  },
  props: ['getSchoolName'],
  mounted() {},

  methods: {
    sendSchoolName() {
      this.getSchoolName(this.name)
    }
  }
}
</script>

<style>
.school {
  background-color: skyblue;
  padding: 5px;
}
</style>

Todo-List 自定义事件

App.vue

vue
<template>
  <div>
    <div id="root">
      <div class="todo-container">
        <div class="todo-wrap">
          <MyHeader @addTodo="addTodo"></MyHeader>
          <MyList :deleteTodo="deleteTodo" :checkTodo="checkTodo" :todos="todos"></MyList>
            <!-- 🔴 -->
          <MyFooter @clearAllTodo="clearAllTodo" v-if="todos.length > 0" @fullCheck="fullCheck" :todos="todos"></MyFooter>
        </div>
      </div>
    </div>
  </div>
</template>

<script>
import MyHeader from './components/MyHeader'
import MyFooter from './components/MyFooter'
import MyList from './components/MyList'

export default {
  name: 'App',
  watch: {
    todos: {
      deep: true,
      handler(value) {
        localStorage.setItem('todos', JSON.stringify(value))
      }
    }
  },
  data() {
    return {
      // 由于 todos 是 MyHeader组件和MyFooter组件都在使用 所以放在 App 中 (状态提升)
      todos: JSON.parse(localStorage.getItem('todos')) || []
    }
  },
  components: {
    MyHeader,
    MyFooter,
    MyList
  },
  mounted() {},

  methods: {
    // 添加一个 todo
    addTodo(todoObj) {
      this.todos.unshift(todoObj)
    },
    // 勾选 or 取消勾选 todo
    checkTodo(id) {
      this.todos.some(todo => {
        if (todo.id == id) {
          todo.done = !todo.done
          console.log(todo)
        }
      })
    },
    // 删除一个todo
    deleteTodo(id) {
      this.todos = this.todos.filter(todo => {
        return todo.id !== id
      })
    },
    // 全选 or 取消全选
    fullCheck(done) {
      this.todos.forEach(todo => {
        todo.done = done
      })
    },
    // 清除所有已经完成的todo
    clearAllTodo() {
      this.todos = this.todos.filter(todo => !todo.done)
    }
  }
}
</script>

<style lang="less">
/*base*/
body {
  background: #fff;
}

.btn {
  display: inline-block;
  padding: 4px 12px;
  margin-bottom: 0;
  font-size: 14px;
  line-height: 20px;
  text-align: center;
  vertical-align: middle;
  cursor: pointer;
  box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05);
  border-radius: 4px;
}

.btn-danger {
  color: #fff;
  background-color: #da4f49;
  border: 1px solid #bd362f;
}

.btn-danger:hover {
  color: #fff;
  background-color: #bd362f;
}

.btn:focus {
  outline: none;
}

.todo-container {
  width: 600px;
  margin: 0 auto;
}
.todo-container .todo-wrap {
  padding: 10px;
  border: 1px solid #ddd;
  border-radius: 5px;
}
</style>

MyFooter.vue

vue
<template>
  <div>
    <div class="todo-footer">
      <label>
        <input type="checkbox" v-model="isAll" />
      </label>
      <span>
        <span>已完成{{ doneTotal }}</span> / 全部{{ todos.length }}
      </span>
      <button class="btn btn-danger" @click="clearTodos">清除已完成任务</button>
    </div>
  </div>
</template>

<script>
export default {
  name: 'MyFooter',
  computed: {
    doneTotal() {
      return this.todos.filter(todo => todo.done).length
    },
    isAll: {
      get() {
        return this.todos.every(todo => todo.done == true) && this.todos.length > 0
      },
      set(value) {
        this.$emit('fullCheck', value)
      }
    }
  },
  data() {
    return {
      isfull: false
    }
  },
  props: ['todos'],

  mounted() {},
  methods: {
    clearTodos() {
      if (confirm('确定清空吗')) {
        this.$emit('clearAllTodo')
      }
    }
  }
}
</script>

<style lang="less" scoped>
/*footer*/
.todo-footer {
  height: 40px;
  line-height: 40px;
  padding-left: 6px;
  margin-top: 5px;
}

.todo-footer label {
  display: inline-block;
  margin-right: 20px;
  cursor: pointer;
}

.todo-footer label input {
  position: relative;
  top: -1px;
  vertical-align: middle;
  margin-right: 5px;
}

.todo-footer button {
  float: right;
  margin-top: 5px;
}
</style>

MyHeader.vue

vue
<template>
  <div>
    <div class="todo-header">
      <input type="text" placeholder="请输入你的任务名称,按回车键确认" v-model="title" @keyup.enter="add" />
    </div>
  </div>
</template>

<script>
import { nanoid } from 'nanoid'
export default {
  name: 'MyHeader',

  data() {
    return {
      title: ''
    }
  },

  mounted() {},

  methods: {
    add() {
      // 校验数据
      if (!this.title.trim()) return alert('输入不能为空')
      // 将用户的输入包装成一个todo对象
      const todoObj = { id: nanoid(), title: this.title.trim(), done: false }
      // 通知App组件去添加一个 todo 对象
      this.$emit('addTodo', todoObj)
      // 清空输入
      this.title = ''
    }
  }
}
</script>

<style lang="less" scoped>
/*header*/
.todo-header input {
  width: 560px;
  height: 28px;
  font-size: 14px;
  border: 1px solid #ccc;
  border-radius: 4px;
  padding: 4px 7px;
}

.todo-header input:focus {
  outline: none;
  border-color: rgba(82, 168, 236, 0.8);
  box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(82, 168, 236, 0.6);
}
</style>

Powered by VitePress & Vue 3