Skip to content

README.md

Latest commit

 

History

History
240 lines (171 loc) · 14.6 KB

README.md

File metadata and controls

240 lines (171 loc) · 14.6 KB
Raw

Grid Blazor

GridBlazor is a Blazor component that shows data in a grid. It requires a back-end component that performs paging, sorting, filtering and others.

This back-end component can be one of the following:

  • GridCore (v.6.0.0 or later), supporting ASP.Net Core 3.1, ASP.Net 5.0, ASP.Net 6.0, ASP.Net 7.0, ASP.Net 8.0 and ASP.Net 9.0. GridMvcCore, that it is a fork from https://gridmvc.codeplex.com/, was working for earlier versions. But GridMvcCore is only required for Blazor WASM (REST) and ASP.NET MVC projects now.
  • an OData back-end. All samples are based on Microsoft.AspNetCore.OData library, but it can be any other OData provider.
  • GridJavaCore back-end for Java JPA / Hibernate projects (https://github.com/gustavnavar/Grid.Java.Core)

GridBlazor supports .NET Core 3.1 and 5.0, 6.0, 7.0, 8.0 and 9.0, and Blazor WebAssembly 3.2.0, 5.0, 6.0, 7.0, 8.0 and 9.0

Demo

Documentation

There are native C# Grid components for Blazor client-side and server-side, and for ASP.NET Core MVC.

You can find the specific documentation for each environment clicking the following links:

This is an example of a table of items using this component:

Image of GridBlazor

Migration to GridBlazor 6.4.0 and GridCore / GridMvcCore / GridShared 8.4.0 from earlier versions

This release changes how dates are displayed. What travels between the client and the server is unchanged - filter values and query strings are still ISO 8601 (yyyy-MM-dd) - so no back-end change is needed and a grid can be upgraded on its own.

  1. Dates now follow the reader's locale. A date used to be written yyyy-MM-dd for everybody; it is now written the way the reader writes dates, with the day and the month padded to two digits. Nothing has to be done to get this.

  2. A column that sets its own format keeps it. Format now takes precedence over the locale, so a column defined as Format("{0:yyyy-MM-dd}") goes on showing ISO to every reader. Grids that pinned that format on every date column - which was the only way to get a stable date before - should remove it to follow the reader:

        c.Add(o => o.OrderDate).Format("{0:yyyy-MM-dd}");   // before: the only stable option
    c.Add(o => o.OrderDate);                            // now: written as the reader writes it

  3. A DateTime column with no format shows its date alone. It used to fall back to ToString(), which appended the time of day and its seconds - 01/09/2026 0:00:00. Where the hour matters the column has to say so now, with Format("{0:g}") or any pattern spelling both halves. Editing is unaffected: the CRUD form still edits the whole value.

  4. System.TimeSpan columns are filtered as durations. They used to fall through to the text filter, so the operators offered were the text ones and a duration was compared as a string. They now get their own filter type and the clock widget, with the ordered operators - equals, not equals, greater than, less than and their inclusive forms. A stored grid state or a saved URL that applies a text operator to a TimeSpan column will no longer filter as it did.

  5. Update the static assets together with the package. gridblazor.js and the CSS files ship with GridBlazor and are versioned with it. Projects that copied them into their own wwwroot instead of referencing _content/GridBlazor/... must take the new versions: the component calls JavaScript functions that did not exist before, and the new picker has no styles without the new CSS. A browser holding an old copy in cache shows it as a picker that will not open, so force a reload after upgrading.

  6. New, and entirely opt-in: SetDateInputMode. The default is DateInputMode.Browser, which is exactly the behaviour of earlier versions - the native <input type="date"> and its relatives. Only an application that chooses its own culture, rather than taking the browser's, needs DateInputMode.Grid; see Using a date time filter.

  7. If you maintain a CSS theme derived from the shipped ones, note that the picker rules now live only in gridblazor.css. The per-theme files no longer carry a copy of them.

  8. SetInputType is now honoured on DateOnly and TimeOnly columns, which used to ignore it and always render a plain date or time control. A column that asked for InputType.Month on a DateOnly now gets a month control, which is what it asked for. In the other direction, a date column set to an input type a date cannot be - Text, TextArea, File, Number - now falls back to its natural control instead of rendering <input type=""> and reading its value with the current culture.

Migration to GridBlazor 3.5.0 and GridCore 5.5.0 from GridBlazor 3.0.0 and GridCore 5.0.0 for Blazor WASM projects with REST back-end

  1. You have to remove the package GridCore and install the package GridMvcCore, and upgrade the GridBlazor package

  2. You must replace all GridCore instances by GridServer ones

  3. The Grid property of the GridServer object has an SGrid<T> type, instead of ISGrid<T> it was before. You should change any reference to this property to reflect this change.

  4. Some classes have been moved from the GridCore package to the GridMvc one. Change all required using ... as needed.

Migration to GridBlazor 3.0.0 and GridCore 5.0.0 for all Blazor projects except Blazor WASM (REST) ones

  1. You have to remove the package GridMvcCore and install the package GridCore, and upgrade the GridBlazor package

  2. You must replace all GridServer instances by GridCore ones

  3. The Grid property of the GridCore object has an ISGrid<T> type, instead of SGrid<T> it was before. You should change any reference to this property to reflect this change.

  4. Some classes have been moved from the GridMvc package to the GridCore one. Change all required using ... as needed.

Migration to GridBlazor 3.0.0 and GridMvc 5.0.0 for Blazor WASM (REST) projects

  1. You have to upgrade the GridMvcCore and GridBlazor packages

  2. The Grid property of the GridServer object is of type ISGrid<T>, instead of SGrid<T> it was before. You should change any reference to this property to reflect this change.

  3. Some classes have been moved from the GridMvc package to the GridCore one. Change all required using ... as needed.

Notes

  • GridBlazor 6.0.0 supports the following CSS frameworks:

  • GridBlazor 3.4.1 supports the build-in InputFile component for columns of type "file" for .Net 6.0 and later projects. The old Agno.BlazorInputFile component is ussed for .Net Core 3.1 and .Net 5.x projects. See https://github.com/gustavnavar/Grid.Blazor/blob/master/docs/blazor_client/Crud.md#file-type-columns

  • GridBlazor 3.0.0 supports .Net 6.0

  • GridMvcCore has been split in 2 parts from version 5.0.0 on:

    • GridCore: it includes all code necessary for the back-end Blazor applications (data processing, filtering, sorting, etc.), excluding all MVC dependencies (Razor view and pages rendering).
    • GridMvcCore: it only includes all MVC dependencies required for rendering Razor views and pages.

  • Sorting is implemented on GridBlazor 2.1.2, GridMvcCore 4.1.2 and newer versions following this sequence "no sort" -> "sort ascending" -> "sort descending" -> "no sort" and so on when a column title is clicked

  • GridMvcCore 3.0.0 does not support .Net Core 2.x. It requires .NET Core 3.1

  • GridBlazor 1.6.7 requires a change on the column definition when selecting rows with checkboxes using the SetCheckboxColumn method. It's mandatory to identify the columns that are primary keys for the grid. You must do it using the SetPrimaryKey(true) method for the primary key columns' definitions:

        c.Add("CheckboxColumn").SetCheckboxColumn(true, o => o.Customer.IsVip);
    c.Add(o => o.OrderID).SetPrimaryKey(true);

  • GridBlazor 1.6.2 doesn't support the CheckedRows property anymore. CheckedRows only allowed to retrieve the checked values, but not to change them. Use the Checkboxes property instead of it.

  • GridBlazor 1.5.0 supports OData server back-ends for Blazor WA applications. More info here

  • Versions before GridBlazor 1.3.9 had the keyboard navigation enabled by default. This feature requires to focus on the grid element, but it can create problems when used on pages with 2 or more grids. As a consequence, starting with version 1.3.9 it has to be explicitly configured for each grid that requires keyboard navigation. Users can enable keyboard navigation between pages using the SetKeyboard method of the GridClient object:

        var client = new GridClient<Order>( ... ).SetKeyboard(true);

  • Grid components have been moved to GridBlazor.Pages folder in GridBlazor 1.3.2. You must add a reference to this namespace in the _Imports.razor:

        @using GridBlazor.Pages

  • Blazor Server App require these changes on to the _Host.cshtml file for .Net Core 3.1:

        <link href="_content/GridBlazor/css/gridblazor.min.css" rel="stylesheet" />
    <script src="_content/GridBlazor/js/gridblazor.js"></script>

  • Blazor WebAssembly projects require these changes on to the wwwroot/index.html file for version 3.2.0 Preview 1:

        <link href="_content/GridBlazor/css/gridblazor.min.css" rel="stylesheet" />
    <script src="_content/GridBlazor/js/gridblazor.js"></script>

  • Blazor WebAssembly projects require to use a new constructor of the GridClient object including an HttpClient object from Dependency Injection for .Net Core 3.1:

        @page "/..."
    @inject HttpClient httpClient

    ...

    protected override async Task OnParametersSetAsync()
    {
        ...
        var client = new GridClient<Order>(httpClient, url, query, false, "ordersGrid", Columns);
        ...
    }

  • The button to clear all filters is disabled by default starting from GridBlazor version 1.3.6. You can enable it using the ClearFiltersButton method of the GridClient object:

        var client = new GridClient<Order>(httpClient, url, query, false, "ordersGrid", Columns).ClearFiltersButton(true);

Change Log

https://github.com/gustavnavar/Grid.Blazor/releases

Folder description

The SQL Server database for all demos can be downloaded from here

Alternatively, if you prefer to install a fresh version of the database you can perform the following steps:

  • run this script from Microsoft web to create a new database: https://github.com/microsoft/sql-server-samples/blob/master/samples/databases/northwind-pubs/instnwnd.sql
  • add a column to the Customers table with the name IsVip of type bit (NOT NULL) and default value 0: 
        USE Northwind;
    ALTER TABLE dbo.Customers ADD IsVip bit NOT NULL DEFAULT 0 WITH VALUES;
    GO
  • change manually some values of the new IsVip column to True
  • review the datetime columns. Any mismatch between EF Core model and database definitions will produce an exception and filtering will not work as expected. If database columns are defined as datetime you must modify the NorthwindDbContext class including: 
        modelBuilder.Entity<Order>().Property(r => r.OrderDate).HasColumnType("datetime");
    for each datetime column. Or you can change all database columns' type to datetime2(7).