Close
Cliquez ici pour la documentation v3.x.

You’re browsing the documentation for v2.x and earlier. For v3.x, click here.

Mixins

Bases

Les mixins offrent une manière flexible de créer des fonctionnalités réutilisables pour les composants de Vue. Un objet mixin peut contenir toute option valide pour un composant. Quand un composant utilise un mixin, toutes les options du mixin seront “fusionnées” avec les options du composant.

Exemple:

// définir un objet mixin
var myMixin = {
created: function () {
this.hello()
},
methods: {
hello: function () {
console.log('hello from mixin!')
}
}
}

// définition d'un composant qui utilise ce mixin
var Component = Vue.extend({
mixins: [myMixin]
})

var component = new Component() // => "hello from mixin!"

Fusion des options

Quand un mixin et un composant définissent les mêmes options, elles seront fusionnées en utilisant la stratégie appropriée.

Par exemple, les objets data subissent une fusion recursive, avec les données du composant qui sont prioritaires sur celles du mixin en cas de conflits.

var mixin = {
data: function () {
return {
message: 'bonjour',
foo: 'abc'
}
}
}

new Vue({
mixins: [mixin],
data: function () {
return {
message: 'au revoir',
bar: 'def'
}
},
created: function () {
console.log(this.$data)
// => { message: "au revoir", foo: "abc", bar: "def" }
}
})

Les fonctions de hook avec le même nom seront fusionnées dans un tableau afin qu’elles soient toutes appelées. De plus, les hooks des mixins seront appelés avant les propres hooks du composant.

var mixin = {
created: function () {
console.log('hook appelé du mixin')
}
}

new Vue({
mixins: [mixin],
created: function () {
console.log('hook appelé du composant')
}
})

// => "hook appelé du mixin"
// => "hook appelé du composant"

Les options qui attendent un objet, par exemple methods, components et directives, seront fusionnées dans le même objet. Les options du composant auront la priorité en cas de conflit sur une ou plusieurs clés de ces objets.

var mixin = {
methods: {
foo: function () {
console.log('foo')
},
conflicting: function () {
console.log('du mixin')
}
}
}

var vm = new Vue({
mixins: [mixin],
methods: {
bar: function () {
console.log('bar')
},
conflicting: function () {
console.log('de lui-même')
}
}
})

vm.foo() // => "foo"
vm.bar() // => "bar"
vm.conflicting() // => "de lui-même"

Notez que les mêmes stratégies de fusion sont utilisées par Vue.extend().

Mixin global

Vous pouvez aussi appliquer un mixin de manière globale. À utiliser avec prudence ! Une fois que vous appliquez un mixin globalement, il modifiera toutes les instances de vues créées ensuite. Bien utilisé, cela peut être exploité pour injecter une logique de traitement pour des options personnalisées :

// injection d'une fonction pour l'option personnalisée `myOption`
Vue.mixin({
created: function () {
var myOption = this.$options.myOption
if (myOption) {
console.log(myOption)
}
}
})

new Vue({
myOption: 'bonjour !'
})
// => "bonjour !"

Utilisez les mixins globaux prudemment et rarement, parce qu’ils affectent chacune des Vue créées, y compris celles des librairies tierces. Dans la plupart des cas, vous devriez uniquement vous en servir pour la gestion des options personnalisées comme illustré dans l’exemple ci-dessus. C’est aussi une bonne idée de les encapsuler dans des Plugins pour éviter de les appliquer plusieurs fois par erreur.

Stratégie de fusion des options personnalisées

Quand les options personnalisées sont fusionnées, elles utilisent la stratégie par défaut, qui est simplement d’écraser la valeur existante. Si vous souhaitez appliquer une logique personnalisée pour la fusion d’une option personnalisée, vous devez attacher une nouvelle fonction à Vue.config.optionMergeStrategies:

Vue.config.optionMergeStrategies.myOption = function (toVal, fromVal) {
// return mergedVal
}

Pour la plupart des options qui attendent des objets, vous pouvez simplement utiliser la stratégie de fusion utilisée par methods:

var strategies = Vue.config.optionMergeStrategies
strategies.myOption = strategies.methods

Un exemple plus avancé peut être trouvé dans la stratégie de fusion de Vuex 1.x :

const merge = Vue.config.optionMergeStrategies.computed
Vue.config.optionMergeStrategies.vuex = function (toVal, fromVal) {
if (!toVal) return fromVal
if (!fromVal) return toVal
return {
getters: merge(toVal.getters, fromVal.getters),
state: merge(toVal.state, fromVal.state),
actions: merge(toVal.actions, fromVal.actions)
}
}