Interface SwipeableFeedOptions<SE, SR, Item>

What swipeableFeed takes — facts of the screen, each the app's own:

onSwipe, what the app sends on a swipe — run with the item that was in front and the one now in front. Without it a swipe sends nothing of its own. Viewing is the item's visit: its own enter runs when it comes in front and its leave when a swipe moves it away — there is no separate viewing action.
nextPageWhenItemsLeft, the prefetch threshold: the swipe that leaves this many loaded items or fewer after the one in front requests the next page. Without it the next page is requested only when the swipe has no loaded item to go to.

interface SwipeableFeedOptions<SE, SR, Item extends ScreenHandle = ScreenHandle> {
    nextPageWhenItemsLeft?: number;
    onSwipe?(
        swipe: { following: readonly Item[]; from: Item; to: Item },
    ): Effect<void, SE, SR>;
}

Type Parameters

SE
SR
Item extends ScreenHandle = ScreenHandle

Index

Methods

Properties

nextPageWhenItemsLeft?

Methods

`Optional`onSwipe

onSwipe?(
swipe: { following: readonly Item[]; from: Item; to: Item },
): Effect<void, SE, SR>
What the app sends on a swipe — run with the item that was in front and the one now in front, typed as the feed's own item handles (their data is on them, so a caller names the items it swiped between without narrowing). Without it a swipe sends nothing of its own.
Parameters
- swipe: { following: readonly Item[]; from: Item; to: Item }
  - Readonlyfollowing: readonly Item[]
    The loaded items after to, in feed order: what the app prefetches for ahead of the swipe.
  - Readonlyfrom: Item
  - Readonlyto: Item
Returns Effect<void, SE, SR>

Properties

`Optional` `Readonly`nextPageWhenItemsLeft

nextPageWhenItemsLeft?: number