Guia
Essenciais
- Instalação
- Introdução
- A Instância Vue
- Sintaxe de Templates
- Dados Computados e Observadores
- Interligações de Classe e Estilo
- Renderização Condicional
- Renderização de Listas
- Manipulação de Eventos
- Interligações em Formulários
- Básico sobre Componentes
Componentes em Detalhes
- Registro de Componentes
- Propriedades
- Eventos Personalizados
- Slots
- Dinâmicos & Assíncronos
- Lidando com Casos Extremos
Transições & Animações
- Transições de Visibilidade e Listas
- Transições de Estado
Reuso & Composição
- Mixins
- Diretivas Personalizadas
- Funções de Renderização & JSX
- Plugins
- Filtros
Ferramentas
- Componentes Single-File
- Testes Unitários
- Testing
- Suporte ao TypeScript
- Publicando em Produção
Escalonando
- Roteamento
- Gerenciamento de Estado
- Renderizando no Lado do Servidor
- Segurança
Internamente
- Reatividade em Profundidade
Migração
- Migração do Vue 1.x
- Migração do Vue Router 0.7.x
- Migração do Vuex 0.6.x para 1.0
Diversos
- Comparação com Outros Frameworks
- Junte-se à Comunidade Vue.js!
- Conheça a Equipe
Você está navegando a documentação da v2.x e anterior. Para a v3.x, clique aqui.
Lidando com Casos Extremos
Esta página assume que você já leu o Básico sobre Componentes. Leia lá primeiro se você for novo com componentes.
Todos os recursos desta página documentam o tratamento de casos extremos, ou seja, situações incomuns que, algumas vezes, requerem que as regras do Vue sejam brevemente contornadas. Entretanto, note que todos eles possuem desvantagens ou podem ser perigosos. Estes detalhes são expostos em cada caso, portanto, lembre-se ao decidir usar cada recurso.
Acesso a Elementos e Componentes
Geralmente, é melhor evitar alcançar outras instâncias de componentes ou manualmente manipular elementos DOM. Entretanto, às vezes pode ser apropriado.
Acessando Instância Raiz
Em cada subcomponente de uma instância new Vue
, a instância raiz pode ser acessada com a propriedade $root
. Por exemplo, nessa instância raiz:
// A instância raiz do Vue
new Vue({
data: {
foo: 1
},
computed: {
bar: function () { /* ... */ }
},
methods: {
baz: function () { /* ... */ }
}
})
Todos os subcomponentes são capazes de acessá-la e usá-la como um store global:
// Recupera dados da raiz
this.$root.foo
// Atribui dados na raiz
this.$root.foo = 2
// Acessa dados computados da raiz
this.$root.bar
// Chama métodos da raiz
this.$root.baz()
Isso pode ser conveniente para demonstrações ou aplicações muito pequenas, com apenas um punhado de componentes. Porém, o padrão não se adapta bem a aplicações de média ou larga escala, de modo que nós recomendamos fortemente a utilização do Vuex para gerenciar o estado, na maioria dos casos.
Acessando Instância do Componente Pai
Semelhantemente a $root
, a propriedade $parent
pode ser utilizada para acessar a instância pai, a partir de um componente filho. Isso é uma alternativa, preguiçosa e tentadora, ao invés de passar os dados via propriedades.
Na maioria dos casos, alcançar o interior dos componentes pais torna sua aplicação muito difícil de depurar e entender, especiamente se você modifica dados no componente pai. Ao olhar para o componente posteriormente, será muito difícil de compreender onde aquela mutação de dados se originou.
Entretanto, há casos, particulamente em bibliotecas compartilhadas, em que isso pode ser apropriado. Por exemplo, componentes abstratos que interagem com APIs JavaScript em vez de renderizarem HTML, como esse componente hipotético do Google Maps:
<google-map>
<google-map-markers v-bind:places="iceCreamShops"></google-map-markers>
</google-map>
O componente <google-map>
pode definir uma propriedade map
que todos os subcomponentes precisam acessar. Neste caso, o componente <google-map-markers>
pode acessar aquele mapa através de algo como this.$parent.getMap
, para poder adicionar alguns marcadores à ela. Você pode conferir esse padrão em ação aqui.
Tenha em mente, no entanto, que componentes construídos com esse padrão são inerentemente frágeis. Por exemplo, imagine que nós adicionaremos um novo componente <google-map-region>
e quando <google-map-markers>
aparecer dentro dele, ele só deve renderizar marcadores que estiverem nessa região:
<google-map>
<google-map-region v-bind:shape="cityBoundaries">
<google-map-markers v-bind:places="iceCreamShops"></google-map-markers>
</google-map-region>
</google-map>
Para solucionar, dentro de <google-map-markers>
você poderá se encontrar confiando em um hack como esse:
var map = this.$parent.map || this.$parent.$parent.map
O que rapidamente foge do controle. É por isso que, para fornecer informação de contexto para os componentes descendentes arbitrariamente profundos, nós recomendamos a injeção de dependência.
Acessando Instâncias de Componentes e Elementos Filhos
Apesar da existência de propriedades e eventos, algumas vezes você ainda pode precisar acessar diretamente um componente filho em JavaScript. Para isso, você pode atribuir um identificador de referência ao componente filho, usando o atributo ref
. Por exemplo:
<base-input ref="usernameInput"></base-input>
Agora, no componente onde você definiu o ref
, você pode usar:
this.$refs.usernameInput
Assim, você acessará a instância <base-input>
. Isso pode ser útil quando quiser, por exemplo, “focar” o input programaticamente a partir do pai. O <base-input>
pode, similarmente, usar ref
para prover acesso a elementos específicos dentro dele, como:
<input ref="input">
E até mesmo definir métodos para serem utilizados pelo pai:
methods: {
// Usado pelo pai para focar o input
focus: function () {
this.$refs.input.focus()
}
}
Permitindo, assim, que o componente pai foque o input dentro de <base-input>
com:
this.$refs.usernameInput.focus()
Quando o ref
for usado junto com v-for
, a referência que você obterá será um Array contendo os componentes filhos, espelhando a fonte de dados.
$refs
são populados somente depois que o componente foi renderizado, e não são reativos. É somente uma escotilha para manipulação direta dos filhos - evite usar $refs
de dentro de templates ou de dados computados.
Injeção de Dependência
Anteriormente, quando descrevemos Acessando Instância do Componente Pai, mostramos um exemplo como esse:
<google-map>
<google-map-region v-bind:shape="cityBoundaries">
<google-map-markers v-bind:places="iceCreamShops"></google-map-markers>
</google-map-region>
</google-map>
Neste componente, todos os descendentes de <google-map>
necessitam do acesso ao método getMap
, para saberem com qual mapa estão interagindo. Infelizmente, usando a propriedade $parent
, não escalaremos muito bem para o caso de vários componentes profundamente aninhados. É aí que a injeção de dependência pode ser útil, usando duas novas opções da instância: provide
e inject
.
A opção provide
permite especificar quais dados/métodos queremos prover para os componentes descendentes. Neste caso, o método getMap
de <google-map>
:
provide: function () {
return {
getMap: this.getMap
}
}
Então em qualquer descendente, podemos usar a opção inject
para receber as propriedades específicas que desejamos adicionar à instância:
inject: ['getMap']
Você pode ver o exemplo completo. A vantagem neste caso, em contraste com a utilização do $parent
, é que podemos acessar getMap
em qualquer componente descendente, sem expor a instância inteira do <google-map>
. Isso nos permite continuar o desenvolvimento desse componente com mais segurança, sem medo de que acabemos por alterar/remover algo que o componente filho esteja esperando. A interface entre esses componentes permanece claramente definida, assim como quando usamos props
.
Na verdade, você pode pensar sobre a injeção de dependência como uma espécie de “propriedade de longo alcance”, exceto por:
- ancestrais não precisarem saber quais descendentes usam a propriedade
- descendentes não precisarem saber de onde as propriedades injetadas vieram
Entretanto, existem desvantagens na injeção de dependência. Ela associa os componentes de sua aplicação conforme estão organizados atualmente, tornando a refatoração mais difícil. Propriedades providas pelos componentes pais também não são reativas. Isso ocorre propositalmente, pois usá-las para criar um store de dados central fará sua aplicação escalar tão mal quanto usando $root
para o mesmo propósito. Se as propriedades que você deseja compartilhar são específicas para sua aplicação, em vez de genéricas, ou se você deseja sempre atualizar os dados providos dentro de componentes ancestrais, então é um bom sinal que você provavelmente precisa de uma solução real de gerenciamento de estado, como o Vuex.
Aprenda mais sobre injeção de dependência na documentação da API.
Escuta de Eventos Programática
Até então, você viu usos do $emit
e escutou eventos com o v-on
, porém instâncias Vue também oferecem outros métodos em sua interface de eventos. Nós podemos:
- Escutar um evento com
$on(eventName, eventHandler)
- Escutar um evento, uma única vez, com
$once(eventName, eventHandler)
- Deixar de escutar um evento com
$off(eventName, eventHandler)
Normalmente, você não terá que usar nenhum desses métodos, porém eles estão disponíveis para casos em que você precise escutar, manualmente, eventos na instância de um componente. Eles também podem ser úteis como uma ferramenta para organização de código. Por exemplo, você pode notar frequentemente o padrão abaixo para integração com uma biblioteca de terceiros:
// Anexe o datepicker ao input uma única vez
// que ele estiver montado no DOM.
mounted: function () {
// Pikaday é uma biblioteca datepicker de terceiros
this.picker = new Pikaday({
field: this.$refs.input,
format: 'YYYY-MM-DD'
})
},
// Imediatamente antes do componente ser destruído,
// garante que o datepicker também o seja.
beforeDestroy: function () {
this.picker.destroy()
}
Essa abordagem traz dois problemas em potencial:
- Demanda que o
picker
seja salvo na instância do componente, enquanto é possível que somente os gatilhos de ciclos de vida precisem acessá-lo. Não se trata de uma abordagem terrível, mas pode ser considerada confusa. - Nosso código de configuração ou setup é mantido separado do nosso código de limpeza, fazendo com que seja mais difícil de, programaticamente, limpar qualquer coisa que tenhamos configurado.
Pode-se resolver ambos os problemas com uma escuta de eventos programática:
mounted: function () {
var picker = new Pikaday({
field: this.$refs.input,
format: 'YYYY-MM-DD'
})
this.$once('hook:beforeDestroy', function () {
picker.destroy()
})
}
Usando essa estratégia, podemos até mesmo usar o Pickaday com vários elementos input, com cada nova instância automaticamente se registrando para limpeza.
mounted: function () {
this.attachDatepicker('startDateInput')
this.attachDatepicker('endDateInput')
},
methods: {
attachDatepicker: function (refName) {
var picker = new Pikaday({
field: this.$refs[refName],
format: 'YYYY-MM-DD'
})
this.$once('hook:beforeDestroy', function () {
picker.destroy()
})
}
}
Veja este Sandbox com o código completo. Entretanto, note que, caso esteja precisando fazer muito setup e limpeza em um único componente, a melhor solução será, usualmente, criar componentes mais modulares. Neste caso, recomendaríamos criar um componente <input-datepicker>
reutilizável.
Para aprender mais sobre escutas de eventos programáticas, dê uma conferida na API de Métodos de Instância de Eventos.
Observe que o sistema de eventos do Vue é diferente do sistema utilizado pelo navegador, a API EventTarget. Embora eles funcionem de modo semelhante, $emit
, $on
e $off
não são apelidos para dispatchEvent
, addEventListener
e removeEventListener
.
Referências Circulares
Componentes Recursivos
Componentes podem invocar a si mesmos recursivamente, em seu próprio template
. Todavia, eles só podem fazer isso com a opção name
:
name: 'unique-name-of-my-component'
Quando se registra um componente globalmente com Vue.component
, o identificador global é automaticamente configurado como a opção name
.
Vue.component('unique-name-of-my-component', {
// ...
})
Se você não for cuidadoso, componentes recursivos também podem levar a loops infinitos de renderização:
name: 'stack-overflow',
template: '<div><stack-overflow></stack-overflow></div>'
Um componente como o mostrado acima resultará e um erro “max stack size exceeded”, então garanta que a invocação recursiva é condicional (ou seja, sempre tenha um v-if
que virá a ser, eventualmente, false
).
Entre Componentes
Digamos que você está construindo uma árvore de diretórios de arquivos, como em um Finder ou Explorer. Você pode ter um componente tree-folder
com este template:
<p>
<span>{{ folder.name }}</span>
<tree-folder-contents :children="folder.children"/>
</p>
Então, um componente tree-folder-contents
, com este template:
<ul>
<li v-for="child in children">
<tree-folder v-if="child.children" :folder="child"/>
<span v-else>{{ child.name }}</span>
</li>
</ul>
Quando se olha mais de perto, observa-se que tais componentes serão, na verdade, descendente e ancestral um do outro na árvore de renderização - um paradóxo! Quando for registrar esses componentes globalmente com Vue.component
, tal paradóxo será resolvido automaticamente. Se este é o seu caso, você pode parar sua leitura aqui.
Todavia, se você está usando require/import
de componentes com um sistema de módulos, como Webpack ou Browserify, irá se deparar com um erro:
Failed to mount component: template or render function not defined.
Para explicar o que ocorre, vamos chamar nossos componentes de A e B. O sistema de módulos observa que precisa de A, mas primeiro precisa de B, mas B precisa de A, mas A precisa de B, etc. Ele fica preso neste loop, sem saber como resolver um componente sem antes resolver o outro. Para que isso seja corrigido, precisamos dar ao sistema de módulos um ponto no qual ele possa dizer, “A precisa de B eventualmente, mas não há necessidade de resolver B primeiro”.
No nosso caso, vamos construir esse ponto no componente tree-folder
. Sabemos que o componente filho que cria o paradóxo é o tree-folder-contents
, então vamos esperar até que o gatilho de ciclo de vida beforeCreate
registre-o:
beforeCreate: function () {
this.$options.components.TreeFolderContents = require('./tree-folder-contents.vue').default
}
Ou, alternativamente, poderia utilizar o import
assíncrono do Webpack, quando registra seu componente localmente:
components: {
TreeFolderContents: () => import('./tree-folder-contents.vue')
}
Problema resolvido!
Definições de Template Alternativas
Templates Inline
Quando o atributo especial inline-template
estiver presente em um componente filho, o componente irá utilizar seu próprio conteúdo interno como template, ao invés de tratá-lo como conteúdo distribuído. Isso permite uma autoria de template mais flexível.
<my-component inline-template>
<div>
<p>Estes são compilados como template do próprio componente.</p>
<p>E não transclusão de conteúdo do pai.</p>
</div>
</my-component>
Seu template inline precisa ser definido dentro do elemento DOM ao qual o Vue está conectado.
Todavia, a utilização do inline-template
faz com que o escopo do seu template seja mais difícil de entender. Como uma boa prática, prefira definir templates dentro do componente usando a opção template
, ou em um elemento <template>
em um arquivo .vue
X-Templates
Uma outra forma de definir templates é dentro de elementos script com tipo text/x-template
, e então referenciando o template através de um id
. Exemplo:
<script type="text/x-template" id="hello-world-template">
<p>Olá olá olá</p>
</script>
Vue.component('hello-world', {
template: '#hello-world-template'
})
Seu x-template precisa ser definido fora do elemento DOM ao qual o Vue está conectado.
Eles podem ser úteis para demonstrações com templates maiores ou em aplicações extremamente pequenas, porém devem ser evitados em todos os outros casos, pois separam os templates do resto da definição do componente.
Controlando Atualizações
Graças ao sistema de reatividade do Vue, ele sempre sabe quando atualizar a interface (se você utilizá-lo corretamente). Há casos incomuns, porém, em que você pode querer forçar uma atualização, apesar do fato de nenhum dado reativo ter mudado. Além disso, há os casos em que você pode querer prevenir atualizações desnecessárias.
Forçando uma Atualização
Se você se encontrar na situação de precisar forçar uma atualização no Vue, em 99,99% dos casos, você cometeu algum erro em algum lugar.
Você pode não ter levado em consideração as ressalvas na detecção de mudanças com Arrays ou objetos, ou você pode estar contando com um estado que não é monitorado pelo sistema de reatividade do Vue, por exemplo, com data
.
Todavia, se você descartou o exposto e ainda se encontra na situação extremamente rara de ter de manualmente forçar atualização, pode fazer isso com $forceUpdate
.
Componentes Estáticos Econômicos com v-once
Renderizar elementos HTML puros é bem rápido no Vue mas, algumas vezes, você pode ter um componente que possui uma grande quantidade de conteúdo estático. Nesses casos, você pode assegurar que ele é avaliado somente uma vez e então colocado em cache, adicionando a diretiva v-once
ao elemento raiz, como mostrado abaixo:
Vue.component('terms-of-service', {
template: `
<div v-once>
<h1>Termos de serviço</h1>
... uma enorme quantidade de conteúdo estático ...
</div>
`
})
Como de costume, tente não abusar deste padrão. Embora conveniente nos raros casos em que você tem de renderizar muito conteúdo estático, ele é simplesmente desnecessário a não ser que você tenha de fato notado uma renderização lenta – além disso, ele poderia levar a confusões futuras. Por exemplo, imagine um outro desenvolvedor que não é familiarizado com o v-once
ou simplesmente não o nota no template. Ele pode vir a perder horas tentando entender o porquê de o template não estar sendo atualizado.