# Компонент Paging View ASP.NET Core Tag Helper

<datetime class="hidden">2025-03-11T17:12</datetime>

<!--category-- ASP.NET Core, TagHelper, PagingTagHelper -->
# Введение

Одного дня був створений проект, який потребував втілення результатів бланку прайгів. Мій шляхM SK1 до helper з тегом прайґів завжди був [Допомічник із теговами від Дарреля О'Neill ](https://github.com/darrel-oneil/PaginationTagHelper) як я писав [тут](https://www.mostlylucid.net/blog/addpagingwithhtmx) але з будь-якої причини *зупинили роботу* для мене. Тож замість того, щоб намагатися розгадати те, що виглядає як покинутий проект в цей момент я вирішив побудувати один сам

Як зазвичай, ви можете отримати джерело для цього [на моєму GitHub](https://github.com/scottgal/mostlylucid.pagingtaghelper)

У мене є прикладний сайт для цього проекту [прийманий тут](https://taghelpersample.mostlylucid.net/)

Це має зразки виjścia, як ось це:

![Подивіться на демонстрацію з допомогою вказівника](taghelpersearch.png?width=500&format=webp)

[TOC]

# Требування

Для цього помічника ярликів я мав декілька вимог:

1. Треба працювати безперешкодно з [Тайлвінд](https://tailwindcss.com/) і [DaisyUI](https://daisyui.com/); мої улюблені CSS фреймворки
2. Потрібно працювати з HTMX без жодних проблем.
3. Потрібно мати вказівник розміру сторінки, який використовує HTMX для перевертання. ( тому, якщо ви не користуєтесь HT MX, він все ще працює, але вам потрібно додати кнопку ).
4. Вона повинна бути легкою для конфігурації та використання
   1. Приймає модель плагування, тож ' є простим для використання на сторінці Razor
   2. Потрібно бути спроможним налаштувати кілька простих параметрів
5. Треба бути пакетом для нуджетів, щоб усі ви чудові люди могли гратися з ним.
6. Потрібно мати і ViewComponent, і TagHelper для того, щоб його можна було використовувати як для сторінок Razor, так і для перегляду;, зважаючи на те, що він також повинен мати надridable `Dafault.cshtml` перегляд.
7. Работає з простим пошуковим функцією.

В майбутньому я додаватиму цю здатність до

1. Додайте custom CSS, щоб уникнути прив 'язаності до DaisyUI та Tailwind~~ Я додав цю можливість, вже бачите демонстрацію тутM SK1 [https://taghelpersampleMSC1mostlylucid.netM SK3HomeMST4PlainView](https://taghelpersample.mostlylucid.net/Home/PlainView)
2. Здатність визначити розміри сторінок
3. Здатність додавати звичайний виклик JS до вказівки розміру сторінки (, щоб дозволити не використовувати HTMX).
4. Використовуйте Alpine, щоб зробити паджер більш активним і реагуючим (, як я робив у своєму [попередній artykuł](https://www.mostlylucid.net/blog/addpagingwithhtmx)).

# Установлення

Метковий помічник тепер є блискучим новим пакетом Nuget, тож ви можете його заinstalувати з наступним командою:

```bash
dotnet add package mostlylucid.pagingtaghelper
```

Ви'd потім додайте до вашого `_ViewImports.cshtml` файл як так:

```razor
@addTagHelper *, mostlylucid.pagingtaghelper
```

Тоді ви можете просто почати його використовувати; Я допоможу вам застосувати декілька класів помічників, які ви можете використати для конфігурації, наприклад

## `IPagingModel`

Це ' базові речі ' вам потрібно розпочати МSK2 це МSK3 простий інтерфейс, який ви можете реалізувати на вашій моделі для того, щоб запустити пошукову систему `ViewType` є опційним тут він по замовчуванню `TailwindANdDaisy` але ви можете налаштувати `Custom`, `Plain` або `Bootstrap` якщо ви хочете використовувати інший вид.

```csharp
public enum ViewType
{
TailwindANdDaisy,
Custom,
Plain,
Bootstrap
}
```

Або ви можете навіть визначити індивідуальний вид, використовуючи TagHelper's `use-local-view` нерухомість.

```csharp
namespace mostlylucid.pagingtaghelper.Models;

public interface IPagingModel
{
    public int Page { get; set; }
    public int TotalItems { get; set; }
    public int PageSize { get; set; }

    public ViewType ViewType { get; set; }
    
    public string LinkUrl { get; set; }
}
namespace mostlylucid.pagingtaghelper.Models;

public interface IPagingSearchModel : IPagingModel
{
    public string? SearchTerm { get; set; }
}

```

Я також реалізував їх у проекті, щоб забезпечити базову лінію

```csharp
public abstract class BasePagerModel : IPagingModel
{
    public int Page { get; set; } = 1;
    public int TotalItems { get; set; } = 0;
    public int PageSize { get; set; } = 10;
    public ViewType ViewType { get; set; } = ViewType.TailwindANdDaisy;

    public string LinkUrl { get; set; } = "";

}
public abstract class BasePagerSearchMdodel : BasePagerModel, IPagingSearchModel
{
    public string? SearchTerm { get; set; }
}
```

I' я розповім про пошукову функцію в майбутньому artykule ..

# Допомічник тагов

Потім я зрозумів, як мені хотілося б виглядати TagHelper у використанні:

```html
<paging
    x-ref="pager"
    hx-boost="true"
    hx-indicator="#loading-modal"
    hx-target="#user-list "
    hx-swap="show:none"
    model="Model"
    pages-to-display="10"
    hx-headers='{"pagerequest": "true"}'>
</paging>
```

Тут ви бачите, що я встановив декілька параметрів HTMX і модель, яку треба використовувати для плагуна. Я також встановила кількість сторінок, які потрібно відображати, і заголовки, які треба надіслати з проханням M SK1 це дозволяє мені використовувати HT MX для наповнення сторінки).

У компоненті також є BUNCH інших елементів конфігурації, через які I' працюватиме в майбутніх статьях . Як ви бачите, therer' є Множество можливих конфіfigurацій

```html
<paging css-class=""
        first-last-navigation=""
        first-page-text=""
        next-page-aria-label=""
        next-page-text=""
        page=""
        pages-to-display=""
        page-size=""
        previous-page-text=""
        search-term=""
        skip-forward-back-navigation=""
        skip-back-text=""
        skip-forward-text="true"
        total-items=""
        link-url=""
        last-page-text=""
        show-pagesize=""
        use-htmx=""
        use-local-view=""
        view-type="Bootstrap"
        htmx-target=""
        id=""
></paging>
```

TagHelper досить простий, але має купу властивостей, які дозволяють користувачам налаштувати поведінку ( ви можете побачити це внизу [перегляд](#the-view) ) за винятком властивостей МSK1, яку я виграла МSK2 не вставляйте тут для короткості ) код досить простий

```csharp
    /// <summary>
    /// Processes the tag helper to generate the pagination component.
    /// </summary>

    /// <param name="context">The tag helper context.</param>
    /// <param name="output">The tag helper output.</param>
    public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
    {
   
        output.TagName = "div";
        
        //Remove all the properties that are not needed for the rendered content.
        output.Attributes.RemoveAll("page");
        output.Attributes.RemoveAll("link-url");
        output.Attributes.RemoveAll("page-size");
        output.Attributes.RemoveAll("total-items");
        output.Attributes.RemoveAll("pages-to-display");
        output.Attributes.RemoveAll("css-class");
        output.Attributes.RemoveAll("first-page-text");
        output.Attributes.RemoveAll("previous-page-text");
        output.Attributes.RemoveAll("skip-back-text");
        output.Attributes.RemoveAll("skip-forward-text");
        output.Attributes.RemoveAll("next-page-text");
        output.Attributes.RemoveAll("next-page-aria-label");
        output.Attributes.RemoveAll("last-page-text");
        output.Attributes.RemoveAll("first-last-navigation");
        output.Attributes.RemoveAll("skip-forward-back-navigation");
        output.Attributes.RemoveAll("model");
        output.Attributes.RemoveAll("show-pagesize");
        output.Attributes.RemoveAll("pagingmodel");
        output.Attributes.RemoveAll("use-local-view");
        
        var pagerId =  PagerId ?? $"pager-{Guid.NewGuid():N}";
        var linkUrl = LinkUrl ?? ViewContext.HttpContext.Request.Path;
        PageSize = Model?.PageSize ?? PageSize ?? 10;
        Page = Model?.Page ?? Page ?? 1;
        ViewType = Model?.ViewType ?? ViewType;
        TotalItems = Model?.TotalItems ?? TotalItems ?? 0;
        if(Model is IPagingSearchModel searchModel)
            SearchTerm = searchModel?.SearchTerm ?? SearchTerm ?? "";
        output.Attributes.SetAttribute("id", pagerId);
        var viewComponentHelper = (IViewComponentHelper)ViewContext.HttpContext.RequestServices.GetService(typeof(IViewComponentHelper))!;
        ((IViewContextAware)viewComponentHelper).Contextualize(ViewContext);

        var pagerModel = PagerModel ?? new PagerViewModel()
        {
            
            ViewType = ViewType,
            UseLocalView = UseLocalView,
            UseHtmx = UseHtmx,
            PagerId = pagerId,
            SearchTerm = SearchTerm,
            ShowPageSize = ShowPageSize,
            Model = Model,
            LinkUrl = linkUrl,
            Page = Page,
            PageSize = PageSize,
            TotalItems = TotalItems,
            PagesToDisplay = PagesToDisplay,
            CssClass = CssClass,
            FirstPageText = FirstPageText,
            PreviousPageText = PreviousPageText,
            SkipBackText = SkipBackText,
            SkipForwardText = SkipForwardText,
            NextPageText = NextPageText,
            NextPageAriaLabel = NextPageAriaLabel,
            LastPageText = LastPageText,
            FirstLastNavigation = FirstLastNavigation,
            SkipForwardBackNavigation = SkipForwardBackNavigation,
            HtmxTarget = HtmxTarget,
            
        };

        var result = await viewComponentHelper.InvokeAsync("Pager", pagerModel);
        output.Content.SetHtmlContent(result);
    }
```

Вона складається з цих етапів:

1. Установити ім 'я виходного ярлика на `div`; це контейнер для пагераM SK1
2. Зніміть всі властивості, які не потрібні для відтворюваного контенту ( але залишайте усі доступні користувачамM SK1 це дає можливість простого налаштування
3. Установіть ім 'я पेजера на випадковому інтерфейсі, якщо він не вказан. ( це дійсно використовують для спеціального коду , ви можете визначити ім' я або просто дозволити цьому коду піклуватися про нього.
4. Встановіть linkUrl на теперішній шлях, якщо не вказано. - це дозволяє переписати це, якщо ви хочете використовувати інший URL
5. Установити розмір сторінки, СтраницаM SK1 Тип зображення, ОбщееItems and SearchTerm до моделі, якщо надано, або по умолчанию, якщо не надано . Це дозволяє нам просто пройти в `IPagingModel` і працювати з папером без додаткової конфігурації
6. Встановити атрибут ID для pagerId.
7. Візьміть ViewComponentHelper з контейнеру DI і візьміть його в контексті з теперішнім ViewContext.
8. Створити новий `PagerViewModel` з властивостями, налаштованими на наші цінності або по замовчуванню, якщо не надано.
9. Викликати `Pager` Погляньмо на компонент з `PagerViewModel` і налаштувати зміст виjścia до результату.

Знову ж таки досить просто.

# Компонент widokу

## Погляньмо

Поглянь на ViewComponent досить простий; це ' це просто петля через сторінки і кілька зв 'язків до перших МSK2 останніх МСК3 наступних та попередніх сторінок М СК4

<details>
  <summary>Complete source code for the Default TailwindUI & Daisy view</summary>

```csharp
@model mostlylucid.pagingtaghelper.Components.PagerViewModel
@{
    var totalPages = (int)Math.Ceiling((double)Model.TotalItems! / (double)Model.PageSize!);
    var pageSizes = new List<int>();
    if (Model.ShowPageSize)
    {
        // Build a dynamic list of page sizes.

        // Fixed steps as a starting point.
        int[] fixedSteps = { 10, 25, 50, 75, 100, 125, 150, 200, 250, 500, 1000 };

        // Add only those fixed steps that are less than or equal to TotalItems.
        foreach (var step in fixedSteps)
        {
            if (step <= Model.TotalItems)
            {
                pageSizes.Add(step);
            }
        }

        // If TotalItems is greater than the largest fixed step,
        // add additional steps by doubling until reaching TotalItems.
        if (Model.TotalItems > fixedSteps.Last())
        {
            int next = fixedSteps.Last();
            while (next < Model.TotalItems)
            {
                next *= 2;
                // Only add if it doesn't exceed TotalItems.
                if (next < Model.TotalItems)
                {
                    pageSizes.Add(next);
                }
            }

            // Always include the actual TotalItems as the maximum option.
            if (!pageSizes.Contains(Model.TotalItems.Value))
            {
                pageSizes.Add(Model.TotalItems.Value);
            }
        }
    }
}
@if (totalPages > 1)
{
    <div class="@Model.CssClass flex items-center justify-center" id="pager-container">
        @if (Model.ShowPageSize)
        {
            var pagerId = Model.PagerId;
            var htmxAttributes = Model.UseHtmx
                ? $"hx-get=\"{Model.LinkUrl}\" hx-trigger=\"change\" hx-include=\"#{pagerId} [name='page'], #{pagerId} [name='search']\" hx-push-url=\"true\""
                : "";


            <!-- Preserve current page -->
            <input type="hidden" name="page" value="@Model.Page"/>
            <input type="hidden" name="search" value="@Model.SearchTerm"/>
            <input type="hidden" class="useHtmx" value="@Model.UseHtmx.ToString().ToLowerInvariant()"/>
            if (!Model.UseHtmx)
            {
                <input type="hidden" class="linkUrl" value="@Model.LinkUrl"/>
            }

            <!-- Page size select with label -->
            <div class="flex items-center mr-8">
                <label for="pageSize-@pagerId" class="text-sm text-gray-600 mr-2">Page size:</label>
                <select id="pageSize-@pagerId"
                        name="pageSize"
                        class="border rounded select select-primary select-sm pt-0 mt-0 min-w-[80px] pr-4"
                        @Html.Raw(htmxAttributes)>
                    @foreach (var option in pageSizes.ToList())
                    {
                        var optionString = option.ToString();
                        if (option == Model.PageSize)
                        {
                            <option value="@optionString" selected="selected">@optionString</option>
                        }
                        else
                        {
                            <option value="@optionString">@optionString</option>
                        }
                    }
                </select>
            </div>
        }

        @* "First" page link *@
        @if (Model.FirstLastNavigation && Model.Page > 1)
        {
            var href = $"{Model.LinkUrl}?page=1&pageSize={Model.PageSize}";
            if (!string.IsNullOrEmpty(Model.SearchTerm))
            {
                href += $"&search={Model.SearchTerm}";
            }

            <a class="btn btn-sm"
               href="@href">
                @Model.FirstPageText
            </a>
        }

        @* "Previous" page link *@
        @if (Model.Page > 1)
        {
            var href = $"{Model.LinkUrl}?page={Model.Page - 1}&pageSize={Model.PageSize}";
            if (!string.IsNullOrEmpty(Model.SearchTerm))
            {
                href += $"&search={Model.SearchTerm}";
            }

            <a class="btn btn-sm"
               href="@href">
                @Model.PreviousPageText
            </a>
        }

        @* Optional skip back indicator *@
        @if (Model.SkipForwardBackNavigation && Model.Page > Model.PagesToDisplay)
        {
            <a class="btn btn-sm btn-disabled">
                @Model.SkipBackText
            </a>
        }

        @* Determine visible page range *@
        @{
            int halfDisplay = Model.PagesToDisplay / 2;
            int startPage = Math.Max(1, Model.Page.Value - halfDisplay);
            int endPage = Math.Min(totalPages, startPage + Model.PagesToDisplay - 1);
            startPage = Math.Max(1, endPage - Model.PagesToDisplay + 1);
        }
        @for (int i = startPage; i <= endPage; i++)
        {
            var href = $"{Model.LinkUrl}?page={i}&pageSize={Model.PageSize}";
            if (!string.IsNullOrEmpty(Model.SearchTerm))
            {
                href += $"&search={Model.SearchTerm}";
            }

            <a data-page="@i" class="btn btn-sm mr-2 @(i == Model.Page ? "btn-active" : "")"
               href="@href">
                @i
            </a>
        }

        @* Optional skip forward indicator *@
        @if (Model.SkipForwardBackNavigation && Model.Page < totalPages - Model.PagesToDisplay + 1)
        {
            <a class="btn btn-sm btn-disabled mr-2">
                @Model.SkipForwardText
            </a>
        }

        @* "Next" page link *@
        @if (Model.Page < totalPages)
        {
            var href = $"{Model.LinkUrl}?page={Model.Page + 1}&pageSize={Model.PageSize}";
            if (!string.IsNullOrEmpty(Model.SearchTerm))
            {
                href += $"&search={Model.SearchTerm}";
            }

            <a class="btn btn-sm mr-2"
               href="@href"
               aria-label="@Model.NextPageAriaLabel">
                @Model.NextPageText
            </a>
        }

        @* "Last" page link *@
        @if (Model.FirstLastNavigation && Model.Page < totalPages)
        {
            var href = $"{Model.LinkUrl}?page={totalPages}&pageSize={Model.PageSize}";
            if (!string.IsNullOrEmpty(Model.SearchTerm))
            {
                href += $"&search={Model.SearchTerm}";
            }

            <a class="btn btn-sm"
               href="@href">
                @Model.LastPageText
            </a>
        }

        <!-- Page info text with left margin for separation -->
        <div class="text-sm text-neutral-500 ml-8">
            Page @Model.Page of @totalPages (Total items: @Model.TotalItems)
        </div>
    </div>
}
```

</details>
Це поділено на декілька розділів:

1. Скидання розміру сторінки
2. Перший, останнійM SK1 наступні і попередні зв 'язки
3. Перестрибнути назад і перестрибувати вперед
4. Ссылки на сторінку
5. Інформаційний текст сторінки

## Скидання розміру сторінки

Однією з речей, яку я пропустив від оригінального вказівника на тегні, був падіння розміру сторінки.
Це простий список вибору, ви бачите, я починаю з визначення `fixedSteps` які є лише деякими фіксованими кроками, які я хочу використати для відкидання.. Потім я прокручу їх і додаю до списку.

```csharp
@{
    var totalPages = (int)Math.Ceiling((double)Model.TotalItems! / (double)Model.PageSize!);
    var pageSizes = new List<int>();
    if (Model.ShowPageSize)
    {
        // Build a dynamic list of page sizes.

        // Fixed steps as a starting point.
        int[] fixedSteps = { 10, 25, 50, 75, 100, 125, 150, 200, 250, 500, 1000 };

        // Add only those fixed steps that are less than or equal to TotalItems.
        foreach (var step in fixedSteps)
        {
            if (step <= Model.TotalItems)
            {
                pageSizes.Add(step);
            }
        }

        // If TotalItems is greater than the largest fixed step,
        // add additional steps by doubling until reaching TotalItems.
        if (Model.TotalItems > fixedSteps.Last())
        {
            int next = fixedSteps.Last();
            while (next < Model.TotalItems)
            {
                next *= 2;
                // Only add if it doesn't exceed TotalItems.
                if (next < Model.TotalItems)
                {
                    pageSizes.Add(next);
                }
            }

            // Always include the actual TotalItems as the maximum option.
            if (!pageSizes.Contains(Model.TotalItems.Value))
            {
                pageSizes.Add(Model.TotalItems.Value);
            }
        }
    }
}
```

Потім я перетворюю це на сторінку

```csharp
  @if (Model.ShowPageSize)
        {
            var pagerId = Model.PagerId;
            var htmxAttributes = Model.UseHtmx
                ? $"hx-get=\"{Model.LinkUrl}\" hx-trigger=\"change\" hx-include=\"#{pagerId} [name='page'], #{pagerId} [name='search']\" hx-push-url=\"true\""
                : "";


            <!-- Preserve current page -->
            <input type="hidden" name="page" value="@Model.Page"/>
            <input type="hidden" name="search" value="@Model.SearchTerm"/>
            <input type="hidden" class="useHtmx" value="@Model.UseHtmx.ToString().ToLowerInvariant()"/>
            if (!Model.UseHtmx)
            {
                <input type="hidden" class="linkUrl" value="@Model.LinkUrl"/>
            }

            <!-- Page size select with label -->
            <div class="flex items-center mr-8">
                <label for="pageSize-@pagerId" class="text-sm text-gray-600 mr-2">Page size:</label>
                <select id="pageSize-@pagerId"
                        name="pageSize"
                        class="border rounded select select-primary select-sm pt-0 mt-0 min-w-[80px] pr-4"
                        @Html.Raw(htmxAttributes)>
                    @foreach (var option in pageSizes.ToList())
                    {
                        var optionString = option.ToString();
                        if (option == Model.PageSize)
                        {
                            <option value="@optionString" selected="selected">@optionString</option>
                        }
                        else
                        {
                            <option value="@optionString">@optionString</option>
                        }
                    }
                </select>
            </div>
        }
```

Ви бачите, що я опціонально використовую деякі атрибути HTMX для передачі розміру сторінки до сервера і оновлення сторінки, зберігаючи теперішню сторінку та пошуковий параметр.

Крім того, якщо ви визначаєте `use-htmx=false` як параметр на допомічникі теги він отримав' не випустив їх, але замість цього дозволив вам використовувати деякі програми JS, які я надаю як допомочник HTML для оновлення розміру сторінкиM SK1

```csharp
@Html.PageSizeOnchangeSnippet()
    

```

Це простий скрипт, який буде оновлювати розмір сторінки і перезавантаження сторінки. ( зауважте, що це не працює.

```javascript
document.addEventListener("DOMContentLoaded", function () {
    document.body.addEventListener("change", function (event) {
        const selectElement = event.target.closest("#pager-container select[name='pageSize']");
        if (!selectElement) return;

        const pagerContainer = selectElement.closest("#pager-container");
        const useHtmxInput = pagerContainer.querySelector("input.useHtmx");
        const useHtmx = useHtmxInput ? useHtmxInput.value === "true" : true; // default to true

        if (!useHtmx) {
            const pageInput = pagerContainer.querySelector("[name='page']");
            const searchInput = pagerContainer.querySelector("[name='search']");

            const page = pageInput ? pageInput.value : "1";
            const search = searchInput ? searchInput.value : "";
            const pageSize = selectElement.value;
            const linkUrl =  pagerContainer.querySelector("input.linkUrl").value ?? "";
            
            const url = new URL(linkUrl, window.location.origin);
            url.searchParams.set("page", page);
            url.searchParams.set("pageSize", pageSize);

            if (search) {
                url.searchParams.set("search", search);
            }

            window.location.href = url.toString();
        }
    });
});

```

# Інтеграція HTMX

Інтеграція HTMX досить проста, оскільки HT MX каскадується до дитячих елементів, ми можемо визначити параметри HTX на батьківському elemenті і вони будуть успадковані.

- `hx-boost="true"` - це використовує чудову [hx-важка функція](https://htmx.org/attributes/hx-boost/) щоб перехопити уривок клікання і надіслати запит через HTMX.
- hx-указательM SK1завантаження-модальний " MSC4 це має модальний завантаження, який покаже, поки працьовується прохання
- hx-цельM SK1пользовательМSK2список МSK3 МСК4 це елемент, який реагує на нього МСК5 в цьому випадку - список користувачів М СК6 Зауважка М סК7 В цей момент включений Pager для простоти M СК8 ви можете зробити його більш активним, використовуючи Alpine M СК9 так, як у моєму [попередній artykuł](https://www.mostlylucid.net/blog/addpagingwithhtmx) ) але цього разу це було поза межами
- hx-swap

## Модаль завантаження

Це досить просто, і використовує Boxicons DaisyUI, та Tailwind для створення простого модуля завантаження

```html
<div id="loading-modal" class="modal htmx-indicator">
    <div class="modal-box flex flex-col items-center justify-center">
        <h2 class="text-lg font-semibold">Loading...</h2>
        <i class="bx bx-loader bx-spin text-3xl mt-2"></i>
    </div>
</div>

```

hx- індикаторM SK1 завантаження- модальний " тоді визначає, що коли робиться HTMX-запрос, він повинен показати, а потім приховати цей модальний

# Майбутні характеристики

Таким чином, частина "'", МSK1 , там мSK2 , очевидно, є набагато більше, щоб описати, і я буду в майбутніх статтях ";", включно з сайтом зразка мису , а також альтернативні перегляди МСК4 , МСк5 , пошукову функцію та налаштування CSS .