CODEWITHSUNDEEP
jquerydefault
user582065
user582065

Reputation: 337

JQuery Plugin Defaults and Options

How can I turn the following properties / variables in my plugin into defaults and options that can be set from document ready?

// plugin js:

(function($){
   $.fn.myPlugin = function(options){
      var myForm = this;
      myForm.variable1 = true;
      myForm.variable2 = true;
      myForm.variable3 = true;
      myForm.variable4 = true;

      ...

      if(myForm.variable1){
         // do something
      }

      ...
   }
})(jQuery);

// document ready in page:

<script type="text/javascript">
   $(document).ready(function() {
      $('#form1').myPlugin();
   });
</script>

Upvotes: 8

Views: 12954

Answers (2)

Sinetheta
Sinetheta

Reputation: 9449

The simplest pattern is to extend a default options object. But it does mean that any parameters have to be passed together as an "option" object, eg: myPlugin({variable2:false})

(function($){
   $.fn.myPlugin = function(options){

      var defaults = {
          variable1 : true,
          variable2 : true,
          variable3 : true,
          variable4 : true
      }

      var settings = $.extend({}, defaults, options);
      ...

      if(settings.variable1){
         // do something
      }

      ...
   }
})(jQuery);

Upvotes: 20

Brij
Brij

Reputation: 6122

See following:

$('#form1').myPlugin({variable1 : true, variable2: false....});

and use

(function($){
   $.fn.myPlugin = function(options){

     options.variable1 = true;
          options.variable2 = true;
          options.variable3 = true;
          options.variable4 = true;
  }
})(jQuery);

For proper way see

http://jquery-howto.blogspot.com/2009/01/how-to-set-default-settings-in-your.html

Upvotes: 0

Related Questions