search
HomeWeb Front-endJS TutorialGood jQuery Plugin Template

This is a well-structured jQuery plugin template. Here's a slightly revised version with improved clarity and some minor adjustments for best practices:

Good jQuery Plugin Template

Key Takeaways

This article presents a robust jQuery plugin template serving as a foundation for building custom jQuery plugins. It comprehensively covers plugin definition, default option setting, option updates, event handling, and state management. The template provides a practical example demonstrating basic plugin creation, option integration, chainability, private/public method implementation, event handling, element access, state preservation, and plugin destruction. The importance of returning the jQuery object for chainability and utilizing jQuery's data() method for state management is highlighted. This template is an excellent starting point for your next jQuery plugin development. A working example can be found at https://www.php.cn/link/a598e7d200bf02558d5534839884b7a3.

jQuery Plugin Template Code

/*!
  jQuery [name] plugin
  @name jquery.[name].js
  @author [author name] ([author email] or @[author twitter])
  @version 1.0
  @date 01/01/2013
  @category jQuery Plugin
  @copyright (c) 2013 [company/person name] ([company/person website])
  @license Licensed under the MIT (http://www.opensource.org/licenses/mit-license.php) license.
*/
(function($) {

  // Default plugin options
  const defaultOptions = {
    myVar1: 1,
    myVar2: 2,
    myVar3: 3,
    resizeDelay: 50,
    // etc...
  };

  // Plugin constructor
  function MyPlugin(element, options) {
    this.element = element;
    this.settings = $.extend({}, defaultOptions, options);
    this.resizeTimer = null;

    this.init();
  }

  // Plugin methods
  MyPlugin.prototype = {
    init: function() {
      // Initialization logic here...
      if (this.settings.autoResize) {
        $(window).on('resize.myPlugin', this.onResize.bind(this));
      }
    },

    update: function(options) {
      $.extend(this.settings, options);
    },

    onResize: function() {
      clearTimeout(this.resizeTimer);
      this.resizeTimer = setTimeout(this.resizeFunc.bind(this), this.settings.resizeDelay);
    },

    resizeFunc: function() {
      // Resize handling logic here...
    },

    destroy: function() {
      clearTimeout(this.resizeTimer);
      $(window).off('resize.myPlugin');
      $(this.element).removeData('myPlugin'); // Remove plugin data
    }
  };


  // jQuery plugin method
  $.fn.myPlugin = function(options) {
    return this.each(function() {
      const $this = $(this);
      let plugin = $this.data('myPlugin');

      if (!plugin) {
        plugin = new MyPlugin(this, options);
        $this.data('myPlugin', plugin);
      } else if (typeof options === 'string' && plugin[options]) {
        //Call a method on the plugin
        plugin[options]();
      } else if (options) {
        plugin.update(options);
      }

      //Ensure chainability
      return this;
    });
  };

}(jQuery));

Improvements:

  • ES6 Syntax: Uses const and let for more modern JavaScript.
  • Constructor Pattern: Uses a constructor function (MyPlugin) for better object-oriented structure.
  • bind() for this: Explicitly binds this context in event handlers to avoid potential issues.
  • Method Chaining: Clearly returns this to maintain chainability.
  • removeData(): Adds removeData() in the destroy method to properly clean up plugin data.
  • Method Calling: Allows calling specific plugin methods (e.g., .myPlugin('destroy'))
  • Clearer Comments: More concise and descriptive comments.
  • Simplified update: Directly extends this.settings.

This revised template is more robust, maintainable, and follows modern JavaScript best practices. Remember to replace the placeholder comments with your actual plugin logic.

The above is the detailed content of Good jQuery Plugin Template. For more information, please follow other related articles on the PHP Chinese website!

Statement
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
Replace String Characters in JavaScriptReplace String Characters in JavaScriptMar 11, 2025 am 12:07 AM

Detailed explanation of JavaScript string replacement method and FAQ This article will explore two ways to replace string characters in JavaScript: internal JavaScript code and internal HTML for web pages. Replace string inside JavaScript code The most direct way is to use the replace() method: str = str.replace("find","replace"); This method replaces only the first match. To replace all matches, use a regular expression and add the global flag g: str = str.replace(/fi

Custom Google Search API Setup TutorialCustom Google Search API Setup TutorialMar 04, 2025 am 01:06 AM

This tutorial shows you how to integrate a custom Google Search API into your blog or website, offering a more refined search experience than standard WordPress theme search functions. It's surprisingly easy! You'll be able to restrict searches to y

Build Your Own AJAX Web ApplicationsBuild Your Own AJAX Web ApplicationsMar 09, 2025 am 12:11 AM

So here you are, ready to learn all about this thing called AJAX. But, what exactly is it? The term AJAX refers to a loose grouping of technologies that are used to create dynamic, interactive web content. The term AJAX, originally coined by Jesse J

Example Colors JSON FileExample Colors JSON FileMar 03, 2025 am 12:35 AM

This article series was rewritten in mid 2017 with up-to-date information and fresh examples. In this JSON example, we will look at how we can store simple values in a file using JSON format. Using the key-value pair notation, we can store any kind

8 Stunning jQuery Page Layout Plugins8 Stunning jQuery Page Layout PluginsMar 06, 2025 am 12:48 AM

Leverage jQuery for Effortless Web Page Layouts: 8 Essential Plugins jQuery simplifies web page layout significantly. This article highlights eight powerful jQuery plugins that streamline the process, particularly useful for manual website creation

What is 'this' in JavaScript?What is 'this' in JavaScript?Mar 04, 2025 am 01:15 AM

Core points This in JavaScript usually refers to an object that "owns" the method, but it depends on how the function is called. When there is no current object, this refers to the global object. In a web browser, it is represented by window. When calling a function, this maintains the global object; but when calling an object constructor or any of its methods, this refers to an instance of the object. You can change the context of this using methods such as call(), apply(), and bind(). These methods call the function using the given this value and parameters. JavaScript is an excellent programming language. A few years ago, this sentence was

Improve Your jQuery Knowledge with the Source ViewerImprove Your jQuery Knowledge with the Source ViewerMar 05, 2025 am 12:54 AM

jQuery is a great JavaScript framework. However, as with any library, sometimes it’s necessary to get under the hood to discover what’s going on. Perhaps it’s because you’re tracing a bug or are just curious about how jQuery achieves a particular UI

10 Mobile Cheat Sheets for Mobile Development10 Mobile Cheat Sheets for Mobile DevelopmentMar 05, 2025 am 12:43 AM

This post compiles helpful cheat sheets, reference guides, quick recipes, and code snippets for Android, Blackberry, and iPhone app development. No developer should be without them! Touch Gesture Reference Guide (PDF) A valuable resource for desig

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
2 weeks agoBy尊渡假赌尊渡假赌尊渡假赌
Repo: How To Revive Teammates
1 months agoBy尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island Adventure: How To Get Giant Seeds
4 weeks agoBy尊渡假赌尊渡假赌尊渡假赌

Hot Tools

SAP NetWeaver Server Adapter for Eclipse

SAP NetWeaver Server Adapter for Eclipse

Integrate Eclipse with SAP NetWeaver application server.

MinGW - Minimalist GNU for Windows

MinGW - Minimalist GNU for Windows

This project is in the process of being migrated to osdn.net/projects/mingw, you can continue to follow us there. MinGW: A native Windows port of the GNU Compiler Collection (GCC), freely distributable import libraries and header files for building native Windows applications; includes extensions to the MSVC runtime to support C99 functionality. All MinGW software can run on 64-bit Windows platforms.

VSCode Windows 64-bit Download

VSCode Windows 64-bit Download

A free and powerful IDE editor launched by Microsoft

MantisBT

MantisBT

Mantis is an easy-to-deploy web-based defect tracking tool designed to aid in product defect tracking. It requires PHP, MySQL and a web server. Check out our demo and hosting services.

mPDF

mPDF

mPDF is a PHP library that can generate PDF files from UTF-8 encoded HTML. The original author, Ian Back, wrote mPDF to output PDF files "on the fly" from his website and handle different languages. It is slower than original scripts like HTML2FPDF and produces larger files when using Unicode fonts, but supports CSS styles etc. and has a lot of enhancements. Supports almost all languages, including RTL (Arabic and Hebrew) and CJK (Chinese, Japanese and Korean). Supports nested block-level elements (such as P, DIV),