Skip to content

Commit c9cae30

Browse files
authored
docs(headless-react): pagination typedoc reference (#4949)
https://coveord.atlassian.net/browse/KIT-3950 I noticed that we weren't documenting PaginationOptions. https://docs.coveo.com/en/headless-react/latest/reference/interfaces/SSR_Commerce.index.PaginationProps.html#options This PR fixes it: <img width="1541" alt="Screenshot 2025-02-06 at 4 14 03 PM" src="https://github.com/user-attachments/assets/c71ca770-c275-41d1-adeb-5ad43be3b308" /> <img width="1492" alt="Screenshot 2025-02-06 at 4 14 15 PM" src="https://github.com/user-attachments/assets/6c7c200b-252a-41b1-a7bf-76ba36bb9bf2" />
1 parent b64e226 commit c9cae30

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

packages/headless/src/controllers/commerce/core/pagination/headless-core-commerce-pagination.ssr.ts

+9-1
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,17 @@ import {
1010
Pagination,
1111
PaginationProps,
1212
PaginationState,
13+
PaginationOptions,
14+
CorePaginationOptions,
1315
} from './headless-core-commerce-pagination.js';
1416

15-
export type {Pagination, PaginationProps, PaginationState};
17+
export type {
18+
Pagination,
19+
PaginationProps,
20+
PaginationState,
21+
PaginationOptions,
22+
CorePaginationOptions,
23+
};
1624

1725
/**
1826
* Defines a `Pagination` controller instance.

packages/headless/src/controllers/commerce/core/pagination/headless-core-commerce-pagination.ts

+3
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ export interface PaginationState {
7575
}
7676

7777
export interface CorePaginationOptions {
78+
/**
79+
* For internal use by Headless.
80+
*/
7881
slotId?: string;
7982
/**
8083
* The number of products to fetch per page.

packages/headless/src/ssr-commerce.index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,8 @@ export type {
179179
Pagination,
180180
PaginationProps,
181181
PaginationState,
182+
PaginationOptions,
183+
CorePaginationOptions,
182184
} from './controllers/commerce/core/pagination/headless-core-commerce-pagination.ssr.js';
183185
export {definePagination} from './controllers/commerce/core/pagination/headless-core-commerce-pagination.ssr.js';
184186

0 commit comments

Comments
 (0)