Interface PaginationActionCreators

The pagination action creators.

interface PaginationActionCreators {
    nextPage(
        payload?: SlotIdPayload,
    ): { payload: undefined | SlotIdPayload; type: string };
    previousPage(
        payload?: SlotIdPayload,
    ): { payload: undefined | SlotIdPayload; type: string };
    registerRecommendationsSlotPagination(
        payload: RegisterRecommendationsSlotPaginationPayload,
    ): { payload: P; type: string };
    selectPage(
        payload: SelectPagePayload,
    ): { payload: SelectPagePayload; type: string };
    setPageSize(
        payload: SetPageSizePayload,
    ): { payload: SetPageSizePayload; type: string };
}

Index

Methods

nextPage previousPage registerRecommendationsSlotPagination selectPage setPageSize

Methods

nextPage

nextPage(
payload?: SlotIdPayload,
): { payload: undefined | SlotIdPayload; type: string }
Selects the next page.
Parameters
- Optionalpayload: SlotIdPayload
  The action creator payload.
Returns { payload: undefined | SlotIdPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/commerce/pagination/pagination-actions-loader.d.ts:39

previousPage

previousPage(
payload?: SlotIdPayload,
): { payload: undefined | SlotIdPayload; type: string }
Selects the previous page.
Parameters
- Optionalpayload: SlotIdPayload
  The action creator payload.
Returns { payload: undefined | SlotIdPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/commerce/pagination/pagination-actions-loader.d.ts:46

registerRecommendationsSlotPagination

registerRecommendationsSlotPagination(
payload: RegisterRecommendationsSlotPaginationPayload,
): { payload: P; type: string }
Registers pagination for a recommendations slot.
Parameters
- payload: RegisterRecommendationsSlotPaginationPayload
  The action creator payload.
Returns { payload: P; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/commerce/pagination/pagination-actions-loader.d.ts:18

selectPage

selectPage(
payload: SelectPagePayload,
): { payload: SelectPagePayload; type: string }
Selects a page.
Parameters
- payload: SelectPagePayload
  The action creator payload.
Returns { payload: SelectPagePayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/commerce/pagination/pagination-actions-loader.d.ts:32

setPageSize

setPageSize(
payload: SetPageSizePayload,
): { payload: SetPageSizePayload; type: string }
Sets the page size.
Parameters
- payload: SetPageSizePayload
  The action creator payload.
Returns { payload: SetPageSizePayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/commerce/pagination/pagination-actions-loader.d.ts:25