Interface Pagination

The Pagination sub-controller is responsible for navigating between pages of results in a commerce interface.

interface Pagination {
    state: PaginationState;
    fetchMoreProducts(): void;
    nextPage(): void;
    previousPage(): void;
    selectPage(page: number): void;
    setPageSize(pageSize: number): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- Pagination

Index

Methods

fetchMoreProducts nextPage previousPage selectPage setPageSize subscribe

Properties

Methods

fetchMoreProducts

fetchMoreProducts(): void
Fetches the next page of products, and appends them to the current list of products.

Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/core/pagination/headless-core-commerce-pagination.d.ts:34

nextPage

nextPage(): void
Navigates to the next page.

Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/core/pagination/headless-core-commerce-pagination.d.ts:20

previousPage

previousPage(): void
Navigates to the previous page.

Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/core/pagination/headless-core-commerce-pagination.d.ts:24

selectPage

selectPage(page: number): void
Navigates to a specific page.
Parameters
- page: number
  The page to navigate to.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/core/pagination/headless-core-commerce-pagination.d.ts:16

setPageSize

setPageSize(pageSize: number): void
Sets the page size.
Parameters
- pageSize: number
  The page size.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/core/pagination/headless-core-commerce-pagination.d.ts:30

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/dist/definitions/controllers/controller/headless-controller.d.ts:10

Properties

state

state: PaginationState

A scoped and simplified part of the headless state that is relevant to the Pagination sub-controller.