P.Pager 9.0.0

<p align="center"> <img src="https://raw.githubusercontent.com/PuffinWeb/P.Pager/master/icon.png" width="25" height="25" title="Github Logo"> P.Pager</p>

What is this?

P.Pager is Lightweight package for easily paging through any IEnumerable/IQueryable, chop it up into "pages", and grab a specific "page" by an index. It supports Web projects, Winforms, WPF, Window Phone, Silverlight and other .NET projects. It is default configured to > Bootstrap 3.3.1.

How do I use it?

Installation

.Net Framework ( > 4.5.2)

Install P.Pager.Mvc via NuGet. This will install P.Pager automatically.

Install-Package P.Pager.Mvc -Version 3.0.0

.Net Core 3 to 5

Install P.Pager.Mvc.Core via NuGet. This will install P.Pager automatically.

Install-Package P.Pager.Mvc.Core -Version 3.0.0

.Net Core 6 above

Install P.Pager.Mvc.Core via NuGet. This will install P.Pager automatically.

Install-Package P.Pager.Mvc.Core

After that

1. In your controller code, call ToPagerList off of your IEnumerable/IQueryable passing in the page size.

public class HomeController : Controller
{
    readonly DemoData _data;
    public HomeController()
    {
        _data = new DemoData();
    }

    public ActionResult Index(int page = 1, int pageSize = 10)
    {
        var pager = _data.GetMembers().ToPagerList(page, pageSize);
        // will only contain 10 members max because of the pageSize.
        return View(pager);
    }
}

2. Pass the result of ToPagerList to your view where you can enumerate over it - its still an IEnumerable, but only contains a child of the original data.

3. Call Html.Pager, passing in the instance of the Pager and a function that will generate URLs for each page to see a paging control.

//Default Pager options
@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }))

PagerOptions

Default options for rendering pagination.

Properties

PagerDisplayMode

A tri-state enum that controls the visibility of portions of the PagerList paging control.

public enum PagerDisplayMode

How to use PagerOptions?

1. Shows custom page numbers, let say 10 pages.

@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), new PagerOptions { PagesToDisplay = 10 })

2. With Custom Page Text.

@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), new PagerOptions { TextToIndividualPages = "Page-{0}" })

3. Custom Wording. (<i>Can use for translation also.</i>)

@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), new PagerOptions { TextToPreviousPage = "Previous Page", TextToNextPage = "Next Page", TextToFirstPage = "First Page", TextToLastPage = "Last Page" })

4. Custom options.

@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), new PagerOptions { TextToPreviousPage = "last-page", TextToNextPage = "next-page", TextToFirstPage = "first-page", TextToLastPage = "last-page", ClassToUl = "list-inline", ClassToLi = "list-inline-item", PageClass = "nopageclass", ClassToActiveLi = "niloclass", TextForDelimiter = " | " })

5. Custom Icon Options (Fontawesome)

@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), new PagerOptions { TextToPreviousPage = "<i class='fas fa-step-backward'></i>", TextToNextPage = "<i class='fas fa-step-forward'></i>", TextToFirstPage = "<i class='fas fa-fast-backward'></i>", TextToLastPage = "<i class='fas fa-fast-forward'></i>" })

PrePagerOptions

1. Minimal Pager

//Shows only the Previous and Next links.
@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), PrePagerOptions.Minimal)

2. Minimal Pager with Pager Text (Page Count Text)

//Shows Previous and Next links along with current page number and total number of pages in pager.
@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), PrePagerOptions.MinimalWithPagerText)

3. Minimal Pager with entries text (Item Count Text)

//Shows Previous and Next links along with index of start and last item and total entries in pager.
@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), PrePagerOptions.MinimalWithEntriesText)

4. Classic Pager <small>(always shows Previous/Next links, but sometimes they are disabled)</small>

//Shows Previous and Next page always with default, 5 pages.
@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), PrePagerOptions.ClassicPager)

6. Classic Pager with First and Last<small>(Classic Pager with First and Last links, but sometimes they are disabled)</small>

//Shows Last, First, Previous and Next page always with default, 5 pages.
@Html.Pager((IPager)Model, page => Url.Action("Index", new { page }), PrePagerOptions.ClassicPagerWithFirstAndLastPages)

License

Licensed under the MIT License.