Gridify 1.0.0

Additional Details

Gridify library APIs and object names change. please upgrade to the latest version

There is a newer version of this package available.
See the version list below for details.
dotnet add package Gridify --version 1.0.0
NuGet\Install-Package Gridify -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Gridify" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Gridify --version 1.0.0
#r "nuget: Gridify, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Gridify as a Cake Addin
#addin nuget:?package=Gridify&version=1.0.0

// Install Gridify as a Cake Tool
#tool nuget:?package=Gridify&version=1.0.0

Gridify

Easy and optimize way to apply paging, filtering and sorting using string based conditions and filed names.

The best use case of this library is Aspnet APIs when you need to get some string base filtering conditions or sort data by filed name or order data by propery name and use that information to retrieve requested data from a repository or database. at the end send back pageable sorted and filtered data to the user.

Available Extentions

Extention Description
ApplyFiltering Apply Filtering using string Filter property of QueryObject class and returns an IQueryable<T>
ApplyOrdering Apply Ordering using string SortBy and bool IsSortAsc properties of QueryObject class and returns an IQueryable<T>
ApplyPaging Apply paging using short Page and int PageSize properties of QueryObject class and returns an IQueryable<T>
ApplyOrderingAndPaging Apply Both Ordering and paging and returns an IQueryable<T>
ApplyEverything Apply Filtering,Ordering and paging and returns an IQueryable<T>
ApplyEverythingWithCount Like ApplyEverything but it returns a tuple (int Count,IQueryable<T> DataQuery). we can use Count, to create our pages.
Gridify Receives a QueryObject ,Load All requested data and returns Paging<T>. (Paging Class Has int TotalItems and List<T> Items)

Supported Filtering Operators

Name Operator Usage example
Equal == "FieldName == Value"
NotEqual != "FieldName != Value"
GreaterThan << "FieldName << Value"
LessThan >> "FieldName >> Value"
GreaterThanOrEqual >= "FieldName >= Value"
LessThanOrEqual <= "FieldName <= Value"
Contains - Like =* "FieldName =* Value"
NotContains - NotLike !* "FieldName =* Value"
AND - && , "FirstName==Value , LastName==Value2"
OR - || \| "FirstName==Value \| LastName==Value2"
Parenthesis () "( FirstName=* Jo , Age<<30) \| ( FirstName != Hn , Age>>30 )"

we can easily create complex queries using Parenthesis() with AND (,) + OR (|) operators.

Basic Usage example

// usually, we don't need to create this object manually
// for example, we get this object as a parameter from our API Controller
var filter = new QueryObject() 
{
    Filter = "FirstName == John",
    IsSortAsc = false,
    Page = 1,
    PageSize = 20,
    SortBy = "LastName"
};

Paging<Person> pData =
         myDbContext.Persons  // we can use Any list or repository or EntityFramework context
          .Gridify(filter); // Filter,Sort & Apply Paging 
          

// pData.TotalItems => Count persons with 'John', First name
// pData.Items      => First 20 Persons with 'John', First Name

Collaboration

Any collaboration to improve documentation and library is appreciated feel free to send pullrequest. ❤️

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages (9)

Showing the top 5 NuGet packages that depend on Gridify:

Package Downloads
Gridify.EntityFramework

Gridify (EntityFramework), Easy and optimized way to apply Filtering, Sorting, and Pagination using text-based data.

DataExplorer

Library featuring an opinionated, reusable data access layer offering abstractions and implementations for SQL storages (EF Core).

KoloDev.GDS.UI

Kolo GDS UI Accelerator

NiuX.Common

csharp common, utils, helpers, tools etc.

Gridify.EntityFramework5

Gridify (EntityFramework), Easy and optimized way to apply Filtering, Sorting, and Pagination using text-based data.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.14.2 650 6/8/2024
2.14.1 97,602 12/4/2023
2.14.0 5,463 11/18/2023
2.13.1 1,720 11/12/2023
2.13.0 211 11/11/2023
2.12.0 4,441 10/27/2023
2.11.1 19,582 10/6/2023
2.11.0 154 10/5/2023
2.10.1 3,844 9/28/2023
2.10.0 2,101 9/20/2023
2.10.0-Preview1 92 9/19/2023
2.9.2 2,253 9/15/2023
2.9.1 9,096 8/22/2023
2.9.0 1,795 8/18/2023
2.8.4 61,309 4/18/2023
2.8.3 23,712 3/4/2023
2.8.2 46,115 12/7/2022
2.8.1 121,617 10/7/2022
2.8.0 10,257 7/22/2022
2.7.5 27,994 6/6/2022
2.7.4 23,657 4/22/2022
2.7.3 9,784 4/13/2022
2.7.2 1,016 4/12/2022
2.7.1 7,864 3/2/2022
2.7.0 736 3/1/2022
2.6.0 17,122 1/14/2022
2.5.0 4,666 12/27/2021
2.4.8 4,235 12/15/2021
2.4.7 388 12/14/2021
2.4.6 415 12/10/2021
2.4.5 587 12/5/2021
2.4.5-alpha5 186 12/5/2021
2.4.5-alpha4 186 12/5/2021
2.4.5-alpha3 151 12/2/2021
2.4.5-alpha1 158 12/2/2021
2.4.4 20,397 11/20/2021
2.4.3 801 11/19/2021
2.4.2 830 11/19/2021
2.4.1 1,422 11/18/2021
2.4.0 512 11/18/2021
2.3.3 545 11/16/2021
2.3.2 955 11/1/2021
2.3.1 1,306 10/19/2021
2.3.0 4,773 10/4/2021
2.2.1 465 9/30/2021
2.2.0 481 9/28/2021
2.1.0 4,107 9/21/2021
2.0.0 444 9/18/2021
2.0.0-beta.3 145 9/17/2021
2.0.0-beta.2 141 9/16/2021
2.0.0-beta.1 190 9/15/2021
2.0.0-alpha.1 185 8/12/2021
1.4.2 8,091 8/8/2021
1.4.1 563 8/4/2021
1.4.0 491 8/4/2021
1.3.5 554 7/28/2021
1.3.4 2,138 7/16/2021
1.3.3 648 7/1/2021
1.3.2 640 6/30/2021
1.3.1 632 6/23/2021
1.1.2 1,558 4/16/2021
1.1.1 585 4/16/2021
1.1.0 1,647 9/17/2020
1.0.5 7,881 7/3/2020
1.0.3 792 7/2/2020
1.0.2 923 7/2/2020
1.0.1 950 7/2/2020
1.0.0 1,135 7/1/2020