core/com.nxoim.evolpagink.core/Pageable

Pageable

interface Pageable<Key : Any, PageItem>

Represents a paginated data source with flattened items and fetching state.

The item list automatically updates as pages are fetched based on the configured strategy.

Properties

abstract val isFetchingNext: StateFlow<Boolean>

isFetchingPrevious

abstract val isFetchingPrevious: StateFlow<Boolean>

abstract val items: StateFlow<List<PageItem>>

Functions

getPageKeyForItem

abstract suspend fun getPageKeyForItem(item: PageItem): Key?

Maps an item back to its page key. Returns null if the item isn't associated with a page.

abstract suspend fun jumpTo(page: Key): List<PageItem>?

Loads and activates the specified page, returning its items. Subsequent fetches will be centered around this page.

onVisibilityEvent

abstract suspend fun onVisibilityEvent(event: PageDisplayingEvent<Key>)

Reports visible pages to the paginator, triggers the declared PageFetchStrategy to calculate a list of pages that are expected to be loaded by the paginator.

abstract fun pageItemKey(item: PageItem): Any

Provides key for an item from any loaded page. See pageable.