Widgets / Navigation / PanelBar

PanelBar Overview

The Kendo UI PanelBar widget displays hierarchical data as a multi-level, expandable widget.

Regarding its structure, you can apply either of the approaches:

  • Define it in HTML.
  • Dynamically configure it through the API of the PanelBar.

The content of the items can also be loaded through AJAX by specifying a content URL.

Initialization

You can create a PanelBar in any of the following ways:

  • Use HTML markup.
  • Use a JSON data object.
  • Use a dynamic data binding either to a local or a remote data source. This approach has been available as of the R1 2017 release and is suitable for larger data sets and for data that frequently changes.

Important

As PanelBar should be initialized after the DOM is fully loaded, make sure you create it within a $(document).ready() statement.

Using HTML Markup

You can create a Kendo UI PanelBar by targeting the root element of an HTML list. The widget utilizes this list to define its structure and content.

Example
<ul id="panelbar">
    <li>
        Item 1
            <ul>
                <li>Sub Item 1</li>
                <li>Sub Item 2</li>
            </ul>
    <li>
    <li>Item 2</li>
</ul>

<script>
    $(document).ready(function() {
        $("#panelbar").kendoPanelBar();
    });
</script>

Using JSON Data Objects

The following example demonstrates how to initialize a PanelBar by using a JSON data object.

Example
<ul id="panelbar"></ul>

<script>
  $("#panelbar").kendoPanelBar({
    dataSource: [
      {
        text: "Item 1",
        cssClass: "myClass",                            // (Optional) Add custom CSS class to the item, added 2012 Q3 SP1.
        url: "http://www.telerik.com/"                  // (Optional) Link URL if navigation is needed
        },
      {
        text: "<b>Item 2</b>",
        encoded: false,                                 // Allows the 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.telerik.com/test.jpg",    // (Optional) Item image URL
        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"
      }
    ]
  });
</script>

Using Data Binding to Local Arrays

This approach has been available as of the R1 2017 release.

The following example demonstrates how to create a PanelBar and bind it to a local data source.

Example
<div id="panelBar"></div>

<script>
$(document).ready(function() {
    $("#panelBar").kendoPanelBar({
        dataSource: [
            {
                text: "Item 1",
                expanded: true,
                items: [
                    { text: "Item 1.1" },
                    { text: "Item 1.2" }
                ]
            },
            { text: "Item 2" }
        ]
    })
});
</script>

Using Data Binding to Remote Services

This approach has been available as of the R1 2017 release.

The following example demonstrates how to create a PanelBar and bind it to a remote HierarchicalDataSource.

Example
<div id="panelBar"></div>

<script>
$(document).ready(function() {
    $("#panelBar").kendoPanelBar({
        dataTextField: "FullName",
        dataSource: {
            transport: {
                read: {
                    url: "https://demos.telerik.com/kendo-ui/service/Employees",
                    dataType: "jsonp"
                }
            },
            schema: {
                model: {
                    id: "EmployeeId",
                    hasChildren: "HasEmployees"
                }
            }
        }
    })
});
</script>

For a complete reference on how to bind the PanelBar to different service end-points, refer to the API documentation on HierarchicalDataSource.

Configuration

Item Lists with Nested Content

PanelBar items may contain nested content, including markup, within a <div> element. The text content located outside the nested content is used as a title of the item.

Example
<ul id="panelbar">
    <li>Item with no content</li>
    <li>Item with content
        <div>This is nested content of a PanelBar item.</div>
    </li>
</ul>

<script>
    $(document).ready(function() {
        $("#panelbar").kendoPanelBar();
    });
</script>

Content with AJAX

The PanelBar provides built-in support for asynchronously loading content from remote URLs. These URLs should return HTML content that can be loaded in the PanelBar item content area. Content <div> elements should be empty for AJAX loading to work.

The following example demonstrates how to load a PanelBar item content asynchronously via AJAX.

Example
<ul id="panelbar">
    <li>Item 1
        <ul>
            <li>Sub Item 1</li>
        </ul>
    </li>
    <li>Item 2</li>
    <li>
        Item with Dynamic Content
        <div></div>
    </li>
</ul>

<script>
    $("#panelbar").kendoPanelBar({
        contentUrls:[
            null,
            null,
            "html-content-snippet.html"
        ]
    });
</script>

When the PanelBar loads remote content via AJAX, the server response is cached in-memory so that subsequent expand/collapse actions do not trigger subsequent AJAX requests.

Expand Mode

The PanelBar provides the Single or Multiple expand mode options.

  • If ExpandMode is set to Single, the user can expand only a single root item or a single child item of a specific parent item. Expanding another root item or another child of the currently expanded item's parent will collapse the currently expanded item. This approach is also the only way to collapse an expanded item in the single expand mode.
  • If ExpandMode is set to Multiple, the user can expand multiple root items or children of the same parent item at a time. Expanding an item does not collapse the currently expanded items. Expanded items can be collapsed by clicking on them.
Example
<div id="panelbar"></div>
<script>
    var items = [
        { ProductName: "Root1", items: [
            { ProductName: "Level2 1", items: [
                { ProductName: "Level3 1" },
                { ProductName: "Level3 2" }
            ]},
            { ProductName: "Level2 2", items: [
                { ProductName: "Level3 1" },
                { ProductName: "Level3 2" }
            ]}
        ]},
        { ProductName: "Root2", items: [
            { ProductName: "Level2 1" }
        ]}
    ];

    $("#panelbar").kendoPanelBar({
        dataTextField: "ProductName",
        dataSource: items,
        expandMode: "single"
    });
</script>

PanelBar Animations

By default, a PanelBar uses animations to expand and reveal sub-items when an item header is clicked. These animations can be modified in configuration via the open and close animation properties. A PanelBar can also be configured to only allow one panel be opened at a time.

The following example demonstrates how to change the PanelBar animation and expandMode behavior.

Example
<ul id="panelbar"></ul>

<script>
    $("#panelBar").kendoPanelBar({
        animation: {
            open : { effects: "fadeIn" }
        },
        expandMode: "single"
    });
</script>

Dynamic Items

The PanelBar API provides methods for dynamically adding or removing PanelBar items.

To add items, provide the new item as a JSON object along with a reference item. A reference item is a target PanelBar item HTML element that already exists in the PanelBar. The reference item will be used to determine the placement in the hierarchy of the new item. Any valid jQuery selector can be used to obtain a reference to the target item.

For more information on configuring PanelBar items, see the PanelBar API demos.

The following example demonstrates how to add a new root PanelBar item.

Example
<ul id="panelbar"></ul>

<script>
    var panelBar = $("#panelbar").kendoPanelBar().data("kendoPanelBar");

    panelBar.insertAfter(
        { text: "New PanelBar Item" },
        panelBar.element.children("li:last")
    );
</script>

dataItem Manipulations

As of the R1 2017 release, the PanelBar API has provided methods for you to dynamically manage the state of the items trough their dataItems.

To disable, expand, or select a certain PanelBar item, get a reference to its dataItem and use the desirable method.

The following example demonstrates how to use the disable, expand, and select methods.

Example
<div id="panelBar"></div>
<button id="btn1" class="k-button">Update Data Item</button>
<script>
 $(document).ready(function() {
        $("#panelBar").kendoPanelBar({
            dataSource: [
                {
                    text: "Item 1",
                    expanded: false,
                    items: [
                        { text: "Item 1.1" },
                        { text: "Item 1.2" }
                    ]
                },
                { text: "Item 2" }
            ]
        })
    $("#btn1").on('click', function(){
        var panelBar = $("#panelBar").data("kendoPanelBar");
        var dataItem = panelBar.dataItem(".k-item:first"); // get reference to the first item
        dataItem.set("expanded", true); //set the item as expanded
        dataItem.set("enabled", false); //set the item as enabled
        //dataItem.set("selected", true);  set the item as selected
 })
});
</script>

Retry of Data Binding

As of the R1 2017 release, the PanelBar has provided an built-in functionality of attempting a retry. If the initial data binding fails and regardless of the reason for the failure, you are now prompted with a Request failed. message. To initiate a new data binding, use the Retry button.

Figure 1: The Retry button of the PanelBar prompting you to re-initiate the data binding

PanelBar areas

See Also

For how-to examples on the Kendo UI PanelBar widget, browse its How To documentation folder.

In this article
Related articles
Not finding the help you need? Improve this article