API Reference

kendo.ui.PanelBar

Represents the Kendo UI PanelBar widget. Inherits from Widget.

Configuration (...)
Methods (...)
Events (...)

No results. Try clearing the filter.

Configuration

animation `Object|Boolean`

A collection of visual animations used when PanelBar items are exapnd or collapsed through user interactions. Setting this option to false will disable all animations.

Example

$("#panelBar").kendoPanelBar({
    animation: {
        // fade-out closing items over 1000 milliseconds
        collapse: {
            duration: 1000,
            effects: "fadeOut"
        },
       // fade-in and expand opening items over 500 milliseconds
       expand: {
           duration: 500,
           effects: "expandVertical fadeIn"
       }
   }
});

animation.collapse `Object`

The visual animation(s) that will be used when PanelBar items are closed.

Example

$("#panelBar").kendoPanelBar({
    animation: {
        collapse: {
            duration: 200,
            effects: "fadeOut"
        }
    }
});

animation.collapse.duration `Number`(default: 200)

The number of milliseconds used for the visual animation when a PanelBar item is closed.

Example

$("#panelBar").kendoPanelBar({
    animation: {
       collapse: {
            duration: 1000
       }
  }
});

animation.collapse.effects `String`

A whitespace-delimited string of animation effects that are utilized when a PanelBar item is closed. Options include "fadeOut".

Example

$("#panelBar").kendoPanelBar({
    animation: {
        collapse: {
            duration: 1000,
            effects: "fadeOut"
        }
    }
});

animation.expand `Object`

The visual animation(s) that will be used when opening items.

Example

$("#panelBar").kendoPanelBar({
    animation: {
        expand: {
            duration: 200,
            effects: "expandVertical"
        }
    }
});

animation.expand.duration `Number`(default: 200)

The number of milliseconds used for the visual animation when an item is opened.

Example

$("#panelBar").kendoPanelBar({
 animation: {
      expand: {
          duration: 1000
      }
   }
});

animation.expand.effects `String`(default: "expandVertical")

A whitespace-delimited string of animation effects that are used when an item is expanded. Options include "expandVertical" and "fadeIn".

animation.expand.show `Boolean`(default: true)

expandMode `String`(default: "multiple")

Specifies how the PanelBar items are displayed when opened and closed. The following values are available:

"single"

Display one item at a time when an item is opened; opening an item will close the previously opened item.

"multiple"

Display multiple values at one time; opening an item has no visual impact on any other items in the PanelBar.

Example

$("#panelBar").kendoPanelBar({
    expandMode: "single"
});

Methods

append

Appends an item to the PanelBar.

Example

var panelBar = $("#panelBar").data("kendoPanelBar");
panelBar.append(
    [
        {
            text: "Item 1",
            cssClass: "myClass",                            // Add custom CSS class to the item, optional, added 2012 Q3 SP1.
            url: "http://www.kendoui.com/"                  // link URL if navigation is needed, optional.
        },
        {
            text: "<b>Item 2</b>",
            encoded: false,                                 // Allows use of HTML for item text
            content: "text"                                 // content within an item
        },
        {
            text: "Item 3",
            contentUrl: "partialContent.html"               // content URL to load within an item
        },
        {
            text: "Item 4",
            imageUrl: "http://www.kendoui.com/test.jpg",    // item image URL, optional
            expanded: true,                                 // item is rendered expanded
            items: [{                                       // Sub item collection.
                text: "Sub Item 1"
            },
            {
                text: "Sub Item 2"
            }]
        },
        {
            text: "Item 5",
            // item image sprite CSS class, optional
            spriteCssClass: "imageClass3"
        }
    ],
    referenceItem
);

Parameters

item Selector: Target item, specified as the JSON representation of an object. You can pass item text, content or contentUrl here. Can handle an HTML string or array of such strings or JSON.

referenceItem Selector: A reference item to append the new item in

Returns

kendo.ui.PanelBar Returns the PanelBar object to support chaining.

collapse

Collapses the specified item(s) of a PanelBar.

Example

// access an existing PanelBar instance
var panelBar = $("#panelBar").data("kendoPanelBar");
// collapse the element with ID, "item1"
panelBar.collapse($("#item1"));
// collapse the element with ID, "item2" without visual animations
panelBar.collapse($("#item2"), false);
// collapse all list items that start with ID, "item"
panelBar.collapse($('[id^="item"]'));

Parameters

element Selector: The PanelBar item(s) to be collapsed, expressed as a string containing a selector expression or represented by a jQuery selector.

useAnimation Boolean

_optional, default: _

Temporarily enables (true) or disables (false) any visual animation(s) when collapsing items.

Returns

kendo.ui.PanelBar Returns the PanelBar object to support chaining.

destroy

Prepares the PanelBar for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.

Important: This method does not remove the PanelBar element from DOM.

Example

var panelBar = $("#panelBar").data("kendoPanelBar");

// detach events
panelBar.destroy();

enable

Enables (true) or disables (false) the specified item(s) of the PanelBar.

Example

// access an existing PanelBar instance
var panelBar = $("#panelBar").data("kendoPanelBar");
// enable the item of the PanelBar with ID, "item1"
panelBar.enable($("#item1"), true);
// disable the currently selected item of the PanelBar
var item = panelBar.select();
panelBar.enable(item, false);
// disable all list items that start with ID, "item"
panelBar.enable($('[id^="item"]'), false);

Parameters

element String | Selector: The PanelBar item(s) to be enabled (true) or disabled (false), expressed as a string containing a selector expression or represented by a jQuery selector.

enable Boolean: The desired state - enabled (true) or disabled (false) - of the target element(s).

expand

Expands the specified item(s) of a PanelBar.

Example

// access an existing PanelBar instance
var panelBar = $("#panelBar").data("kendoPanelBar");
// expand the element with ID, "item1"
panelBar.expand($("#item1"));
// expand the element with ID, "item2" without visual animations
panelBar.expand($("#item2"), false);
// expand all list items that start with ID, "item"
panelBar.expand($('[id^="item"]'));

Parameters

element Selector: The PanelBar item(s) to be expanded, expressed as a selector.

useAnimation Boolean

_optional, default: _

Temporariliy enables (true) or disables (false) any visual animation(s) when expanding items.

Returns

kendo.ui.PanelBar Returns the PanelBar object to support chaining.

insertAfter

Inserts a PanelBar item after the specified referenceItem

Example

panelBar.insertAfter(
    [{
        text: "Item 1",
        url: "http://www.kendoui.com"                // Link URL if navigation is needed, optional.
    },
    {
        text: "<b>Item 2</b>",
        encoded: false,                              // Allows use of HTML for item text
        content: "text"                              // Content for the content element
    },
    {
        text: "Item 3",
        contentUrl: "partialContent.html"            // From where to load the item content
    },
    {
        text: "Item 4",
        imageUrl: "http://www.kendoui.com/test.jpg", // Item image URL, optional.
        expanded: true,                              // item is rendered expanded
        items: [{                                    // Sub item collection.
             text: "Sub Item 1"
        },
        {
             text: "Sub Item 2"
        }]
    },
    {
        text: "Item 5",
        spriteCssClass: "imageClass3"                // Item image sprite CSS class, optional.
    }],
    referenceItem
);

Parameters

item Selector: Target item, specified as a JSON object. You can pass item text, content or contentUrl here. Can handle an HTML string or array of such strings or JSON.

referenceItem Selector: A reference item to insert the new item after

insertBefore

Inserts a PanelBar item before the specified referenceItem

Example

panelBar.insertBefore(
    [{
        text: "Item 1",
        url: "http://www.kendoui.com"                // Link URL if navigation is needed, optional.
    },
    {
        text: "<b>Item 2</b>",
        encoded: false,                              // Allows use of HTML for item text
        content: "text"                              // Content for the content element
    },
    {
        text: "Item 3",
        contentUrl: "partialContent.html"            // From where to load the item content
    },
    {
        text: "Item 4",
        imageUrl: "http://www.kendoui.com/test.jpg", // Item image URL, optional.
        expanded: true,                              // item is rendered expanded
        items: [{                                    // Sub item collection.
             text: "Sub Item 1"
        },
        {
             text: "Sub Item 2"
        }]
    },
    {
        text: "Item 5",
        spriteCssClass: "imageClass3"                // Item image sprite CSS class, optional.
    }],
    referenceItem
);

Parameters

item Selector: Target item, specified as a JSON object. You can pass item text, content or contentUrl here. Can handle an TML string or array of such strings or JSON.

referenceItem Selector: A reference item to insert the new item before.

Returns

kendo.ui.PanelBar Returns the PanelBar object to support chaining.

reload

Reloads the content of a PanelBar from an AJAX request.

Example

// get a reference to the panel bar
var panelBar = $("#panelBar").data("kendoPanelBar");
// reload the panel basr
panelBar.reload();

Parameters

element Selector: Target element

remove

Removes the specified PanelBar item(s).

Example

// get a reference to the panel bar
var panelBar = $("#panelBar").data("kendoPanelBar");
// remove Item 1
panelBar.remove("#Item1");

Parameters

element Selector | DOM element | jQuery object: The PanelBar item(s) to be removed, expressed as a selector string, DOM element or a jQuery object.

select

Selects the specified item of the PanelBar. If this method is invoked without arguments, it returns the currently selected item.

Example

// access an existing PanelBar instance
var panelBar = $("#panelBar").data("kendoPanelBar");
// select the item with ID, "item1"
panelBar.select("#item1");

Parameters

element Selector | DOM element | jQuery object: The PanelBar item to be selected, expressed as a string containing a selector expression or represented by a jQuery selector.

Events

activate

Triggered when an item of a PanelBar is activated.

Attach activate event handler during initialization; detach via unbind()

// event handler for activate
var onActivate = function(e) {
    // access the activated item via e.item (HTMLElement)
};

// attach activate event handler during initialization
var panelBar = $("#panelBar").kendoPanelBar({
    activate: onActivate
});

// detach activate event handler via unbind()
panelBar.data("kendoPanelBar").unbind("activate", onActivate);

Attach activate event handler via bind(); detach via unbind()

// event handler for activate
var onActivate = function(e) {
    // access the activated item via e.item (HTMLElement)
};

// attach activate event handler via bind()
$("#panelBar").data("kendoPanelBar").bind("activate", onActivate);

// detach activate event handler via unbind()
$("#panelBar").data("kendoPanelBar").unbind("activate", onActivate);

Event Data

e.item Element: The activated item of the PanelBar.

collapse

Triggered when an item of a PanelBar is collapsed.

Attach collapse event handler during initialization; detach via unbind()

// event handler for collapse
var onCollapse = function(e) {
    // access the collapsed item via e.item (HTMLElement)
};

// attach collapse event handler during initialization
var panelBar = $("#panelBar").kendoPanelBar({
    collapse: onCollapse
});

// detach collapse event handler via unbind()
panelBar.data("kendoPanelBar").unbind("collapse", onCollapse);

Attach collapse event handler via bind(); detach via unbind()

// event handler for collapse
var onCollapse = function(e) {
    // access the collapsed item via e.item (HTMLElement)
};

// attach collapse event handler via bind()
$("#panelBar").data("kendoPanelBar").bind("collapse", onCollapse);

// detach collapse event handler via unbind()
$("#panelBar").data("kendoPanelBar").unbind("collapse", onCollapse);

Event Data

e.item Element: The collapsing item of the PanelBar.

contentLoad

Fires when content is fetched from an AJAX request.

Example

$("#panelBar").kendoPanelBar({
    contentLoad: function(e) {
        // handle event
    }
});

To set after intialization

// get a reference to the panel bar
var panelBar = $("#panelBar").data("kendoPanelBar");
// bind the contentLoad event
panelBar.bind("contentLoad", function(e) {
    // handle event
});

Event Data

e.item Element: The selected item

e.contentElement Element: The loaded content element

error

Fires when AJAX request results in an error.

Example

$("#panelBar").kendoPanelBar({
    error: function(e) {
        // handle event
    }
});

To set after intialization

// get a reference to the panel bar
var panelBar = $("#panelBar").data("kendoPanelBar");
// bind the error ajax event
panelBar.bind("error", function(e) {
    // handle event
});

Event Data

e.xhr jqXHR: The jqXHR object used to load the content

e.status String: The returned status.

expand

Triggered when an item of a PanelBar is expanded.

Attach expand event handler during initialization; detach via unbind()

// event handler for expand
var onExpand = function(e) {
    // access the expanded item via e.item (HTMLElement)
};

// attach expand event handler during initialization
var panelBar = $("#panelBar").kendoPanelBar({
    expand: onExpand
});

// detach expand event handler via unbind()
panelBar.data("kendoPanelBar").unbind("expand", onExpand);

Attach expand event handler via bind(); detach via unbind()

// event handler for expand
var onExpand = function(e) {
    // access the expanded item via e.item (HTMLElement)
};

// attach expand event handler via bind()
$("#panelBar").data("kendoPanelBar").bind("expand", onExpand);

// detach expand event handler via unbind()
$("#panelBar").data("kendoPanelBar").unbind("expand", onExpand);

Event Data

e.item Element: The expanding item of the PanelBar.

select

Triggered when an item of a PanelBar is selected.

Attach select event handler during initialization; detach via unbind()

// event handler for select
var onSelect = function(e) {
    // access the selected item via e.item (HTMLElement)
};

// attach select event handler during initialization
var panelBar = $("#panelBar").kendoPanelBar({
    select: onSelect
});

// detach select event handler via unbind()
panelBar.data("kendoPanelBar").unbind("select", onSelect);

Attach select event handler via bind(); detach via unbind()

// event handler for select
var onSelect = function(e) {
    // access the selected item via e.item (HTMLElement)
};

// attach select event handler via bind()
$("#panelBar").data("kendoPanelBar").bind("select", onSelect);

// detach select event handler via unbind()
$("#panelBar").data("kendoPanelBar").unbind("select", onSelect);

Event Data

e.item Element: The selected item of the PanelBar.

Page rendered at 5/23/2013 9:24:17 PM UTC.