This is a jQuery plugin template. We use this template to quickly create our own plugins, which have a standard interface, and several standardised methods like 'options' to set the plugin options on the fly.
Here is the simplest possible implementation:
$('.selector').plugintemplate();
Here is some basic html you might use for your plugin:
<div></div>
| Property | Default | Description |
|---|---|---|
| conf1 | default | A configuration option. |
You can use this option to configure the plugin.
$('.selector').plugintemplate({'conf1':'option'});
You should change this example to something relevant for your plugin.
| Event | Parameters | Details |
|---|---|---|
| event1 | Event, Index, Element | An event that will be triggered when the plugin does something. |
This event will be triggered by the plugin.
$('.selector').plugintemplate().bind('event1',function( event, index, heading ){
/* Do something */
});
You should change this example to something relevant for your plugin.
| Method | Return Value | Description |
|---|---|---|
| .list( 'option', [ Object ] ) .list( 'option', [ String, String ] ) | jQuery String | Takes a config object, or config string/value and applies the configuration option to the calendar. |
| .list( 'version', [ Object ] ) | String | Returns the version number of the currently installed list plugin. |
| .list( 'destroy' ) | jQuery | Removes the list from the targeted element, and returns the element to its pre-initialisation state. |
This plugin has been tested, and verified working in the following browsers with JavaScript enabled.