vapor-chamber API reference - v1.16.0
    Preparing search index...

    Type Alias Pagination<T>

    type Pagination<T> = {
        items: Readonly<Ref<readonly T[]>>;
        page: QueryParamHandle<number>;
        perPage: Readonly<Ref<number>>;
        total: Readonly<Ref<number>>;
        lastPage: Readonly<Ref<number>>;
        hasNext: Readonly<Ref<boolean>>;
        hasPrev: Readonly<Ref<boolean>>;
        pageRange: Readonly<Ref<readonly number[]>>;
        loading: Readonly<Ref<boolean>>;
        next: () => void;
        prev: () => void;
        go: (page: number) => void;
    }

    Type Parameters

    • T
    Index
    items page perPage total lastPage hasNext hasPrev pageRange loading next prev go
    items: Readonly<Ref<readonly T[]>>

    Rows of the current page — the loader's, committed with the snapshot.

    page

    page: QueryParamHandle<number>

    The page number, backed by the URL. Writable: page.value = 3.

    perPage: Readonly<Ref<number>>
    total: Readonly<Ref<number>>
    lastPage: Readonly<Ref<number>>
    hasNext: Readonly<Ref<boolean>>
    hasPrev: Readonly<Ref<boolean>>
    pageRange: Readonly<Ref<readonly number[]>>

    Windowed page numbers for a pager UI; 0 marks an elision ("…").

    loading: Readonly<Ref<boolean>>

    True while a loader for the current navigation is in flight.

    next: () => void
    prev: () => void
    go: (page: number) => void

    Settings
    Member Visibility

    On This Page
    Properties