Vue.js Benutzerdefinierte Direktiven

Zusätzlich zu den standardmäßig festgelegten Kern-Direktiven (v-model und v-show) erlaubt Vue auch das Registrieren benutzerdefinierter Direktiven.

Im Folgenden registrieren wir eine globale Direktive v-focus, die bewirkt, dass das Element den Fokus erhält, wenn die Seite geladen wird:

Beispiel

<div id="app"> <p>Wenn die Seite geladen wird, erhält das input-Element automatisch den Fokus:</p> <input v-focus> </div> <script>// Registriere eine globale benutzerdefinierte Direktive v-focus Vue.directive('focus', { // Wird aufgerufen, wenn das gebundene Element in das DOM eingefügt wird. inserted: function (el) { // Fokussiere das Element el.focus() } }) // Erstelle die Root-Instanz new Vue({ el: '#app' })</script>

Selbst ausprobieren »

Wir können auch die Option directives in der Instanz verwenden, um lokale Direktiven zu registrieren, sodass die Direktive nur in dieser Instanz verwendet werden kann:

Beispiel

<div id="app"> <p>Wenn die Seite geladen wird, erhält das input-Element automatisch den Fokus:</p> <input v-focus> </div> <script>// Erstelle die Root-Instanz new Vue({ el: '#app', directives: { // Registriere eine lokale benutzerdefinierte Direktive v-focus focus: { // Definition der Direktive inserted: function (el) { // Fokussiere das Element el.focus() } } } })</script>

Selbst ausprobieren »

Hooks

Hook-Funktionen

Die Definitionsfunktion der Direktive stellt mehrere Hook-Funktionen bereit (optional):

  • bindWird nur einmal aufgerufen, wenn die Direktive erstmals an das Element gebunden wird. Diese Hook-Funktion kann verwendet werden, um eine Initialisierungsaktion zu definieren, die einmal beim Binden ausgeführt wird.

  • insertedWird aufgerufen, wenn das gebundene Element in seinen übergeordneten Knoten eingefügt wird (es muss nur im übergeordneten Knoten vorhanden sein, nicht unbedingt im Dokument).

  • updateWird aufgerufen, wenn das Template, das das gebundene Element enthält, aktualisiert wird, unabhängig davon, ob sich der Bindungswert ändert. Durch den Vergleich des Bindungswerts vor und nach der Aktualisierung können unnötige Template-Aktualisierungen ignoriert werden (siehe unten für detaillierte Parameter der Hook-Funktion).

  • componentUpdatedWird aufgerufen, wenn das Template, das das gebundene Element enthält, einen Aktualisierungszyklus abgeschlossen hat.

  • unbindWird nur einmal aufgerufen, wenn die Direktive vom Element gelöst wird.

Parameter der Hook-Funktion

Die Parameter der Hook-Funktion sind:

  • elDas an die Direktive gebundene Element, das verwendet werden kann, um das DOM direkt zu manipulieren.
  • bindingEin Objekt mit den folgenden Eigenschaften:
    • nameDer Name der Direktive, ohnev-das Präfix.
    • valueDer Bindungswert der Direktive, zum Beispiel:v-my-directive="1 + 1"der Wert von value ist2。
    • oldValueDer vorherige, von der Direktive gebundene Wert, nur verfügbar inupdateundcomponentUpdateddem Hook. Er ist verfügbar, unabhängig davon, ob sich der Wert ändert.
    • expressionDer Ausdruck oder Variablenname des Bindungswerts. Zum Beispielv-my-directive="1 + 1"der Wert von expression ist"1 + 1"。
    • argDas an die Direktive übergebene Argument. Zum Beispielv-my-directive:fooder Wert von arg ist"foo"。
    • modifiersEin Objekt, das Modifikatoren enthält. Zum Beispiel:v-my-directive.foo.barder Wert des modifiers-Objekts ist{ foo: true, bar: true }。
  • vnodeDer von der Vue-Kompilierung generierte virtuelle Knoten.
  • oldVnodeDer vorherige virtuelle Knoten, nur verfügbar inupdateundcomponentUpdateddem Hook.

Das folgende Beispiel demonstriert die Verwendung dieser Parameter:

Beispiel

<div id="app" v-example:hello.a.b="message"> </div> <script> Vue.directive('example', { bind: function (el, binding, vnode) { var s = JSON.stringify el.innerHTML = 'name: ' + s(binding.name) + '<br>' + 'Wert: ' + s(binding.value) + '<br>' + 'Ausdruck: ' + s(binding.expression) + '<br>' + 'Argument: ' + s(binding.arg) + '<br>' + 'Modifikatoren: ' + s(binding.modifiers) + '<br>' + 'VNode-Schlüssel: ' + Object.keys(vnode).join(', ') } }) new Vue({ el: '#app', data: { message: 'Beispiel!' } })</script>

Selbst ausprobieren »

Manchmal benötigen wir keine anderen Hook-Funktionen, und wir können die Kurzform der Funktion verwenden, wie folgt:

Vue.directive('example', function (el, binding) {
  // 设置指令的背景颜色
  el.style.backgroundColor = binding.value.color
})

Direktivenfunktionen können alle gültigen JavaScript-Ausdrücke akzeptieren. Das folgende Beispiel übergibt ein JavaScript-Objekt:

Beispiel

<div id="app"> <div v-example="{ color: 'green', text: 'Example!' }"></div> </div> <script>Vue.directive('example', function (el, binding) { // Use shorthand to set text and background color el.innerHTML = binding.value.text el.style.backgroundColor = binding.value.color }) new Vue({ el: '#app' })</script>

Selbst ausprobieren »
Andere Erweiterungen