@playlive/react-query
    Preparing search index...

    Interface UseLeaderboardParams

    Params for useLeaderboard.

    interface UseLeaderboardParams {
        campaignId: string | null | undefined;
        charityType: CharityType;
        completedAfter?: string | null;
        completedBefore?: string | null;
        eagerFetchPages?: boolean;
        isTeam?: boolean;
        itemClass?: string;
        limit?: number;
        prefilterExclusions?: boolean;
        removeAnonymous?: boolean;
    }
    Index
    campaignId charityType completedAfter? completedBefore? eagerFetchPages? isTeam? itemClass? limit? prefilterExclusions? removeAnonymous?
    campaignId: string | null | undefined
    charityType: CharityType
    completedAfter?: string | null

    ISO 8601 lower bound on donation completed_at.

    completedBefore?: string | null

    ISO 8601 upper bound on donation completed_at.

    eagerFetchPages?: boolean

    When true, the underlying useInfiniteDonations walks the cursor eagerly (fires fetchNextPage on every render where hasNextPage && !isFetchingNextPage). Defaults to true — matches the overlay-vite behavior where the leaderboard must see every donation to be accurate.

    isTeam?: boolean
    itemClass?: string

    Optional class hint carried onto each row — e.g. for CSS theming.

    limit?: number

    Cap on returned rows. 0 returns every donor.

    prefilterExclusions?: boolean

    When true (default), donors on the leaderboard-exclusions list are filtered out before aggregation. Set false to include every donor regardless of the exclusion list — useful for admin views.

    removeAnonymous?: boolean

    Drop rows whose donor_name is empty or literally "anonymous".

    Settings
    Member Visibility

    On This Page
    Properties