Skip to content

README.md

Latest commit

 

History

History
116 lines (73 loc) · 3.66 KB

README.md

File metadata and controls

116 lines (73 loc) · 3.66 KB

What is QueryMaker.Grid?

QueryMaker.Grid is a datagrid component built using QuickGrid which adds integrated functionality for filtering, pagination, sorting using QueryMaker with virtualization for showing the column options.


Installation

Install QueryMaker.Grid from the package manager console:

PM> Install-Package QueryMaker.Grid

Or from the .NET CLI as:

dotnet add package QueryMaker.Grid

How To Use

First, on our .NET API project we create an endpoint which receives an instance of QueryMaker and returns the filtered resuts of some entity for our grid with both the array of paginated items and the total ammount using QueryMaker.GetDataAsync:

using QueryMakerLibrary;
using QueryMakerLibrary.GetDataAsync;

[HttpPost(Name = "getGridData")]
public async Task<IActionResult> GetGridData([FromBody] QueryMaker query)
{
  // first, we make the queries using QueryMaker to get the data asynchronously
  QueryMakerData<T> data = await _dbContext.SomeEntity.MakeQueryResult(queryMaker).GetDataAsync();

  // then, we return the resulting Items and TotalAmmount
  return Ok(new
  {
    data.Items,
    data.TotalAmmount
  });
}

Now, on our Blazor project we can use the QueryMakerGrid component to consume this endpoint and populate our grid:

@using QueryMakerLibrary.Grid.Components
@using QueryMakerLibrary.Grid.Providers
@using QueryMakerLibrary.Grid.Common

@inject HttpClient Http

@* we instantiate our QueryMakerGrid component with its columns and DataProvider *@
<QueryMakerGrid DataProvider="@(async request => await GetData(request))" PaginationState="@PaginationState">
  <QueryMakerGridColumn Virtualize="true" Sortable="true" Title="Name" Property="@(x => x.Name)" />
  <QueryMakerGridColumn SearchWhileTyping="false" Title="Status" Property="@(x => x.Status)" />
</QueryMakerGrid>

@* to add pagination we need to use the QueryMakerGridPaginator component *@
@* and provide the PaginationState to the grid *@
<QueryMakerGridPaginator State=@PaginationState />

@code
{
  // property for providing pagination to the grid initialized with a count of 25 items per page
  // and optionally using an 'Id' property as index for faster pagination
  private QueryMakerGridPaginationState PaginationState = new(25, "Id");

  // method for getting the data from our API sending a QueryMaker instance
  public async Task<QueryMakerGridItemsProviderResult<YourGridType>> GetData(
    QueryMakerGridItemsProviderRequest request, CancellationToken cancellationToken = default)
    {
      return (await (await Http.PostAsJsonAsync("{myAPIUrl}/GetGridData",
        request.Query, cancellationToken))
        .Content.ReadFromJsonAsync<QueryMakerGridItemsProviderResult<YourGridType>>());
    }
}

And that's it! The grid will now perform filtering, pagination, sorting, virtualization all by itself without the need for any more code on our API:

sample


License

Distributed under the GNU General Public License v3.0 License. See LICENSE.md for more information.


Contact

LinkedIn: Jose Toyos

Email: josemoises.toyosvargas@hotmail.com

Project Link: https://github.com/PRLL/QueryMaker.Grid


Copyright

©Jose Toyos 2024