Paging TagHelper v3.1

Sample : Cultures Table

Culture Id English name Native name Two letter ISO language name
4096 Makhuwa-Meetto Makua mgh
4096 Makhuwa-Meetto (Mozambique) Makua (Umozambiki) mgh
4096 Makonde Chimakonde kde
4096 Makonde (Tanzania) Chimakonde (Tanzania) kde
4096 Malagasy Malagasy mg
4096 Malagasy (Madagascar) Malagasy (Madagasikara) mg
62 Malay Melayu ms
2110 Malay (Brunei) Melayu (Brunei) ms
1086 Malay (Malaysia) Melayu (Malaysia) ms
4096 Malay (Singapore) Melayu (Singapura) ms
76 Malayalam മലയാളം ml
1100 Malayalam (India) മലയാളം (ഇന്ത്യ) ml
58 Maltese Malti mt
1082 Maltese (Malta) Malti (Malta) mt
88 Manipuri মৈতৈলোন্ mni
1112 Manipuri (India) মৈতৈলোন্ (India) mni
4096 Manx Gaelg gv
4096 Manx (Isle of Man) Gaelg (Ellan Vannin) gv
129 Maori te reo Māori mi
1153 Maori (New Zealand) te reo Māori (Aotearoa) mi
122 Mapudungun Mapudungun arn
1146 Mapudungun (Chile) Mapudungun (Chile) arn
78 Marathi मराठी mr
1102 Marathi (India) मराठी (भारत) mr
4096 Masai Maa mas
4096 Masai (Kenya) Maa (Kenya) mas
4096 Masai (Tanzania) Maa (Tansania) mas
4096 Mazanderani مازرونی mzn
4096 Mazanderani (Iran) مازرونی (ایران) mzn
4096 Meru Kĩmĩrũ mer
4096 Meru (Kenya) Kĩmĩrũ (Kenya) mer
4096 Metaʼ metaʼ mgo
4096 Metaʼ (Cameroon) metaʼ (Kamalun) mgo
124 Mohawk Kanien’kéha moh
1148 Mohawk (Mohawk) Kanien'kéha moh
80 Mongolian монгол mn
30800 Mongolian монгол mn
1104 Mongolian (Mongolia) монгол (Монгол) mn
31824 Mongolian (Traditional Mongolian) ᠮᠣᠩᠭᠣᠤᠯ ᠬᠡᠯᠡ mn
2128 Mongolian (Traditional Mongolian, China) ᠮᠣᠩᠭᠣᠤᠯ ᠬᠡᠯᠡ (ᠪᠦᠭᠦᠳᠡ ᠨᠠᠢᠷᠠᠮᠳᠠᠬᠤ ᠳᠤᠮᠳᠠᠳᠤ ᠠᠷᠠᠳ ᠣᠯᠣᠰ) mn
3152 Mongolian (Traditional Mongolian, Mongolia) ᠮᠣᠩᠭᠣᠯ ᠬᠡᠯᠡ (ᠮᠣᠩᠭᠣᠯ ᠣᠯᠣᠰ) mn
4096 Morisyen kreol morisien mfe
4096 Morisyen (Mauritius) kreol morisien (Moris) mfe
4096 Mundang MUNDAŊ mua
4096 Mundang (Cameroon) MUNDAŊ (kameruŋ) mua
4096 Nama Khoekhoegowab naq
4096 Nama (Namibia) Khoekhoegowab (Namibiab) naq
97 Nepali नेपाली ne
2145 Nepali (India) नेपाली (भारत) ne
1121 Nepali (Nepal) नेपाली (नेपाल) ne

Minimum settings

Only below parameters is required to create pagination control.

HTML Code

<paging total-records="Model.TotalRecords"
        page-no="Model.PageNo"
        page-size="Model.PageSize">
</paging>
Result

Turn off all extras

Show/Hide Previous and Next buttons

HTML Code

    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            show-prev-next="false"
            show-first-last="false"
            show-total-pages="false"
            show-total-records="false"
            show-page-size-nav="false"
            show-first-numbered-page="false"
            show-last-numbered-page="false">
    </paging>
Result

Maximum displayed pages

Increase/decrease the amount of displayed page numbers to arrange better replacment on wider/small screens

Default: 10

HTML Code

    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            max-displayed-pages="5">
    </paging>
Result
17 pages841 records

Gap Size

  • gap-size: The difference of pages between first page and first displayed page. Or, the amount of pages between last page (total pages) and last displayed page.
    If the difference is larger than the gap size then the most first/last page will be displayed with "..." (three dots) before or after.
    e.g.: 1 ... 4 5 [6] 7 8 ... 100
HTML Code

    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            max-displayed-pages="5"
            gap-size="2">
    </paging>
Result
17 pages841 records

Change page size

Default page size is 10, it can be changed to any other number. When a differet page size is used we have to specify the query string key name for page size parameter.

  • page-size-nav-block-size : The block size for the dropdown items.
  • page-size-nav-max-items : How many items to display in the dropdown.
HTML Code

    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            max-displayed-pages="5"
            page-size-nav-block-size="15"
            page-size-nav-max-items="5">
    </paging>
Result
17 pages841 records

Query String Key Names

Current page number and page size values are added to the query string by the keys "P" and "S".
e.g. /index?p=1&s=10.

To change the query string key names use below attributes:

  • query-string-key-page-no : key name for page number. default is "p".
  • query-string-key-page-size : key name for page size. default is "s".
HTML Code

    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            max-displayed-pages="5"
            query-string-key-page-no="pageNo"
            query-string-key-page-size="pageSize">
    </paging>
Result
/index?pageNo=1&pageSize=10

Styling

PagingTagHelper uses bootstrap 4.x styling classes by default. The default structure is like below:


<!-- main div -->
<div class="row">
    <!-- paging control div -->
    <div class="col-8">
        <!-- paging control : 1 [2] 3 4 5 -->
    </div>
    
    <!-- info div -->
    <div class="col-2">
        <!-- info badges: totals records / total pages -->
    </div>
    
    <!-- page size div -->
    <div class="col-2">
        <!-- page size dropdown : Page size 10-20-30 -->
    </div>
</div>

  • class :

    Relevant to the most outer div that contains all controls.
    Default: "row"

  • class-paging-control-div :

    The div that contains the paging numbers.
    Default: "col-8"

  • class-info-div :

    The div that contains the info badges for total pages/total records.
    Default: "col-2"

  • class-page-size-div :

    The div that contains page size dropdown control and its label.
    Default: "col-2"

  • class-paging-control :

    The unordered list control that holds the page numbers. For better understanding Bootstrap pagination.
    Default: "pagination"

  • class-active-page :

    Selected page class.
    Default: "active"

  • class-disabled-jumping-button :

    First/Last and Previous/Next buttons while not active.
    Default: "disabled"

  • class-total-pages :

    Total pages info badge.
    Default: "badge badge-secondary"

  • class-total-records :

    Total records info badge.
    Default: "badge badge-info"

HTML Code

    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            max-displayed-pages="5"
            class="row"
            class-paging-control-div="col-8"
            class-info-div="col-2"
            class-page-size-div="col-2"
            class-paging-control="pagination"
            class-active-page="active"
            class-disabled-jumping-button="disabled"
            class-total-pages="badge badge-secondary"
            class-total-records="badge badge-info">
    </paging>

Custom Labels

All labels except page numbers can be customized as below:

  • text-first : Label for "goto first page" button

    default: "&laquo;" ( « )

  • text-last : Label for "goto last page" button

    default: "&raquo;" ( » )

  • text-previous : Label for "goto previous page" button

    default: "&lsaquo;" ( ‹ )

  • text-next : Label for "goto next page" button

    default: "&rsaquo;" ( › )

  • text-total-pages : Label for "total pages" info badge

    default: "Pages"

  • text-total-records : Label for "total records" info badge

    default: "Records"

  • text-page-size : Label for "page size" dropdown

    default: "Page size"

  • sr-text-first : Label for screen readers

    default: "First"

  • sr-text-last : Label for screen readers

    default: "Last"

  • sr-text-next : Label for screen readers

    default: "Next"

  • sr-text-previous : Label for screen readers

    default: "Previous"

HTML Code

    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            max-displayed-pages="5"
            text-first="&laquo;"
            text-last="&raquo;"
            text-previous="&lsaquo;"
            text-next="&rsaquo;"
            text-total-pages="Pages"
            text-total-records="Records"
            text-page-size="Page size"
            sr-text-first="First"
            sr-text-last="Last"
            sr-text-next="Next"
            sr-text-previous="Previous">
    </paging>

Json Settings

All default settings can be overrided in appsettings.json file and it will affect all paging tag helpers in the application. Any settings defined inside the tag helper will override the default and json settings.

the default json settings can be overrided in appSettings.json, below is a full list of all settings in json format:


{
    "lazziya": {
        "pagingTagHelper": {
          "default": {
            "page-no": 1,
            "page-size": 10,
            "total-records": 0,
            "max-displayed-pages": 10,
            "gap-size": 3,
            "page-size-nav-block-size": 10,
            "page-size-nav-max-items": 5,
            "query-string-key-page-no": "p",
            "query-string-key-page-size": "s",
            "show-first-last": true,
            "show-prev-next": true,
            "show-page-size-nav": true,
            "show-total-pages": true,
            "show-total-records": true,
            "show-first-numbered-page": true,
            "show-last-numbered-page": true,
            "text-page-size": "Page size",
            "text-first": "«",
            "text-last": "»",
            "text-previous": "‹",
            "text-next": "›",
            "text-total-pages": "pages",
            "text-total-records": "records",
            "sr-text-first": "First",
            "sr-text-last": "Last",
            "sr-text-previous": "Previous",
            "sr-text-next": "Next",
            "class": "row",
            "class-info-div": "col-2",
            "class-page-size-div": "col-2",
            "class-paging-control-div": "col-8",
            "class-paging-control": "pagination",
            "class-active-page": "active",
            "class-disabled-jumping-button": "disabled",
            "class-total-pages": "badge badge-secondary",
            "class-total-records": "badge badge-info"
          }
        }
    }
}

More than one settings collection can be defined inside appSettings.json file, so each paging helper element can read settings from different collection.

it is not necessary to override all the settings inside json file, it is possible to mention only the settings we want to override.

e.g. below there is two settings collections "basic" and "custom", each can be applied to different set of paging helpers inside your application.


{
    "lazziya": {
        "pagingTagHelper": {
            "basic": {
                "show-first-last": true,
                "max-displayed-pages": 7,
                "class-active-aage": "disabled"
              },
              "custom": {
                "show-first-last": true,
                "show-prev-next": true,
                "show-first-numbered-page": true,
                "show-last-numbered-page": true,
                "max-displayed-pages": 2,
                "text-first": "go first",
                "text-last": "go last",
                "text-previous": "one step back",
                "text-next": "one step forward",
                "class-paging-control": "pagination pagination-lg"
              }
        }
    }
}
HTML Code

    <!-- basic settings -->
    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            settings-json="basic">
    </paging>

    <!-- custom settings -->
    <paging total-records="Model.TotalRecords"
            page-no="Model.PageNo"
            page-size="Model.PageSize"
            settings-json="custom">
    </paging>
Result for "basic" settings
Result for "custom" settings