cs-jq-plugin-template.coffee

# A class-based template for jQuery plugins in Coffeescript
#
#     $('.target').myPlugin({ paramA: 'not-foo' });
#     $('.target').myPlugin('myMethod', 'Hello, world');
#
# Check out Alan Hogan's original jQuery plugin template:
# https://github.com/alanhogan/Coffeescript-jQuery-Plugin-Template
#
do ($ = window.jQuery, window, document) ->

  pluginName = 'pluginName'

  # Define the plugin class
  class Plugin

    defaults:
      paramA: 'foo'
      paramB: 'bar'

    constructor: (el, options) ->
      @options = $.extend({}, @defaults, options)
      @$el = $(el)
      @init()

    init: ->
      # Place initialization logic here
      # You already have access to the DOM element and the options via the instance,
      # e.g., @element and @settings


    # Additional plugin methods go here
    myMethod: (echo) ->
      @$el.html(@options.paramA + ': ' + echo)

  # Define the plugin
  # A really lightweight plugin wrapper around the constructor,
  # preventing against multiple instantiations
  $.fn[pluginName] = (option, args...) ->
    @each ->
      $this   = $(this)
      data    = $this.data("plugin_#{pluginName}")

      if !data
        $this.data "plugin_#{pluginName}", (data = new Plugin(this, option))
      if typeof option == 'string'
        data[option].apply(data, args)