diff --git a/components/grid/selection/rows.md b/components/grid/selection/rows.md index d47b232e46..775e725bd4 100644 --- a/components/grid/selection/rows.md +++ b/components/grid/selection/rows.md @@ -199,7 +199,7 @@ The [**Select All** checkbox in the Grid checkbox column]({%slug components/grid When using [Grid templates]({%slug components/grid/features/templates%}) with row selection: * If you are using a [Grid column template]({%slug grid-templates-column%}) and you have a clickable element in the template, you can check the knowledge base article on [how to prevent row selection when the user clicks another component in the Grid column template]({%slug grid-kb-row-selection-in-column-template%}). -* If you are using a [row template]({%slug components/grid/features/templates%}#row-template) the Grid cannot render a built-in [checkbox column]({%slug components/grid/columns/checkbox%}). You have to render checkboxes manually and handle their changed event to populate the `SelectedItems` collection of the Grid. You can find an example to get started in the following thread: [Grid Row Template with Selection - Unsure how to Bind to Selected Item](https://feedback.telerik.com/blazor/1463819-grid-row-template-with-selection-unsure-how-to-bind-to-selected-item). +* If you are using a [row template]({%slug components/grid/features/templates%}#row-template) the Grid cannot render a built-in [checkbox column]({%slug components/grid/columns/checkbox%}). You have to render checkboxes manually and handle their changed event to populate the `SelectedItems` collection of the Grid. You can find an example to get started in the following knowledge base article: [Implement Built-in Functions when Using Grid Row Template]({%slug grid-kb-row-template-simulate-built-in-functions%}). ### Selection and Row Drag and Drop diff --git a/components/grid/templates/row.md b/components/grid/templates/row.md index 5eaff83d69..e693a0539a 100644 --- a/components/grid/templates/row.md +++ b/components/grid/templates/row.md @@ -18,7 +18,7 @@ The contents of the row template must be `` elements and their number (or to You can use the `Context` attribute of the `` tag of the grid to set the name of the context variable. Its type is the model type to which the grid is bound. ->important Using the row template takes functionality away from the grid because it no longer controls its own rendering. For example, InCell and Inline editing could not render editors, detail templates will not be available, column resizing, locking, visibility and reordering cannot change the data cells anymore, only the headers, and Checkbox selection must be implemented by the app ([example](https://feedback.telerik.com/blazor/1463819)). +>important Using the row template takes functionality away from the grid because it no longer controls its own rendering. For example, InCell and Inline editing could not render editors, detail templates will not be available, column resizing, locking, visibility and reordering cannot change the data cells anymore, only the headers, and Checkbox selection must be implemented by the app. You can find an example to get started in the following knowledge base article: [Implement Built-in Functions when Using Grid Row Template]({%slug grid-kb-row-template-simulate-built-in-functions%}). >caption Using a row template diff --git a/knowledge-base/grid-row-template-simulate-built-in-functions.md b/knowledge-base/grid-row-template-simulate-built-in-functions.md new file mode 100644 index 0000000000..946e02b84e --- /dev/null +++ b/knowledge-base/grid-row-template-simulate-built-in-functions.md @@ -0,0 +1,311 @@ +--- +title: Add the Grid Built-In Functions When Using Grid Row Template +description: Learn how to implement built-in Grid functions like CheckBoxColumn or CommandColumn when using the Grid's Row Template +type: how-to +page_title: Implement Built-in Functions when Using Grid Row Template +slug: grid-kb-row-template-simulate-built-in-functions +position: +tags: grid, rowtemplate +ticketid: 1463819, 1465447, 1578974, 1605222, 1606211, 1609036, 1629221, 1667096 +res_type: kb +--- + +## Environment + + + + + + + + +
ProductGrid for Blazor
+ + +## Description + +This KB article answers the following questions: + +* How to [select rows]({%slug grid-selection-row%}) in the Grid when using a [Row Template]({%slug grid-templates-row%})? +* How to add a [checkbox column]({%slug components/grid/columns/checkbox%}) in the Grid when using a Row Template? I want to be able to select the row through its checkbox, but also to have the functionality to [select all rows]({%slug components/grid/columns/checkbox%}#parameters) from the header of the checkbox column. +* Do the built-in keyboard options to select a range of rows by clicking the `Shift` or `Ctrl` key work when using a Row Template? How to check the checkbox of the row when I select a row by clicking the row? +* How to add a [command column]({%slug components/grid/columns/command%}) in the Grid when using a Row Template? +* When using a Row Template, how to prevent the selection of Grid rows when clicking on command buttons? +* How to implement Grid column [resizing]({%slug components/grid/columns/resize%}), [auto-fitting]({%slug components/grid/columns/resize%}#autofit-columns), [visibility]({%slug grid-columns-visible%}), [locking]({%slug grid-columns-frozen%}), and [reordering]({%slug components/grid/columns/reorder%}) when using a Row Template? + +## Solution + +By default, using the Row Template disables most built-in functionalities of the Grid because the Grid no longer controls its own rendering. This lets you add custom implementations for these features. The [example below](#example) shows one way to implement functionalities such as row selection (both by clicking on a row and through a checkbox column), column resizing and visibility, editing through command buttons, sorting, and filtering. + +### Selection + +To implement custom selection functionality: + +* In the [`` collection]({%slug components/grid/columns/bound%}#show-data-in-a-grid) add the [``]({%slug components/grid/columns/checkbox%}) and use the [`HeaderTemplate`]({%slug components/grid/columns/checkbox%}#header-template) to add a [CheckBox component]({%slug checkbox-overview%}). This CheckBox component handles the [select all rows]({%slug components/grid/columns/checkbox%}#parameters) functionallity. +* In the Row Template, add a `` element with a CheckBox component. Add a Boolean property to the Grid model to indicate selection so you can use it for the state of this CheckBox. +* Handle the Grid's [`SelectedItemsChanged` event]({%slug grid-selection-row%}#selecteditemschanged-event) and the CheckBox's [`OnChange` event]({%slug checkbox-events%}#onchange) to manage the [`SelectedItems` collection]({%slug grid-selection-overview%}#access-selected-rows-or-cells). The `OnChange` event fires after the `SelectedItemsChanged` event. In this case, you need to create a separate collection of selected items to persist the selected items when multiselecting through the checkbox column. + +### Editing, Sorting, Filtering + +The built-in editing, sorting, and filtering will work if the Row Template structure is similar to an actual table and only for the first Grid data model property included in the `` element, if any. + +### Command Column + +To implement a custom command column: + +* In the `` collection add the [``]({%slug components/grid/columns/command%}) and use the [built-in `Save` and `Cancel` commands]({%slug components/grid/columns/command%}#built-in-commands). +* In the Row Template add a `` element with a [Button component]({%slug components/button/overview%}) and handle the Grid items editing and deleting programmatically. Refer to the knowledge base article on how to [enter and exit Grid edit mode programmatically]({%slug grid-kb-add-edit-state%}). +* Set the `stopPropagation` method of the `onclick` event to the `` element to prevent row selection when clicking a command button. + +### Column Resizing, Auto-Fitting, Visibility, Locking, Reordering + +* Column resizing and auto-fitting will work if the Row Template structure resembles an actual table row, with a corresponding number of cells matching the Grid columns. +* Column visibility depends on including a `` element for the column in the Row Template. +* To implement column locking, add the `k-grid-content-sticky` class to the `` element of the columns that you want locked, and calculate and set the correct `left` and `right` CSS properties, as the content inside the Row Template can be any valid HTML. +* For column reordering, manage the `left` and `right` CSS properties on the `` elements within the Row Template. + +## Example + +>caption Row selection, Column resizing and visibility, Editing, Sorting, and Filtering when using Row Template + +````CSHTML + + + Add + + + + + + + + + + @{ + if(article.IsSelected) + { +

Selected

+ } + else + { +

Not Selected

+ } + } + @article.Title + + + Programmatic Edit + Programmatic Delete + + + + + + + + + + + + + Update + Cancel + + + + +@code { + private TelerikGrid? GridRef { get; set; } + + private List GridData { get; set; } = new(); + + private IEnumerable SelectedItems { get; set; } = Enumerable.Empty(); + private List TempSelectedItemsCollection { get; set; } = new(); + private bool SelectAll { get; set; } + + #region Selection + + private void SelectAllHandler(bool newValue) + { + SelectAll = newValue; + + foreach (var item in GridData) + { + item.IsSelected = SelectAll; + } + + // If SelectAll is true, assign all items to SelectedItems, + // else set it to an empty list. + SelectedItems = SelectAll ? new List(GridData) : new List(); + TempSelectedItemsCollection = SelectAll ? new List(GridData) : new List(); + } + + protected void SelectedItemsChangedHandler(IEnumerable selectedItems) + { + foreach (var item in GridData) + { + item.IsSelected = false; + } + + // Use temporary collection to be able to persist the + // selected items when multiselecting with checkboxes. + TempSelectedItemsCollection = SelectedItems.ToList(); + SelectedItems = selectedItems; + + foreach (var item in selectedItems) + { + item.IsSelected = true; + } + } + + private void OnCheckBoxChangeHandler(Guid itemId) + { + ArticleDto? currentItem = GridData.FirstOrDefault(a => a.Id == itemId); + + if (currentItem != null) + { + if (currentItem.IsSelected) + { + TempSelectedItemsCollection.Add(currentItem); + } + else + { + TempSelectedItemsCollection.Remove(currentItem); + } + } + + // The OnChange event fires after the SelectedItemsChanged + // thus we need to update the SelectedItems collection. + SelectedItems = TempSelectedItemsCollection; + + foreach (var item in SelectedItems) + { + item.IsSelected = true; + } + } + + #endregion Selection + + #region Edit + + private void OnCreateHandler(GridCommandEventArgs args) + { + var createdItem = (ArticleDto)args.Item; + createdItem.Id = Guid.NewGuid(); + var rnd = new Random(); + createdItem.ImageUrl = $"https://demos.telerik.com/blazor-ui/images/photos/{rnd.Next(1, 30) % 7 + 1}.jpg"; + GridData.Insert(0, createdItem); + } + + private async Task OnProgrammaticEditHandler(Guid itemId) + { + if (GridData.Any() && GridRef != null) + { + var gridState = GridRef.GetState(); + + gridState.InsertedItem = null; + gridState.OriginalEditItem = GridData.Where(x => x.Id == itemId).First(); + gridState.EditItem = GridData.Where(x => x.Id == itemId).First().Clone(); + var rnd = new Random(); + gridState.EditItem.ImageUrl = $"https://demos.telerik.com/blazor-ui/images/photos/{rnd.Next(1, 30) % 7 + 1}.jpg"; + await GridRef.SetStateAsync(gridState); + } + } + + private void OnUpdateHandler(GridCommandEventArgs args) + { + var updatedItem = (ArticleDto)args.Item; + var index = GridData.FindIndex(i => i.Id == updatedItem.Id); + if (index != -1) + { + GridData[index] = updatedItem; + } + } + + private void OnProgrammaticDeleteHandler(Guid itemId) + { + if (GridData.Any() && GridRef != null) + { + var itemToDelete = GridData.Where(x => x.Id == itemId).First(); + GridData.Remove(itemToDelete); + + // Remove from SelectedItems collection + TempSelectedItemsCollection = SelectedItems.ToList(); + TempSelectedItemsCollection.Remove(itemToDelete); + SelectedItems = TempSelectedItemsCollection; + + GridRef.Rebind(); + } + } + + #endregion Edit + + #region Data Generation + + private void GetGridData() + { + GridData = new List(); + + for (int i = 1; i <= 30; i++) + { + GridData.Add(new ArticleDto + { + Id = Guid.NewGuid(), + Title = "Article title " + i, + ImageUrl = $"https://demos.telerik.com/blazor-ui/images/photos/{i % 7 + 1}.jpg" + }); + } + } + + protected override void OnInitialized() + { + GetGridData(); + } + + public class ArticleDto + { + public Guid Id { get; set; } + public string Title { get; set; } + public string ImageUrl { get; set; } + public bool IsSelected { get; set; } + + public ArticleDto Clone() + { + return new ArticleDto() + { + Id = Id, + Title = Title, + ImageUrl = ImageUrl + }; + } + } + + #endregion DataGeneration + +} +```` + +## See Also + +* [Grid Row Template]({%slug grid-templates-row%}) +* [Grid Row Selection]({%slug grid-selection-row%}) +* [Grid Command Column]({%slug components/grid/columns/command%}) +* [Grid Column Resizing]({%slug components/grid/columns/resize%}) +* [Grid Column Auto-fitting]({%slug components/grid/columns/resize%}#autofit-columns) +* [Grid Column Visibility]({%slug grid-columns-visible%}) +* [Grid Column Locking]({%slug grid-columns-frozen%}) +* [Grid Column Reordering]({%slug components/grid/columns/reorder%}) +* [Enter And Exit Grid Edit Mode Programmatically]({%slug grid-kb-add-edit-state%})