Interface Pager

The Pager controller allows to navigate through the different result pages.

interface Pager {
    state: PagerState;
    isCurrentPage(page: number): boolean;
    nextPage(): void;
    previousPage(): void;
    selectPage(page: number): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- Pager

Index

Methods

isCurrentPage nextPage previousPage selectPage subscribe

Properties

Methods

isCurrentPage

isCurrentPage(page: number): boolean
Returns true when the current page is equal to the passed page, and false otherwise.
Parameters
- page: number
  The page number to check.
Returns boolean
Whether the passed page is selected.
- Defined in packages/headless/src/controllers/core/pager/headless-core-pager.ts:98

nextPage

nextPage(): void
Updates the results to those on the next page.

Returns void
- Defined in packages/headless/src/controllers/core/pager/headless-core-pager.ts:85

previousPage

previousPage(): void
Updates the results to those on the previous page.

Returns void
- Defined in packages/headless/src/controllers/core/pager/headless-core-pager.ts:90

selectPage

selectPage(page: number): void
Updates the results to those on the passed page.
Parameters
- page: number
  The page number.
Returns void
- Defined in packages/headless/src/controllers/core/pager/headless-core-pager.ts:80

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

state

state: PagerState

The state of the Pager controller.