Vue 实例方法

发布于 2025-01-17 15:07:33 字数 6166 浏览 2 评论 0

数据

vm.$watch( expOrFn, callback, [options] )

观察 Vue 实例上的一个表达式或者一个函数计算结果的变化。回调函数得到的参数为新值和旧值。表达式只接受简单的键路径。对于更复杂的表达式，用一个函数取代。

参数：
- {string | Function} expOrFn
- {Function | Object} callback
- {Object} [options]
  - {boolean} deep
  - {boolean} immediate
返回值 ： {Function} unwatch

注意：在变更 (不是替换) 对象或数组时，旧值将与新值相同，因为它们的引用指向同一个对象/数组。Vue 不会保留变更之前值的副本。

// 键路径
vm.$watch('a.b.c', function (newVal, oldVal) {
  // 做点什么
})

// 函数
vm.$watch(
  function () {
    // 表达式 `this.a + this.b` 每次得出一个不同的结果时
    // 处理函数都会被调用。
    // 这就像监听一个未被定义的计算属性
    return this.a + this.b
  },
  function (newVal, oldVal) {
    // 做点什么
  }
)

vm.$watch 返回一个取消观察函数，用来停止触发回调：

var unwatch = vm.$watch('a', cb)
// 之后取消观察
unwatch()

在选项参数中指定 immediate: true 将立即以表达式的当前值触发回调：

vm.$watch('a', callback, {
  immediate: true
})
// 立即以 `a` 的当前值触发回调

注意在带有 immediate 选项时，你不能在第一次回调时取消侦听给定的 property。

// 这会导致报错
var unwatch = vm.$watch(
  'value',
  function () {
    doSomething()
    unwatch()
  },
  { immediate: true }
)

如果你仍然希望在回调内部调用一个取消侦听的函数，你应该先检查其函数的可用性：

var unwatch = vm.$watch(
  'value',
  function () {
    doSomething()
    if (unwatch) {
      unwatch()
    }
  },
  { immediate: true }
)

vm.$set( target, propertyName/index, value )

这是全局 Vue.set 的别名。

参数：
- {Object | Array} target
- {string | number} propertyName/index
- {any} value
返回值 ：设置的值。

vm.$delete( target, propertyName/index )

这是全局 Vue.delete 的别名。

参数：

{Object | Array} target
{string | number} propertyName/index

事件

vm.$on( event, callback )

监听当前实例上的自定义事件。事件可以由 vm.$emit 触发。回调函数会接收所有传入事件触发函数的额外参数。

参数：

{string | Array<string>} event
{Function} callback

vm.$once( event, callback )

监听一个自定义事件，但是只触发一次。一旦触发之后，监听器就会被移除。

参数：

{string} event
{Function} callback

vm.$off( [event, callback] )

移除自定义事件监听器。

如果没有提供参数，则移除所有的事件监听器 ；
如果只提供了事件，则移除该事件所有的监听器 ；
如果同时提供了事件与回调，则只移除这个回调的监听器 。

参数：

{string | Array<string>} event
{Function} [callback]

vm.$emit( eventName, […args] )

触发当前实例上的事件。附加参数都会传给监听器回调。

参数：

{string} eventName
[...args]

Vue.component('magic-eight-ball', {
  data: function () {
    return {
      possibleAdvice: ['Yes', 'No', 'Maybe']
    }
  },
  methods: {
    giveAdvice: function () {
      var randomAdviceIndex = Math.floor(Math.random() * this.possibleAdvice.length)
      this.$emit('give-advice', this.possibleAdvice[randomAdviceIndex])
    }
  },
  template: `
    <button v-on:click="giveAdvice">
      Click me for advice
    </button>
  `
})

<template>
	<div id="emit-example-argument">
    	<magic-eight-ball v-on:give-advice="showAdvice"></magic-eight-ball>
    </div>
</template>
<script>
    new Vue({
        el: '#emit-example-argument',
        methods: {
            showAdvice: function (advice) {
                alert(advice)
            }
        }
    })
</script>

生命周期

vm.$mount( [elementOrSelector] )

如果 Vue 实例在实例化时没有收到 el 选项 ，则它处于“未挂载”状态，没有关联的 DOM 元素。可以使用 vm.$mount() 手动地挂载一个未挂载的实例。

如果没有提供 elementOrSelector 参数，模板将被渲染为文档之外的的元素，并且你必须使用原生 DOM API 把它插入文档中。

这个方法返回实例自身，因而可以链式调用其它实例方法。

参数：
- {Element | string} [elementOrSelector]
- {boolean} [hydrating]
返回值 ： vm - 实例自身

var MyComponent = Vue.extend({
  template: '<div>Hello!</div>'
})

// 创建并挂载到 #app (会替换 #app)
new MyComponent().$mount('#app')

// 同上
new MyComponent({ el: '#app' })

// 或者，在文档之外渲染并且随后挂载
var component = new MyComponent().$mount()
document.getElementById('app').appendChild(component.$el)

vm.$forceUpdate()

迫使 Vue 实例重新渲染。注意它 仅仅影响实例本身 和 插入插槽内容的子组件，而不是所有子组件 。

vm.$nextTick( [callback] )

将回调延迟到下次 DOM 更新循环之后执行 。在修改数据之后立即使用它，然后等待 DOM 更新。它跟全局方法 Vue.nextTick 一样，不同的是回调的 this 自动绑定到调用它的实例上。

参数：

{Function} [callback]

new Vue({
  // ...
  methods: {
    // ...
    example: function () {
      // 修改数据
      this.message = 'changed'
      // DOM 还没有更新
      this.$nextTick(function () {
        // DOM 现在更新了
        // `this` 绑定到当前实例
        this.doSomethingElse()
      })
    }
  }
})