创建一个插件，公开事件

Question

如何向我的插件用户公开事件？

---

我知道我应该使用：

$('#myPluginDiv').trigger('eventName', ["foo", "bar"]);

来触发事件，但我正在寻找描述如何在插件中声明和调用事件的最佳实践。

Answer 1

我认为您可以检查一些最常用的插件并做出自己的假设。我们对此没有标准，只有代码约定。

Colorbox（来源：https://github.com/jackmoore/colorbox/blob /master/jquery.colorbox.js) 定义事件名称的前缀和一些常量。它还具有用于触发和运行回调的功能。

jQuery UI（来源：https://github.com/jquery.ui.widget.js" com/jquery/jquery-ui/blob/master/ui/jquery.ui.widget.js）在小部件类上也有一个用于触发事件的通用函数（用法：https://github.com/jquery/jquery-ui/blob/master/ui/ jquery.ui.dialog.js），但您可以看到事件被硬编码在源的中间，而不是像 Colorbox 上那样将常量编码在顶部。

我个人认为，如果您有很多事件要触发，那么创建常量会更好，并且在我自己的插件中这样做，但如果您只触发 2 或 3 个事件，则没有必要。

辅助函数是必须具备的，并且应该是模板的一部分。

我使用和看到的事件名称都遵循标准CamelCase，例如beforeClose。

有些人提倡对 Colorbox 的 cbox_open 甚至 click.myPlugin 等事件使用前缀（请参阅：http://api.jquery.com/on/#event-names)

结论：尝试遵循一般编程的最佳实践和约定，并注意那里有更好的例子。

Answer 2

在插件中创建对象文字，例如

var plugin = {
  show:function(){
// code for show()
}


};