Binding a ListView in a TabStrip with Telerik UI for ASP.NET Core
Environment
| Product | Telerik UI for ASP.NET Core Grid, ListView, and TabStrip |
| Progress Telerik UI for ASP.NET Core version | 2021.2.616 |
Description
When a Grid client detail template contains a TabStrip and a ListView, the ListView may not bind when declared as a TagHelper.
The nested Kendo template can prevent the ListView from completing its data request in this configuration. This article shows how to initialize the ListView after the Grid detail row renders. It also shows the equivalent HtmlHelper configuration.
Solution
Using HtmlHelpers
HtmlHelpers can render the ListView configuration directly in the client template. Call ToClientTemplate() on both the nested ListView and the TabStrip.
@(Html.Kendo().TabStrip()
.Name("tabStrip_#=CategoryID#")
.Items(items =>
{
items.Add()
.Text("Products ListView")
.Content(@<text>
@(Html.Kendo().ListView<Product>()
.Name("productsListView_#=CategoryID#")
.TagName("div")
.ClientTemplateId("product-listview-item-template")
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(10)
.Model(model => model.Id(product => product.ProductID))
.Read(read => read.Url(
Url.Action("ProductsListView", "Home") +
"?categoryId=#=CategoryID#"
))
)
.Pageable()
.ToClientTemplate()
)
</text>);
})
.ToClientTemplate()
)
Using TagHelpers
When you place a TagHelper inside a Kendo client template, use type="text/html" on the template and set is-in-client-template="true" on the Kendo component.
In this scenario, define the ListView container as a regular div. Store the category ID in a data-* attribute, then initialize the ListView in the Grid detailInit event.
@addTagHelper *, Kendo.Mvc
<script id="category-detail-template" type="text/html">
<kendo-tabstrip name="tabStrip_#=CategoryID#" is-in-client-template="true">
<items>
<tabstrip-item text="Products ListView">
<content>
<div class="products-listview" data-category-id="#=CategoryID#"></div>
</content>
</tabstrip-item>
</items>
</kendo-tabstrip>
</script>
Define the ListView item template separately.
<script id="product-listview-item-template" type="text/x-kendo-template">
<div class="product-card">
<strong>#: ProductName #</strong>
</div>
</script>
Initialize the ListView after the Grid detail row renders.
<script>
var productCardTemplate = null;
function onCategoriesGridDetailInit(e) {
if (!productCardTemplate) {
productCardTemplate = kendo.template(
$("#product-listview-item-template").html()
);
}
e.detailRow.find(".products-listview").each(function () {
var categoryId = $(this).data("categoryId");
$(this).kendoListView({
dataSource: {
transport: {
read: {
url: '@Url.Action("ProductsListView", "Home")',
data: {
categoryId: categoryId
}
}
},
schema: {
data: "Data",
total: "Total"
},
serverPaging: true,
pageSize: 10
},
pageable: true,
template: productCardTemplate
});
});
}
</script>
The schema.data and schema.total settings match the DataSourceResult response returned by the server. Use them when initializing the ListView with the jQuery API as shown above.
Key Points
-
When using HtmlHelpers inside a client template, call
ToClientTemplate()on each nested helper. -
Use a
data-*attribute to pass dynamic values such asCategoryIDto the ListView initialization code. -
When using the jQuery ListView API, configure
schema.dataandschema.totalto match the server response. -
For Core TagHelpers inside a Kendo client template, use
type="text/html"andis-in-client-template="true". -
In the TagHelper workaround, initialize the ListView after the Grid detail row renders.