plugin template

plugin.coffee

do ($ = jQuery) ->
  plugin_name = 'pluginName'
  data_index = "#{plugin_name}.instance"

  # Example:
  #
  #   $.
  $[plugin_name] = class PluginClassName
    @init: ->
      $('[data-plugin-selector]')[plugin_name]()
      
    @liveClick: (event) ->
      $(@)[plugin_name] 'someAction'

    constructor: (@element, @options = {}) ->
      # ...
      @bind()

    bind: ->
      @element.click (event) =>
        @action()

  $.fn[plugin_name] = (action, options) ->
    if typeof action is 'object'
      options = action
      action = null
    @each ->
      $this = $ @
      unless instance = $this.data data_index
        instance = new $[plugin_name] $this, options
        $this.data data_index, instance
      instance[action](options) if action

  # To init once. For plugins, that should start working on page load.
  $ -> $[plugin_name].init() unless $[plugin_name].skipAutoinit
  # $(window).on 'load', -> $[plugin_name].init() unless $[plugin_name].skipAutoinit

  # and/or
  # Lazy load on some action
  $(document).on 'click', '[data-plugin-selector]', $[plugin_name].liveClick