Пользовательские директивы

Помимо встроенных директив (таких как v-model и v-show), Vue позволяет использовать ваши собственные. При этом важно понимать, что основным механизмом создания повторно используемого кода во Vue всё-таки являются компоненты. Тем не менее, для выполнения низкоуровневых операций с DOM пользовательские директивы могут очень пригодиться. В качестве примера реализуем фокус на элементе input:

После загрузки страницы этот элемент получает фокус ввода (примечание: autofocus не работает на мобильном Safari). Если вы никуда не кликнули с момента открытия этой главы руководства, фокус ввода и сейчас должен быть на этом элементе. Рассмотрим директиву подробнее:

// Регистрируем глобальную пользовательскую директиву `v-focus`
Vue.directive('focus', {
  // Когда привязанный элемент вставлен в DOM...
  inserted: function (el) {
    // Переключаем фокус на элемент
    el.focus()
  }
})

Чтобы зарегистрировать директиву локально, можно передать опцию directives при определении компонента:

directives: {
  focus: {
    // определение директивы
    inserted: function (el) {
      el.focus()
    }
  }
}

Теперь в шаблонах можно использовать новый атрибут v-focus:

<input v-focus>

Хуки

Для жизненного цикла директивы можно указать следующие хуки (все они опциональны):

• bind: вызывается однократно, при первичном связывании директивы с элементом. Здесь можно поместить код инициализации.
• inserted: вызывается после вставки связанного элемента внутрь элемента родителя (заметьте, что сам родитель может на этот момент и не принадлежать ещё основному дереву элементов).
• update: вызывается после обновления VNode компонента-контейнера, но, возможно, до обновления дочерних элементов. Значение директивы к этому моменту может измениться, а может и нет. Сравнивая текущее и прошлое значения, вы можете избежать избыточных операций .
• componentUpdated: вызывается после обновления как VNode компонента-контейнера, так и VNode его потомков.
• unbind: вызывается однократно, при отвязывании директивы от элемента.

Аргументы хуков

В хуки передаются следующие параметры:

• el: Элемент, к которому привязана директива. Можно использовать для прямых манипуляций с DOM.
• binding: Объект, содержащий следующие свойства:
  • name: Название директивы, без указания префикса v-.
  • value: Значение, переданное в директиву. Например, для v-my-directive="1 + 1" значением будет 2.
  • oldValue: Предыдущее переданное в директиву значение. Доступно только для хуков update и componentUpdated, и передаётся независимо от того, произошло ли в действительности его изменение.
  • expression: Выражение-строка, переданное в директиву. Например, для v-my-directive="1 + 1" это будет "1 + 1".
  • arg: Аргумент, переданный в директиву, в случае его наличия. Например, для v-my-directive:foo это будет "foo".
  • modifiers: Объект, содержащий модификаторы, если они есть. Например, для v-my-directive.foo.bar, объектом модификаторов будет { foo: true, bar: true }.
• vnode: Виртуальный элемент, созданный компилятором Vue.
• oldVnode: Предыдущий виртуальный элемент, доступный только для хуков update и componentUpdated.

Все аргументы, кроме el, следует понимать как только для чтения и никогда не изменять их. В случае необходимости передать информацию между хуками рекомендуем воспользоваться dataset.

Пример пользовательской директивы, использующей некоторые из описанных возможностей:

<div id="hook-arguments-example" v-demo:foo.a.b="message"></div>

Vue.directive('demo', {
  bind: function (el, binding, vnode) {
    var s = JSON.stringify
    el.innerHTML =
      'name: '       + s(binding.name) + '<br>' +
      'value: '      + s(binding.value) + '<br>' +
      'expression: ' + s(binding.expression) + '<br>' +
      'argument: '   + s(binding.arg) + '<br>' +
      'modifiers: '  + s(binding.modifiers) + '<br>' +
      'vnode keys: ' + Object.keys(vnode).join(', ')
  }
})

new Vue({
  el: '#hook-arguments-example',
  data: {
    message: 'hello!'
  }
})

Сокращённая запись

Часто нам может потребоваться одинаковое поведение на bind и update, а остальные хуки не нужны. В таком случае можно использовать сокращённую запись:

Vue.directive('color-swatch', function (el, binding) {
  el.style.backgroundColor = binding.value
})

Передача объекта данных в директиву

В случае, если директива должна принимать несколько параметров, можно указать объект JavaScript — годится любое валидное выражение, помните?

<div v-demo="{ color: 'white', text: 'hello!' }"></div>

Vue.directive('demo', function (el, binding) {
  console.log(binding.value.color) // => "white"
  console.log(binding.value.text)  // => "hello!"
})