Vue.js - 从指令发出事件

Question

是否有可能从与该指令被附着在组件的指令发出一个自定义事件。

我期待它像示例中描述的那样工作，但事实并非如此。

示例：

//Basic Directive
<script>
  Vue.directive('foo', {
    bind(el, binding, vnode) {
      setTimeout(() => {
        //vnode.context.$emit('bar'); <- this will trigger in parent
        vnode.$emit('bar');
      }, 3000);
    }
  });
</script>


//Basic Component
<template>
  <button v-foo @bar="change">{{label}}</button>
</template>
<script>
  export default{
    data() {
      return {
        label: 'i dont work'
      }
    },
    methods: {
      change() {
        this.label = 'I DO WORK!';
      }
    }
  }
</script>

关于此事的任何想法？ 我错过了什么吗？

JSFiddle： https ://jsfiddle.net/0aum3osq/4/

更新 1：

好的，我发现如果我调用vnode.data.on.bar.fn(); （或最新 Vue 版本中的fns() ）在指令中它会触发bar事件处理程序。

更新 2：

临时解决方案：

  /*temp. solution*/
  var emit = (vnode, name, data) => {
    var handlers = vnode.data.on;

    if (handlers && handlers.hasOwnProperty(name)) {
      var handler = handlers[name];
      var fn = handler.fns || handler.fn;

      if (typeof fn === 'function') {
        fn(data);
      }
    }
  } 

//Basic Directive
<script>
  Vue.directive('foo', {
    bind(el, binding, vnode) {
      setTimeout(() => {
        emit(vnode, 'bar');
      }, 3000);
    }
  });
</script>

Answer 1

所以我在 Vue 2+ 中使用的解决方案（考虑到目前还没有答案）：

在指令添加方法中：

var emit = (vnode, name, data) => {
  var handlers = (vnode.data && vnode.data.on) ||
    (vnode.componentOptions && vnode.componentOptions.listeners);

  if (handlers && handlers[name]) {
    handlers[name].fns(data);
  }
}

并这样称呼它：

bind(el, binding, vnode) {
  emit(vnode, 'bar' , {some: 'event', data: 'here'});
}

一种方法的好处：

1 在您的项目中保持相同的代码风格，这意味着每个处理程序都可以声明为
v-on:handler_name并以有意义的（对于开发人员）方式处理。 其他解决方案，例如将回调作为参数发送，如果不深入研究文档/代码，有时会令人困惑且不明显。

2 使用内置事件系统还可以优雅地处理事件对象。 例如，此代码将完美运行：

<button v-foo @bar="bar(1, $event, 2)">{{label}}</button>
...
methods: {
  bar(one, event, two) { console.log(one, event, two); }
} 

---

编辑：

在 v2.1+ 中，您可以在指令绑定中使用它：

vnode.context.$emit(eventname)

Answer 2

您的解决方案对我不起作用。 事实上 vnode.data.on 总是未定义的

触发事件的方法是

 vnode.child.$emit('myevent');

希望这会有所帮助。

Answer 3

我知道这是一个老问题，但是如果有人对此有问题并且无法正常工作。 您可以使用 javascript 自定义事件事件。

    vue.directive('click',{bind(el, binding, vnode) {
        el.addEventListener('click', (e)=>{
            const event = new CustomEvent('customevent', {detail: {
                                                          custom: "data", 
                                                          can: "be", 
                                                          in: "detail property"}, bubbles: true});
            el.dispatchEvent(event);
        })
    }
})

现在我可以像这样使用它

<div v-click @customevent="func">hello world</div>

我不必设置$event因为默认值是作为最后一个参数发出的标准。 这个事件有一个detail属性，在这种情况下它包含你的自定义数据这个对象：

{custom: "data", 
 can: "be", 
 in: "detail property"}

源代码https://github.com/vuejs/vue/issues/7147

Answer 4

上面的答案很好，但其中一些已经过时了。 这是我通过将它们集成到一个可行的 POC 中来解决问题的方法。

// src/directives/ClickOutside.js
export default {
  stopProp(e) {
    e.stopPropagation();
  },
  bind(el, binding, vnode) {
    el._clickOutside = e => {
      vnode.context.$emit(binding.expression, e);
    };
    el.addEventListener('click', binding.def.stopProp);
    document.body.addEventListener('click', el._clickOutside);
  },
  unbind() {
    if (!el._clickOutside) {
      return;
    }
    el.removeEventListener('click', binding.def.stopProp);
    document.body.removeEventListener('click', el._clickOutside);
    delete el._clickOutside;
  }
};

// src/directives/index.js
import Vue from 'vue';
import ClickOutside from './ClickOutside';

Vue.directive('ClickOutside', ClickOutside);

在 main.js 中导入指令：

// src/main.js
import './directives';

使用指令来监听 Vue 组件中的事件发射：

// src/components/Component.vue
<template>
  <!-- Please fill in sensible context. This example doesn't really care about the DOM presentation -->
  <div @click="showElement" v-click-outside="hideElement">
    <div v-if="shouldShow">Hello</div>
  </div>
</template>

<script>
export default {
  data() {
    return {
      shouldShow: true
    };
  },
  mounted() {
    this.$on('hideElement', this.hideElement);
  },
  destroyed() {
    this.$off('hideElement', this.hideElement);
  },
  methods: {
    showElement() {
      this.shouldShow = true;
    },
    hideElement() {
      this.shouldShow = false;
    }
  }
};
</script>

基本上，在vnode.context.$emit ，该binding.expression是字符串（即，在这个例子中“hideElement”），你在宣布v-close-outside 。 要从指令中检索发射，请使用this.$on('hideElement')来收听它。

Answer 5

您可以发出自定义本机 javascript 事件。 使用 node.dispatchEvent 创建一个从节点调度事件的指令

let handleOutsideClick;
Vue.directive('out-click', {
    bind (el, binding, vnode) {

        handleOutsideClick = (e) => {
            e.stopPropagation()
            const handler = binding.value

            if (el.contains(e.target)) {
                el.dispatchEvent(new Event('out-click')) <-- HERE
            }
        }

        document.addEventListener('click', handleOutsideClick)
        document.addEventListener('touchstart', handleOutsideClick)
    },
    unbind () {
        document.removeEventListener('click', handleOutsideClick)
        document.removeEventListener('touchstart', handleOutsideClick)
    }
})

哪个可以这样使用

h3( v-out-click @click="$emit('show')" @out-click="$emit('hide')" )

Answer 6

最简单的方法就是像这样在el上使用 dispatchEvent

el.dispatchEvent(new Event('change'));

Answer 7

@euvl 的解决方案很好，但我认为将函数作为参数传递给指令更容易、更清晰。 似乎也简化了指令的接口。

<script>
  Vue.directive('foo', {
    bind(el, binding) {
      setTimeout(() => {
        binding.value();
      }, 3000);
    }
  });
</script>

<template>
  <button v-foo="change">{{label}}</button>
</template>

<script>
  export default{
    data() {
      return {
        label: 'i dont work'
      }
    },
    methods: {
      change() {
        this.label = 'I DO WORK!';
      }
    }
  }
</script>