Skip to main content

A wrapper implementation for Kendo Grid usage

A wrapper implementation for any heavily used item is always a good practice. Whatever is not written by us and used at a lot of places should be wrapped within specific functionality to keep it future proof and easily changeable. This also encourages DRY principle to keep our common setting at a central place.

Kendo UI items are enormous in configuration, one of an issue I find people keep repeating codes for Kendo Grid configuration. They have built very flexible system to have any configuration, but in most of the cases, we do not need all of those complicated configuration. We would try to see a simpler configuration of same. The actual core implementation is bit complex, but we do not have to bother about it once done since the focus is just on usage only.

I recommend doing this practice for as simple as jQuery events, form handling or as simple as any notification system. This just won't make things simple but makes codes much more manageable, easy understand, read or open for future enhancements.

The core implementation:GridWrapper.ts

 import * as _ from "lodash";  
 class GridWrapper {  
   constructor() {  
   }  
   InitGrid(gridInitOption: {  
     GridSelector: string;  
     GridOption?: (opt: kendo.ui.GridOptions) => void;  
     DataSource?: (dsOption: kendo.data.DataSourceOptions) => void;  
     GridColumns: IAppKendoColumn[];  
     DataSourceUrl?: IDataSourceUrlOption;  
     Width?: number;   
   }): kendo.ui.Grid {  
     let baseUrl = '';  // TODO: Base URL ideally should be done on creation of instance
    // Default setting for Kendo Grid. 
    let gridOptions: kendo.ui.GridOptions = {  
       columns: gridInitOption.GridColumns,  
       sortable: true,  
       noRecords: {  
         template: 'No records found'  
       },  
       pageable: {  
         refresh: true,  
         buttonCount: 5  
       },  
     };  
     // Callback for grid option, in case further customization by callee 
     typeof gridInitOption.GridOption == 'function' && gridInitOption.GridOption(gridOptions);  
     // DataSource configuration  
     let dataSource = this.GetDefaultDataSource();  
     this.ConfigureColumnDataSource(gridInitOption.GridColumns, dataSource);  
     this.ConfigureTransport(gridInitOption.DataSourceUrl, dataSource);  
     // Callback for data source, in case if further change required.
     typeof gridInitOption.DataSource == 'function' && gridInitOption.DataSource(dataSource);  
     gridOptions.dataSource = new kendo.data.DataSource(dataSource);  
     let grid = $(gridInitOption.GridSelector).kendoGrid(gridOptions);  
     return grid.data('kendoGrid');  
   }  
   private GetDefaultDataSource(): kendo.data.DataSourceOptions {  
     // Default setting for Kendo DataSource
     return {  
       // This is for Kendo MVC but can be removed in case of Kendo UI
       type: (() => {  
         if (kendo.data.transports['aspnetmvc-ajax']) {  
           return 'aspnetmvc-ajax';  
         } else {  
           throw new Error('The kendo.aspnetmvc.min.js script is not included.');  
         }  
       })(),  
       transport: {},  
       serverPaging: true,  
       serverSorting: true,  
       pageSize: 10,  
       schema: {  
         data: 'Data',  
         total: 'Total',  
         errors: 'Errors',  
         model: {  
           fields: {}  
         }  
       },  
       error: (e) => {  
         // Handling error as requied.
         this.ParseModelStateError(e.xhr,  
           (errMessage, propName) => alert(errMessage)); // TODO: Hook with notification system  
       }  
     };  
   }  
   GetDataItem(gridSelector: string, evt) {  
     var dataItem = $(gridSelector).data('kendoGrid').dataItem($(evt.currentTarget).closest("tr"));  
     return dataItem;  
   }  
   private ConfigureTransport(urlOption: IDataSourceUrlOption, datasource: kendo.data.DataSourceOptions) {  
     if (urlOption == undefined) {  
       return;  
     }  
     // Datasource setting for all URLs required.
     datasource.transport.read = typeof urlOption.read == 'string' ?  
       {  
         url: baseUrl + urlOption.read,  
         type: 'POST'  
       } : urlOption.read;  
     datasource.transport.create = typeof urlOption.create == 'string' ?  
       {  
         url: baseUrl + urlOption.create,  
         type: 'POST'  
       } : urlOption.create;  
     datasource.transport.update = typeof urlOption.update == 'string' ?  
       {  
         url: baseUrl + urlOption.update,  
         type: 'POST'  
       } : urlOption.update;  
     datasource.transport.destroy = typeof urlOption.destroy == 'string' ?  
       {  
         url: baseUrl + urlOption.destroy,  
         type: 'DELETE'  
       } : urlOption.destroy;  
   }  
   private ConfigureColumnDataSource(columns: IAppKendoColumn[], dataSource: kendo.data.DataSourceOptions) {  
     _.forEach(columns, col => {  
       if (_.has(col, 'field') && _.has(col, 'dataSet')) {  
         let fieldName = col.field;  
         let dsFieldOption = col.dataSet;  
         dataSource.schema.model.fields[fieldName] = dsFieldOption;  
         // Primary key  
         let primaryKetSet = false;  
         // Customization of as per our need to make our life easier.
         // this is direct setting based on IAppKendoColumn for data source setting. 
         if (!primaryKetSet && _.has(dsFieldOption, 'isPrimaryKey')) {  
           primaryKetSet = true;  
           dataSource.schema.model.id = fieldName;  
           delete dsFieldOption.isPrimaryKey;  
         }  
         // Default sort  
         let defaultSortDone = false;  
         // Default sort settings
         if (!defaultSortDone && _.has(dsFieldOption, 'defaultSortOrder')) {  
           defaultSortDone = true;  
           dataSource.sort = { field: fieldName, dir: dsFieldOption.defaultSortOrder };  
           delete dsFieldOption.defaultSortOrder;  
         }  
         delete col.dataSet;  
       }  
     });  
   }  
   ParseModelStateError(data: JQuery.jqXHR<any>, eachErrorCallback: (message: string, propName: string) => void) {  
     if (data == undefined || data.responseJSON == undefined) {  
       return;  
     }  
     var message = '';  
     // Error setting initialization.
     var propStrings = Object.keys(data.responseJSON);  
     $.each(propStrings, (errIndex, propString) => {  
       var propErrors = data.responseJSON[propString];  
       $.each(propErrors, (errMsgIndex, propError) => {  
         message += propError;  
       });  
       message += '\n';  
       eachErrorCallback(message, propString);  
       message = '';  
     });  
   }  
 }  
 interface IAppKendoColumn  
   extends kendo.ui.GridColumn {  
   dataSet?: IDataSetOption;  
   command?: any;  
 }  
 interface IDataSourceUrlOption {  
   read: kendo.data.DataSourceTransportRead | string;  
   create?: kendo.data.DataSourceTransportCreate | string;  
   destroy?: kendo.data.DataSourceTransportDestroy | string;  
   update?: kendo.data.DataSourceTransportUpdate | string;  
 }  
 interface IDataSetOption {  
   isPrimaryKey?: boolean;  
   defaultSortOrder?: SortOrder;  
   type?: DataType;  
   editable?: boolean;  
   validation?: any;  
   defaultValue?: any;  
 }  
 enum SortOrder {  
   asc = 'asc',  
   desc = 'desc'  
 }  
 enum DataType {  
   Number = 'number',  
   String = 'string',  
   Boolean = 'boolean',  
   Date = 'date'  
 }  
 export { KendoGrid, IAppKendoColumn, SortOrder, DataType, IDataSetOption }

Usage

Once a common code is completed, usage is much more straightforward. In one go everything can be set. Along with such a small setting, we can utilize complex one through callbacks or include more properties.

 var grid = new Grid(); // In my case I had used DI, but you can use direct method call  
 grid.InitGrid({  
      GridSelector: '#UserGrid',  
      GridColumns: [  
           {  
                field: 'Id', title: 'User Id', hidden: true,  
                dataSet: { isPrimaryKey: true, type: DataType.Number }  
           },  
           {  
                field: 'UserName', title: 'User', dataSet: { type: DataType.String }  
           },  
           {  
                field: 'EmailId', title: 'Email', dataSet: { type: DataType.String }  
           },  
           {  
                field: 'IsActive', title: 'Is User Active',  
                dataSet: { type: DataType.Boolean, defaultSortOrder: SortOrder.desc }  
           },  
      ],  
      Url: 'users/list',  
 });

This is just an example of coding practice, but this kind of approach shall be used at any places where ever we are relying heavily on single type of usage.
Happy coding!


Labels:

Comments

Post a Comment

Popular posts from this blog

Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers. Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer. The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work. With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones. These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to ...
4 comments
Read more

Making FluentValidation compatible with Swagger including Enum or fixed List support

FluentValidation is not directly compatible with Swagger API to validate models. But they do provide an interface through which we can compose Swagger validation manually. That means we look under FluentValidation validators and compose Swagger validator properties to make it compatible. More of all mapping by reading information from FluentValidation and setting it to Swagger Model Schema. These can be done on any custom validation from FluentValidation too just that proper schema property has to be available from Swagger. Custom validation from Enum/List values on FluentValidation using FluentValidation.Validators; using System.Collections.Generic; using System.Linq; using static System.String; /// <summary> /// Validator as per list of items. /// </summary> /// <seealso cref="PropertyValidator" /> public class FixedListValidator : PropertyValidator { /// <summary> /// Gets the valid items /// <...
1 comment
Read more

Architecture solution composting Repository Pattern, Unit Of Work, Dependency Injection, Factory Pattern and others

Project architecture is like garden, we plant the things in certain order and eventually they grow in similar manner. If things are planted well then they will all look(work) great and easier to manage. If they grow as cumbersome it would difficult to maintain and with time more problems would be happening in maintenance. There is no any fixed or known approach to decide project architecture and specially with Agile Methodology. In Agile Methodology, we cannot predict how our end products will look like similarly we cannot say a certain architecture will fit well for entire development lifespan for project. So, the best thing is to modify the architecture as per our application growth. I understand that it sounds good but will be far more problematic with actual development. If it is left as it is then more problems will arise with time. Just think about moving plant vs a full grown tree. Coming to technical side, In this article, I will be explaining about the various techniques ...
Post a Comment
Read more

Handling JSON DateTime format on Asp.Net Core

This is a very simple trick to handle JSON date format on AspNet Core by global settings. This can be applicable for the older version as well. In a newer version by default, .Net depends upon Newtonsoft to process any JSON data. Newtonsoft depends upon Newtonsoft.Json.Converters.IsoDateTimeConverter class for processing date which in turns adds timezone for JSON data format. There is a global setting available for same that can be adjusted according to requirement. So, for example, we want to set default formatting to US format, we just need this code. services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.DateTimeZoneHandling = "MM/dd/yyyy HH:mm:ss"; });
1 comment
Read more

Using Redis distributed cache in dotnet core with helper extension methods

Redis cache is out process cache provider for a distributed environment. It is popular in Azure Cloud solution, but it also has a standalone application to operate upon in case of small enterprises application. How to install Redis Cache on a local machine? Redis can be used as a local cache server too on our local machines. At first install, Chocolatey https://chocolatey.org/ , to make installation of Redis easy. Also, the version under Chocolatey supports more commands and compatible with Official Cache package from Microsoft. After Chocolatey installation hit choco install redis-64 . Once the installation is done, we can start the server by running redis-server . Distributed Cache package and registration dotnet core provides IDistributedCache interface which can be overrided with our own implementation. That is one of the beauties of dotnet core, having DI implementation at heart of framework. There is already nuget package available to override IDistributedCache i...
3 comments
Read more

Using LINQ to Entity efficiently with First/FirstOrDefault/Last/LastOrDefault/Single/SingleOrDefault

We generally use these extension methods First/FirstOrDefault/Last/LastOrDefault/Single/SingleOrDefault with predicates like ctx=> ctx.Model.FirstOrDefault(item => item.Id == 1 ) Or ctx=> ctx.Model.Where(item => item.Id == 1 ).FirstOrDefault() What is the problem with these? FirstOrDefault or similar methods immediately loads all data at once. So, let's say we have fifty columns on table then all those columns data would be retrieved from DB and saved into memory. This link gives a fair idea of different function behavior.  https://msdn.microsoft.com/en-us/library/bb882641.aspx .  So, even if we require only one value from selected field it retrieves all values. What is the solution? The solution is pretty simple. Whenever we need selected items better to do projection before calling FirstOrDefault or similar methods. Ex: Selecting single item ctx.Model.Where(itm => itm.Id == 1) .Select(itm => itm.Name).FirstO...
Post a Comment
Read more

Kendo MVC Grid DataSourceRequest with AutoMapper

Kendo Grid does not work directly with AutoMapper but could be managed by simple trick using mapping through ToDataSourceResult. The solution works fine until different filters are applied. The problems occurs because passed filters refer to view model properties where as database model properties are required after AutoMapper is implemented. So, the plan is to intercept DataSourceRequest  and modify names based on database model. To do that we are going to create implementation of  CustomModelBinderAttribute to catch calls and have our own implementation of DataSourceRequestAttribute from Kendo MVC. I will be using same source code from Kendo but will replace column names for different criteria for sort, filters, group etc. Let's first look into how that will be implemented. public ActionResult GetRoles([MyDataSourceRequest(GridId.RolesUserGrid)] DataSourceRequest request) { if (request == null) { throw new Argume...
Post a Comment
Read more

Configuring Ninject, Asp.Net Identity UserManager, DataProtectorTokenProvider with Owin

It can be bit tricky to configure both Ninject and Asp.Net Identity UserManager if some value is expected from DI to configure UserManager. We will look into configuring both and also use OwinContext to get UserManager. As usual, all configuration need to be done on Startup.cs. It is just a convention but can be used with different name, the important thing is to decorate class with following attribute to make it Owin start-up: [assembly: OwinStartup(typeof(MyProject.Web.Startup))] Ninject configuration Configuring Ninject kernel through method which would be used to register under Owin. Startup.cs public IKernel CreateKernel() { var kernel = new StandardKernel(); try { //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>(); // TODO: Put any other injection which are required. return kernel; } catch { kernel.Dispose(); thro...
Post a Comment
Read more

Visual Studio 2015 Code Analyzer and configuration with StyleCop

What is Diagnostic/Code Analyzer? To put it simply it is something similar to Resharper or Telerik JustCode. It analyzes codes while writing on code editor and suggest for improvements of codes through Squiggles, light icon and based on various severity. How it works? I had mentioned that it is similar to Resharper and Telerik JustCode but internal infrastructure is completely different. It is dependent on new compiler Roslyn . Roslyn has a clever compile technique, unlike older version which makes it faster and flexible for dynamic compilation without the need of the entire code base. The structure is basically divided into two categories Syntax Tree , and Semantic Model . The syntax tree is related to syntaxes only it does not require any reference check. It can be related to DOM elements structure in case of HTML.  Syntax Tree consists of very fine details as simple as WhiteSpace under the code. The Semantic Model is kind of references of Syntax Tree in which it ...
Post a Comment
Read more

Channel, ChannelReader and ChannelWriter to manage data streams in multi-threading environment

I came across Channel class while working with SignalR which looks really interesting. By looking into NuGet packages ( https://www.nuget.org/packages/System.Threading.Channels ), it seems just 4 months old. The Channel class provides infrastructure to have multiple reads and write simuletensely through it's Reader and Writer properties. This is where it is handy in case of SignalR where data streaming needs to be done but is not just limited to that but wherever something needs to be read/write/combination of both in a multi-threading environment. In my case with SignalR, I had to stream stock data at a regular interval of time. public ChannelReader<StockData> StreamStock() { var channel = Channel.CreateUnbounded<StockData>(); _stockManager.OnStockData = stockData => { channel.Writer.TryWrite(stockData); }; return channel.Reader; } The SignalR keeps return type of ChannelReader<StockData> open so that whatev...
Post a Comment
Read more