全局API

340 阅读1分钟

全局 API Vue.extend( options ) 参数:

{Object} options 用法:

使用基础 Vue 构造器,创建一个“子类”。参数是一个包含组件选项的对象。

data 选项是特例,需要注意 - 在 Vue.extend() 中它必须是函数

// 创建构造器 var Profile = Vue.extend({ template: '

{{firstName}} {{lastName}} aka {{alias}}

', data: function () { return { firstName: 'Walter', lastName: 'White', alias: 'Heisenberg' } } }) // 创建 Profile 实例,并挂载到一个元素上。 new Profile().$mount('#mount-point') 结果如下:

Walter White aka Heisenberg

参考:组件

Vue.nextTick( [callback, context] ) 参数:

{Function} [callback] {Object} [context] 用法:

在下次 DOM 更新循环结束之后执行延迟回调。在修改数据之后立即使用这个方法,获取更新后的 DOM。

// 修改数据 vm.msg = 'Hello' // DOM 还没有更新 Vue.nextTick(function () { // DOM 更新了 })

// 作为一个 Promise 使用 (2.1.0 起新增,详见接下来的提示) Vue.nextTick() .then(function () { // DOM 更新了 }) 2.1.0 起新增:如果没有提供回调且在支持 Promise 的环境中,则返回一个 Promise。请注意 Vue 不自带 Promise 的 polyfill,所以如果你的目标浏览器不原生支持 Promise (IE:你们都看我干嘛),你得自己提供 polyfill。

参考:异步更新队列

Vue.set( target, propertyName/index, value ) 参数:

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

用法:

向响应式对象中添加一个属性,并确保这个新属性同样是响应式的,且触发视图更新。它必须用于向响应式对象上添加新属性,因为 Vue 无法探测普通的新增属性 (比如 this.myObject.newProperty = 'hi')

注意对象不能是 Vue 实例,或者 Vue 实例的根数据对象。

Vue.delete( target, propertyName/index ) 参数:

{Object | Array} target {string | number} propertyName/index 仅在 2.2.0+ 版本中支持 Array + index 用法。

用法:

删除对象的属性。如果对象是响应式的,确保删除能触发更新视图。这个方法主要用于避开 Vue 不能检测到属性被删除的限制,但是你应该很少会使用它。

在 2.2.0+ 中同样支持在数组上工作。

目标对象不能是一个 Vue 实例或 Vue 实例的根数据对象。

参考:深入响应式原理

Vue.directive( id, [definition] ) 参数:

{string} id {Function | Object} [definition] 用法:

注册或获取全局指令。

// 注册 Vue.directive('my-directive', { bind: function () {}, inserted: function () {}, update: function () {}, componentUpdated: function () {}, unbind: function () {} })

// 注册 (指令函数) Vue.directive('my-directive', function () { // 这里将会被 bindupdate 调用 })

// getter,返回已注册的指令 var myDirective = Vue.directive('my-directive') 参考:自定义指令

Vue.filter( id, [definition] ) 参数:

{string} id {Function} [definition] 用法:

注册或获取全局过滤器。

// 注册 Vue.filter('my-filter', function (value) { // 返回处理后的值 })

// getter,返回已注册的过滤器 var myFilter = Vue.filter('my-filter') 参考:过滤器

Vue.component( id, [definition] ) 参数:

{string} id {Function | Object} [definition] 用法:

注册或获取全局组件。注册还会自动使用给定的id设置组件的名称

// 注册组件,传入一个扩展过的构造器 Vue.component('my-component', Vue.extend({ /* ... */ }))

// 注册组件,传入一个选项对象 (自动调用 Vue.extend) Vue.component('my-component', { /* ... */ })

// 获取注册的组件 (始终返回构造器) var MyComponent = Vue.component('my-component') 参考:组件

Vue.use( plugin ) 参数:

{Object | Function} plugin 用法:

安装 Vue.js 插件。如果插件是一个对象,必须提供 install 方法。如果插件是一个函数,它会被作为 install 方法。install 方法调用时,会将 Vue 作为参数传入。

该方法需要在调用 new Vue() 之前被调用。

当 install 方法被同一个插件多次调用,插件将只会被安装一次。

参考:插件

Vue.mixin( mixin ) 参数:

{Object} mixin 用法:

全局注册一个混入,影响注册之后所有创建的每个 Vue 实例。插件作者可以使用混入,向组件注入自定义的行为。不推荐在应用代码中使用。

参考:全局混入

Vue.compile( template ) 参数:

{string} template 用法:

在 render 函数中编译模板字符串。只在独立构建时有效

var res = Vue.compile('

{{ msg }}
')

new Vue({ data: { msg: 'hello' }, render: res.render, staticRenderFns: res.staticRenderFns }) 参考:渲染函数

Vue.observable( object ) 2.6.0 新增

参数:

{Object} object 用法:

让一个对象可响应。Vue 内部会用它来处理 data 函数返回的对象。

返回的对象可以直接用于渲染函数和计算属性内,并且会在发生改变时触发相应的更新。也可以作为最小化的跨组件状态存储器,用于简单的场景:

const state = Vue.observable({ count: 0 })

const Demo = { render(h) { return h('button', { on: { click: () => { state.count++ }} }, count is: ${state.count}) } } 在 Vue 2.x 中,被传入的对象会直接被 Vue.observable 改变,所以如这里展示的,它和被返回的对象是同一个对象。在 Vue 3.x 中,则会返回一个可响应的代理,而对源对象直接进行修改仍然是不可响应的。因此,为了向前兼容,我们推荐始终操作使用 Vue.observable 返回的对象,而不是传入源对象。

参考:深入响应式原理

Vue.version 细节:提供字符串形式的 Vue 安装版本号。这对社区的插件和组件来说非常有用,你可以根据不同的版本号采取不同的策略。

用法:

var version = Number(Vue.version.split('.')[0])

if (version === 2) { // Vue v2.x.x } else if (version === 1) { // Vue v1.x.x } else { // Unsupported versions of Vue }