UserDocs01

Documentation

This document is designed to help you to deploy and configure version 0.1.x of the widget.

Compatibility

Because of the plugin is build on top of jQuery library, it follows the same browser compatibility.

As jQueryUI widget, it also follows [jQueryUI development guidelines] (http://jqueryui.com/docs/Developer_Guide) and can be graphically customized as described in [jQueryUI theming guide] (http://jqueryui.com/docs/Theming).

Set/get options

The widget can be customized by passing option values directly during initialization, in the following way:

// Initialize
$( '#tree' ).tree({
    collapseDuration: 200,
    expandDuration: 200,
    ...
});

Alternatively, options value can be get/set after initialization in the following way:

// get
var collapseDuration = $( '#tree' ).widget( 'option', 'collapseDuration' );
// set
$( '#tree' ).widget( 'option', 'collapseDuration', 300 );

Handle events

Events can be handled suppling a callback function as an init option:

$( "#tree" ).tree({
    collapse: function(event, ui) { ... }
});

Alternatively, you can bind to the event by type: checkboxtree + eventName as follow:

$( "#tree" ).bind( "treecollapse", function(event, ui) {
    
});

Theming

The plugin uses the jQuery UI CSS Framework to style its look and feel, so you can use the ThemeRoller tool to create and download custom themes that are easy to build and maintain.