Clique aqui para a documentação da v3.x.

Você está navegando a documentação da v2.x e anterior. Para a v3.x, clique aqui.

API

Configuração Global

Vue.config é um objeto contendo a configuração global do Vue. Você pode modificar suas propriedades listadas abaixo antes de iniciar sua aplicação:

silent

optionMergeStrategies

devtools

errorHandler

warnHandler

Novo em 2.4.0+

ignoredElements

keyCodes

performance

Novo em 2.2.0+

productionTip

Novo em 2.2.0+

Métodos Globais

Vue.extend( options )

Vue.nextTick( [callback, context] )

Vue.set( target, propertyName/index, value )

Vue.delete( target, propertyName/index )

Vue.directive( id, [definition] )

Vue.filter( id, [definition] )

Vue.component( id, [definition] )

Vue.use( plugin )

Vue.mixin( mixin )

Vue.compile( template )

Vue.observable( object )

Novo em 2.6.0+

Vue.version

Opções / Dados

data

props

propsData

computed

methods

watch

Opções / DOM

el

template

render

renderError

Novo em 2.2.0+

Opções / Ciclo-de-Vida

Todos os gatilhos de ciclo de vida automaticamente possuem seus contextos this vinculados à instância, assim você pode acessar dados, propriedades computadas e métodos. Isso significa que você não deve usar Arrow Function para definir este tipo de método (por exemplo, created: () => this.fetchTodos()). Isto porque arrow functions vinculam o contexto pai, assim this não será a instância Vue como você espera e this.fetchTodos será undefined.

beforeCreate

created

beforeMount

mounted

beforeUpdate

updated

activated

deactivated

beforeDestroy

destroyed

Este gatilho não é invocado em Renderização no Lado do Servidor.

errorCaptured

Novo em 2.5.0+

Opções / Recursos

directives

filters

components

Opções / Composição

parent

mixins

extends

provide / inject

Novo em 2.2.0+

Opções / Diversos

name

delimiters

functional

model

Novo em 2.2.0

inheritAttrs

Novo em 2.4.0+

comments

Novo em 2.4.0+

Propriedades de Instância

vm.$data

vm.$props

Novo em 2.2.0+

vm.$el

vm.$options

vm.$parent

vm.$root

vm.$children

vm.$slots

vm.$scopedSlots

Novo em 2.1.0+

vm.$refs

vm.$isServer

vm.$attrs

Novo em 2.4.0+

vm.$listeners

Novo em 2.4.0+

Contém listeners de eventos v-on (sem os modificadores.native). Isso pode ser passado para um componente interno via v-on="$ listeners" - útil ao criar wrapper transparentes de componentes.

Métodos da Instância / Dados

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

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

vm.$delete( target, propertyName/index )

Métodos da Instância / Eventos

vm.$on( event, callback )

vm.$once( event, callback )

vm.$off( [event, callback] )

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

Métodos da Instância / Ciclo-de-Vida

vm.$mount( [elementOrSelector] )

vm.$forceUpdate()

vm.$nextTick( [callback] )

vm.$destroy()

Diretivas

v-text

v-html

v-show

v-if

v-else

v-else-if

Novo em 2.1.0+

v-for

v-on

v-bind

v-model

v-slot

v-pre

v-cloak

v-once

Atributos Especiais

key

ref

is

slot obsoleto

Prefira v-slot em 2.6.0+.

slot-scope obsoleto

Prefira v-slot em 2.6.0+.

Usado para denotar um elemento ou componente como um slot de escopo. O valor do atributo deve ser uma expressão de JavaScript válida que pode aparecer na posição do argumento de uma assinatura de função. Isso significa que, em ambientes suportados, você também pode usar a desestruturação ES2015 na expressão. Serve como um substituto para scope em 2.5.0+.

Este atributo não suporta ligação dinâmica.

scope removido

Substituído por slot-scope em 2.5.0+. Prefira v-slot em 2.6.0+.

Usado para denotar um elemento <template> como um slot de escopo.

Componentes Integrados

component

transition

transition-group

keep-alive

Os acessórios include e exclude permitem que os componentes sejam armazenados em cache condicionalmente. Ambas as propriedades podem ser uma string delimitada por vírgulas, um RegExp ou uma Array:

<!-- string delimitada por vírgulas -->
<keep-alive include="a,b">
  <component :is="view"></component>
</keep-alive>

<!-- regex (usando `v-bind`) -->
<keep-alive :include="/a|b/">
  <component :is="view"></component>
</keep-alive>

<!-- Array (usando `v-bind`) -->
<keep-alive :include="['a', 'b']">
  <component :is="view"></component>
</keep-alive>

A correspondência é verificada pela primeira vez na opção name do componente, em seguida, pelo nome no registro local (a chave dentro das opções do components pai) se a opção name não estiver disponível. Os componentes anônimos não podem ser comparados.

slot

Interface VNode

Renderização no Lado do Servidor