使用jQuery插件及其依赖项的指南

时间:2009-08-11 22:48:06

标签: jquery plugins dependency-management directory

jQuery插件通常依赖于外部文件:jQuery库,样式表(CSS),图像,其他插件等。使用(和编写)jQuery插件可以解决依赖关系放置的指导原则是什么?换句话说,所需文件应该放在哪里:在主应用程序文件夹(Img,Css,JS或您使用的任何文件夹)下,在插件文件夹下(例如插件/ MyPlugin / Img,插件/ MyPlugin / Css等),或其他什么?

在为项目添加了几个插件之后,我担心其他项目成员将很难确定需要哪些依赖项以及哪些文件应该放在哪里。

什么有效,哪些不适合你?

1 个答案:

答案 0 :(得分:6)

就个人而言,当我构建一个插件时,我会尝试尽可能少地依赖其他资源来避免这个问题。有时您无法避免使用外部样式表,在这种情况下,我总是将它们与其他CSS文件一起使用,即使它们最初包含在与插件相同的文件夹中。这样可以避免在尝试确定哪些样式表应该去哪里时出现任何歧义。无论如何,您将手动包含它们。如果插件有任何依赖关系,它们会进入JS文件夹,其组织方式与其他插件类似。在这种情况下,图像将与所有其他图像一起使用。

在构建插件时,您可以通过允许用户定义应用于某些对象的类,或让用户定义插件将操作的结构来使其更灵活。所有这一切都可以完成,同时为其提供一组良好的默认值,同时尽可能少地依赖外部资源。

至于是否为这些情况定义了最佳做法,我还没有找到。我只在jQuery网站上找到了插件创作指南:http://docs.jquery.com/Plugins/Authoring

修改

关于插件依赖组织的说明:

当你说你有jquery.x.js和jquery.y.js时。它们都依赖于jquery.z.js。我总是将jquery.z.js放在与jquery.x.js和jquery.y.js相同的文件夹中。这避免了重复以及与违反组织惯例相关的任何混淆。所以:

  • ./ jquery.x.js
  • ./ jquery.y.js
  • ./ jquery.z.js

我通常会组织我的文件夹:

  • ./ JS / jQuery的x.x.x.js
  • ./ JS /插件/ jquery.x.js
  • ./ JS /插件/ jquery.y.js
  • ./ JS /插件/ jquery.z.js