Skip to content
W WRNexusJS
core component

Pagination

Reusable pagination component.

@wrnexus/ui 0.2.6712 props0 slots0 events

Usage

Components are auto-discovered. Use the component directly in any .wrn view:

<Pagination
  currentPage="1"
  totalPages="1"
  previousHref="previousHref"
  nextHref="nextHref"
  pages="[]"
/>

Legacy mount name: data-component="Pagination".

Props and attributes

PropTypeRequirementDefault
classstringOptional""
currentPagenumberOptional1
totalPagesnumberOptional1
previousHrefstringOptional""
nextHrefstringOptional""
pagesstringOptional[]
showNumbersbooleanOptionaltrue
showSummarybooleanOptionaltrue
totalItemsnumberOptional0
pageSizenumberOptional10
compactbooleanOptionalfalse
centeredbooleanOptionalfalse

Slots

This component does not declare a slot.

Events

This component does not declare a custom event.

Source contract

Installed source: components/Pagination.wrn

component Pagination {
    props {
        class: string = ""
        currentPage = 1
        totalPages = 1

        previousHref = ""
        nextHref = ""

        pages = []

        showNumbers = true
        showSummary = true

        totalItems = 0
        pageSize = 10

        compact = false
        centered = false
    }

    view {
        <nav
            aria-label="Pagination"
            class="w-full {class}"
            class:hidden="totalPages <= 1"
        >
        <!-- Result summary -->
        <div
                class="mb-4 text-sm text-slate-500 dark:text-slate-400"
                class:hidden="!showSummary || totalItems <= 0"
                class:text-center="centered"
            >
                Showing

                <span class="font-semibold text-slate-950 dark:text-white">
                    {(currentPage - 1) * pageSize + 1}
                </span>

                to

                <span class="font-semibold text-slate-950 dark:text-white">
                    {currentPage * pageSize > totalItems ? totalItems : currentPage * pageSize}
                </span>

                of

                <span class="font-semibold text-slate-950 dark:text-white">
                    {totalItems}
                </span>

                results
            </div>
        <div
                class="flex flex-col gap-4 sm:flex-row sm:items-center"
                class:sm:justify-center="centered"
                class:sm:justify-between="!centered"
            >
        <!-- Previous -->
        <a
                    href="{previousHref}"
                    aria-label="Go to previous page"
                    class="group h-11 items-center justify-center gap-2 rounded-xl border border-slate-200 bg-white px-4 text-sm font-semibold text-slate-700 shadow-sm transition hover:-translate-y-0.5 hover:border-indigo-300 hover:bg-slate-50 hover:text-indigo-700 focus:outline-none focus-visible:ring-2 focus-visible:ring-indigo-500 dark:border-white/10 dark:bg-white/5 dark:text-slate-200 dark:hover:border-indigo-500/30 dark:hover:bg-white/10 dark:hover:text-indigo-300"
                    class:hidden="previousHref === ''"
                    class:inline-flex="previousHref !== ''"
                >
        <span class="icon-[lucide--arrow-left] h-4 w-4 transition-transform group-hover:-translate-x-0.5" aria-hidden="true" >
        </span>
        <span class:hidden="compact">
                        Previous
                    </span>
        </a>
        <span
                    aria-disabled="true"
                    class="h-11 cursor-not-allowed items-center justify-center gap-2 rounded-xl border border-slate-200 bg-slate-50 px-4 text-sm font-semibold text-slate-400 dark:border-white/10 dark:bg-white/[0.03] dark:text-slate-600"
                    class:hidden="previousHref !== ''"
                    class:inline-flex="previousHref === ''"
                >
        <span class="icon-[lucide--arrow-left] h-4 w-4" aria-hidden="true" >
        </span>
        <span class:hidden="compact">
                        Previous
                    </span>
        </span>
        <!-- Numbered pages -->
        <div
                    class="flex flex-wrap items-center justify-center gap-1.5"
                    class:hidden="!showNumbers"
                >
                    {#each pages as page}
                    <!-- Ellipsis -->
        <span
                        class="grid h-10 w-10 place-items-center text-sm font-semibold text-slate-400"
                        class:hidden="!page.ellipsis"
                    >
                        …
                    </span>
        <!-- Page link -->
        <a
                        href="{page.href}"
                        aria-label="Go to page {page.number}"
                        class="h-10 min-w-10 items-center justify-center rounded-xl px-3 text-sm font-semibold transition focus:outline-none focus-visible:ring-2 focus-visible:ring-indigo-500"
                        class:hidden="page.ellipsis || page.current"
                        class:inline-flex="!page.ellipsis && !page.current"
                        class:border="!page.current"
                        class:border-slate-200="!page.current"
                        class:bg-white="!page.current"
                        class:text-slate-600="!page.current"
                        class:hover:border-indigo-300="!page.current"
                        class:hover:bg-indigo-50="!page.current"
                        class:hover:text-indigo-700="!page.current"
                        class:dark:border-white/10="!page.current"
                        class:dark:bg-white/5="!page.current"
                        class:dark:text-slate-300="!page.current"
                        class:dark:hover:border-indigo-500/30="!page.current"
                        class:dark:hover:bg-indigo-500/10="!page.current"
                        class:dark:hover:text-indigo-300="!page.current"
                    >
                        {page.number}
                    </a>
        <!-- Current page -->
        <span
                        aria-current="page"
                        aria-label="Current page, page {page.number}"
                        class="h-10 min-w-10 items-center justify-center rounded-xl bg-indigo-600 px-3 text-sm font-bold text-white shadow-lg shadow-indigo-600/20"
                        class:hidden="page.ellipsis || !page.current"
                        class:inline-flex="!page.ellipsis && page.current"
                    >
                        {page.number}
                    </span>
                    {/each}
                </div>
        <!-- Mobile page counter -->
        <div
                    class="flex items-center justify-center rounded-xl border border-slate-200 bg-slate-50 px-4 py-2.5 text-sm font-medium text-slate-500 dark:border-white/10 dark:bg-white/5 dark:text-slate-400"
                    class:hidden="showNumbers"
                >
                    Page

                    <span class="mx-1 font-bold text-slate-950 dark:text-white">
                        {currentPage}
                    </span>

                    of

                    <span class="ml-1 font-bold text-slate-950 dark:text-white">
                        {totalPages}
                    </span>
        </div>
        <!-- Next -->
        <a
                    href="{nextHref}"
                    aria-label="Go to next page"
                    class="group h-11 items-center justify-center gap-2 rounded-xl bg-indigo-600 px-4 text-sm font-bold text-white shadow-lg shadow-indigo-600/20 transition hover:-translate-y-0.5 hover:bg-indigo-500 hover:shadow-xl focus:outline-none focus-visible:ring-2 focus-visible:ring-indigo-500 focus-visible:ring-offset-2 dark:focus-visible:ring-offset-slate-950"
                    class:hidden="nextHref === ''"
                    class:inline-flex="nextHref !== ''"
                >
        <span class:hidden="compact">
                        Next
                    </span>
        <span class="icon-[lucide--arrow-right] h-4 w-4 transition-transform group-hover:translate-x-0.5" aria-hidden="true" >
        </span>
        </a>
        <span
                    aria-disabled="true"
                    class="h-11 cursor-not-allowed items-center justify-center gap-2 rounded-xl border border-slate-200 bg-slate-50 px-4 text-sm font-semibold text-slate-400 dark:border-white/10 dark:bg-white/[0.03] dark:text-slate-600"
                    class:hidden="nextHref !== ''"
                    class:inline-flex="nextHref === ''"
                >
        <span class:hidden="compact">
                        Next
                    </span>
        <span class="icon-[lucide--arrow-right] h-4 w-4" aria-hidden="true" >
        </span>
        </span>
        </div>
        </nav>
    }
}