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

    Type Alias PaginationOptions<T>

    What a paginated loader response is read as. Every field has a default extractor covering the common envelope shapes; override any of them when your backend disagrees.

    type PaginationOptions<T> = {
        recordName?: string;
        key?: string;
        items?: (data: any) => readonly T[];
        total?: (data: any) => number;
        perPage?: (data: any) => number;
        lastPage?: (data: any) => number;
        window?: number;
    }

    Type Parameters

    • T
    Index
    recordName? key? items? total? perPage? lastPage? window?
    recordName?: string

    Read another record's loader data (default: the leaf record).

    key?: string

    Query key carrying the page number. Default: 'page'.

    items?: (data: any) => readonly T[]
    total?: (data: any) => number
    perPage?: (data: any) => number
    lastPage?: (data: any) => number
    window?: number

    How many numbered links pageRange produces. Default: 7.

    Settings
    Member Visibility

    On This Page
    Properties