@commercetools-uikit/pagination 19.8.0 → 19.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/commercetools-uikit-pagination.cjs.dev.js +1 -1
  2. package/dist/commercetools-uikit-pagination.cjs.prod.js +1 -1
  3. package/dist/commercetools-uikit-pagination.esm.js +1 -1
  4. package/dist/declarations/src/page-navigator/page-navigator.d.ts +9 -0
  5. package/dist/declarations/src/page-size-selector/page-size-selector.d.ts +18 -0
  6. package/dist/declarations/src/pagination.d.ts +24 -0
  7. package/package.json +11 -11
package/dist/commercetools-uikit-pagination.cjs.dev.js CHANGED
@@ -302,7 +302,7 @@ Pagination.defaultProps = defaultProps;
302
302
  var Pagination$1 = Pagination;
303
303
 
304
304
  // NOTE: This string will be replaced on build time with the package version.
305
- var version = "19.8.0";
305
+ var version = "19.10.0";
306
306
 
307
307
  exports.PageNavigator = PageNavigator$1;
308
308
  exports.PageSizeSelector = PageSizeSelector$1;
package/dist/commercetools-uikit-pagination.cjs.prod.js CHANGED
@@ -283,7 +283,7 @@ Pagination.defaultProps = defaultProps;
283
283
  var Pagination$1 = Pagination;
284
284
 
285
285
  // NOTE: This string will be replaced on build time with the package version.
286
- var version = "19.8.0";
286
+ var version = "19.10.0";
287
287
 
288
288
  exports.PageNavigator = PageNavigator$1;
289
289
  exports.PageSizeSelector = PageSizeSelector$1;
package/dist/commercetools-uikit-pagination.esm.js CHANGED
@@ -275,6 +275,6 @@ Pagination.defaultProps = defaultProps;
275
275
  var Pagination$1 = Pagination;
276
276
 
277
277
  // NOTE: This string will be replaced on build time with the package version.
278
- var version = "19.8.0";
278
+ var version = "19.10.0";
279
279
 
280
280
  export { PageNavigator$1 as PageNavigator, PageSizeSelector$1 as PageSizeSelector, Pagination$1 as Pagination, version };
package/dist/declarations/src/page-navigator/page-navigator.d.ts CHANGED
@@ -1,6 +1,15 @@
1
1
  type TPageNavigatorProps = {
2
+ /**
3
+ * Total number of pages available
4
+ */
2
5
  totalPages: number;
6
+ /**
7
+ * The current page
8
+ */
3
9
  page: number;
10
+ /**
11
+ * A callback function, called when the page is changed.
12
+ */
4
13
  onPageChange: (newPerPage: number) => void;
5
14
  };
6
15
  declare const PageNavigator: {
package/dist/declarations/src/page-size-selector/page-size-selector.d.ts CHANGED
@@ -1,8 +1,26 @@
1
1
  export type TPageRangeSize = 's' | 'm' | 'l';
2
2
  export type TPageSizeSelectorProps = {
3
+ /**
4
+ * Number of items per page, according to the pre-defined range values.
5
+ */
3
6
  perPage: number;
7
+ /**
8
+ * Range of items per page.
9
+ * <br/>
10
+ * `SMALL: 20,50`
11
+ * <br/>
12
+ * `MEDIUM: 20,50,100`
13
+ * <br/>
14
+ * `LARGE: 200,500`
15
+ */
4
16
  perPageRange: TPageRangeSize;
17
+ /**
18
+ * A callback function, called when `perPage` is changed.
19
+ */
5
20
  onPerPageChange: (value: number) => void;
21
+ /**
22
+ * Number of items in the current page
23
+ */
6
24
  pageItems: number;
7
25
  };
8
26
  declare const PageSizeSelector: {
package/dist/declarations/src/pagination.d.ts CHANGED
@@ -1,10 +1,34 @@
1
1
  import { type TPageRangeSize } from "./page-size-selector/index.js";
2
2
  export type TPaginationProps = {
3
+ /**
4
+ * Total number of items across all pages
5
+ */
3
6
  totalItems: number;
7
+ /**
8
+ * The current page
9
+ */
4
10
  page: number;
11
+ /**
12
+ * A callback function, called when the page is changed.
13
+ */
5
14
  onPageChange: (newPage: number) => void;
15
+ /**
16
+ * Number of items per page, according to the pre-defined range values.
17
+ */
6
18
  perPage: number;
19
+ /**
20
+ * Range of items per page.
21
+ * <br/>
22
+ * `s: 20,50`
23
+ * <br/>
24
+ * `m: 20,50,100`
25
+ * <br/>
26
+ * `l: 200,500`
27
+ */
7
28
  perPageRange: TPageRangeSize;
29
+ /**
30
+ * A callback function, called when `perPage` is changed.
31
+ */
8
32
  onPerPageChange: (newPerPage: number) => void;
9
33
  };
10
34
  declare const Pagination: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@commercetools-uikit/pagination",
3
3
  "description": "Components for navigating through pages of items",
4
- "version": "19.8.0",
4
+ "version": "19.10.0",
5
5
  "bugs": "https://github.com/commercetools/ui-kit/issues",
6
6
  "repository": {
7
7
  "type": "git",
@@ -21,16 +21,16 @@
21
21
  "dependencies": {
22
22
  "@babel/runtime": "^7.20.13",
23
23
  "@babel/runtime-corejs3": "^7.20.13",
24
- "@commercetools-uikit/constraints": "19.8.0",
25
- "@commercetools-uikit/design-system": "19.8.0",
26
- "@commercetools-uikit/icons": "19.8.0",
27
- "@commercetools-uikit/label": "19.8.0",
28
- "@commercetools-uikit/number-input": "19.8.0",
29
- "@commercetools-uikit/secondary-icon-button": "19.8.0",
30
- "@commercetools-uikit/select-input": "19.8.0",
31
- "@commercetools-uikit/spacings": "19.8.0",
32
- "@commercetools-uikit/text": "19.8.0",
33
- "@commercetools-uikit/utils": "19.8.0",
24
+ "@commercetools-uikit/constraints": "19.10.0",
25
+ "@commercetools-uikit/design-system": "19.10.0",
26
+ "@commercetools-uikit/icons": "19.10.0",
27
+ "@commercetools-uikit/label": "19.10.0",
28
+ "@commercetools-uikit/number-input": "19.10.0",
29
+ "@commercetools-uikit/secondary-icon-button": "19.10.0",
30
+ "@commercetools-uikit/select-input": "19.10.0",
31
+ "@commercetools-uikit/spacings": "19.10.0",
32
+ "@commercetools-uikit/text": "19.10.0",
33
+ "@commercetools-uikit/utils": "19.10.0",
34
34
  "@emotion/react": "^11.10.5",
35
35
  "@emotion/styled": "^11.10.5",
36
36
  "formik": "^2.2.9",