@commercetools-uikit/pagination 20.5.0 → 20.6.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.
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!-- THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. -->
|
|
2
|
-
<!-- This file is created by the `
|
|
2
|
+
<!-- This file is created by the `pnpm generate-readme` script. -->
|
|
3
3
|
|
|
4
4
|
# Pagination
|
|
5
5
|
|
|
@@ -10,7 +10,7 @@ Components for navigating through pages of items
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
12
12
|
```
|
|
13
|
-
|
|
13
|
+
pnpm add @commercetools-uikit/pagination
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
```
|
|
@@ -20,7 +20,7 @@ npm --save install @commercetools-uikit/pagination
|
|
|
20
20
|
Additionally install the peer dependencies (if not present)
|
|
21
21
|
|
|
22
22
|
```
|
|
23
|
-
|
|
23
|
+
pnpm add react react-intl
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
```
|
|
@@ -49,14 +49,14 @@ export default Example;
|
|
|
49
49
|
|
|
50
50
|
## Properties
|
|
51
51
|
|
|
52
|
-
| Props | Type | Required | Default | Description
|
|
53
|
-
| ----------------- | ----------------------------------------------------------- | :------: | ------- |
|
|
54
|
-
| `totalItems` | `number` | ✅ | | Total number of items across all pages
|
|
55
|
-
| `page` | `number` | ✅ | | The current page
|
|
56
|
-
| `onPageChange` | `Function`<br/>[See signature.](#signature-onpagechange) | ✅ | | A callback function, called when the page is changed.
|
|
57
|
-
| `perPage` | `number` | | `20` | Number of items per page, according to the pre-defined range values.
|
|
58
|
-
| `perPageRange` | `TPageRangeSize` | | `'s'` | Range of items per page.
<br/>
`s: 20,50`
<br/>
`m: 20,50,100`
<br/>
`l: 200,500` |
|
|
59
|
-
| `onPerPageChange` | `Function`<br/>[See signature.](#signature-onperpagechange) | ✅ | | A callback function, called when `perPage` is changed.
|
|
52
|
+
| Props | Type | Required | Default | Description |
|
|
53
|
+
| ----------------- | ----------------------------------------------------------- | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
54
|
+
| `totalItems` | `number` | ✅ | | Total number of items across all pages |
|
|
55
|
+
| `page` | `number` | ✅ | | The current page |
|
|
56
|
+
| `onPageChange` | `Function`<br/>[See signature.](#signature-onpagechange) | ✅ | | A callback function, called when the page is changed. |
|
|
57
|
+
| `perPage` | `number` | | `20` | Number of items per page, according to the pre-defined range values. |
|
|
58
|
+
| `perPageRange` | `TPageRangeSize` | | `'s'` | Range of items per page.
<br/>
`xs: 5,10,15,20`
<br/>
`s: 20,50`
<br/>
`m: 20,50,100`
<br/>
`l: 200,500` |
|
|
59
|
+
| `onPerPageChange` | `Function`<br/>[See signature.](#signature-onperpagechange) | ✅ | | A callback function, called when `perPage` is changed. |
|
|
60
60
|
|
|
61
61
|
## Signatures
|
|
62
62
|
|
|
@@ -9,7 +9,6 @@ var jsxRuntime = require('@emotion/react/jsx-runtime');
|
|
|
9
9
|
var _defineProperty = require('@babel/runtime-corejs3/helpers/defineProperty');
|
|
10
10
|
var _slicedToArray = require('@babel/runtime-corejs3/helpers/slicedToArray');
|
|
11
11
|
var _includesInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/includes');
|
|
12
|
-
var _concatInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/concat');
|
|
13
12
|
var _mapInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/map');
|
|
14
13
|
var _Object$keys = require('@babel/runtime-corejs3/core-js-stable/object/keys');
|
|
15
14
|
var _Object$getOwnPropertySymbols = require('@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols');
|
|
@@ -36,7 +35,6 @@ function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e };
|
|
|
36
35
|
|
|
37
36
|
var Spacings__default = /*#__PURE__*/_interopDefault(Spacings);
|
|
38
37
|
var _includesInstanceProperty__default = /*#__PURE__*/_interopDefault(_includesInstanceProperty);
|
|
39
|
-
var _concatInstanceProperty__default = /*#__PURE__*/_interopDefault(_concatInstanceProperty);
|
|
40
38
|
var _mapInstanceProperty__default = /*#__PURE__*/_interopDefault(_mapInstanceProperty);
|
|
41
39
|
var _Object$keys__default = /*#__PURE__*/_interopDefault(_Object$keys);
|
|
42
40
|
var _Object$getOwnPropertySymbols__default = /*#__PURE__*/_interopDefault(_Object$getOwnPropertySymbols);
|
|
@@ -213,7 +211,7 @@ var messages$1 = messages;
|
|
|
213
211
|
|
|
214
212
|
const _excluded$1 = ["perPage", "perPageRange"];
|
|
215
213
|
function ownKeys(e, r) { var t = _Object$keys__default["default"](e); if (_Object$getOwnPropertySymbols__default["default"]) { var o = _Object$getOwnPropertySymbols__default["default"](e); r && (o = _filterInstanceProperty__default["default"](o).call(o, function (r) { return _Object$getOwnPropertyDescriptor__default["default"](e, r).enumerable; })), t.push.apply(t, o); } return t; }
|
|
216
|
-
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var
|
|
214
|
+
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context, _context2; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty__default["default"](_context = ownKeys(Object(t), !0)).call(_context, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](e, _Object$getOwnPropertyDescriptors__default["default"](t)) : _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(t))).call(_context2, function (r) { _Object$defineProperty__default["default"](e, r, _Object$getOwnPropertyDescriptor__default["default"](t, r)); }); } return e; }
|
|
217
215
|
const mapRangeToListOfOptions = perPageRange => {
|
|
218
216
|
switch (perPageRange) {
|
|
219
217
|
case 'xs':
|
|
@@ -225,11 +223,10 @@ const mapRangeToListOfOptions = perPageRange => {
|
|
|
225
223
|
case 'l':
|
|
226
224
|
return [200, 500];
|
|
227
225
|
default:
|
|
228
|
-
throw new Error(
|
|
226
|
+
throw new Error(`Invalid page range "${perPageRange}", expected one of "xs,s,m,l".`);
|
|
229
227
|
}
|
|
230
228
|
};
|
|
231
229
|
const PageSizeSelector = _ref => {
|
|
232
|
-
var _context;
|
|
233
230
|
let _ref$perPage = _ref.perPage,
|
|
234
231
|
perPage = _ref$perPage === void 0 ? 20 : _ref$perPage,
|
|
235
232
|
_ref$perPageRange = _ref.perPageRange,
|
|
@@ -240,7 +237,7 @@ const PageSizeSelector = _ref => {
|
|
|
240
237
|
perPageSelectorId = _useState2[0];
|
|
241
238
|
const options = mapRangeToListOfOptions(perPageRange);
|
|
242
239
|
const hasValidPerPageOption = _includesInstanceProperty__default["default"](options).call(options, perPage);
|
|
243
|
-
process.env.NODE_ENV !== "production" ? utils.warning(hasValidPerPageOption,
|
|
240
|
+
process.env.NODE_ENV !== "production" ? utils.warning(hasValidPerPageOption, `@commercetools-uikit/pagination: invalid page size ${perPage}. It must be one of the values of the selected range in "${options.toString()}".`) : void 0;
|
|
244
241
|
const onPerPageChange = props.onPerPageChange;
|
|
245
242
|
const handleSelectPerPage = react.useCallback(event => {
|
|
246
243
|
onPerPageChange(Number(event.target.value));
|
|
@@ -312,7 +309,7 @@ Pagination.displayName = 'Pagination';
|
|
|
312
309
|
var Pagination$1 = Pagination;
|
|
313
310
|
|
|
314
311
|
// NOTE: This string will be replaced on build time with the package version.
|
|
315
|
-
var version = "20.
|
|
312
|
+
var version = "20.6.0";
|
|
316
313
|
|
|
317
314
|
exports.PageNavigator = PageNavigator$1;
|
|
318
315
|
exports.PageSizeSelector = PageSizeSelector$1;
|
|
@@ -9,7 +9,6 @@ var jsxRuntime = require('@emotion/react/jsx-runtime');
|
|
|
9
9
|
var _defineProperty = require('@babel/runtime-corejs3/helpers/defineProperty');
|
|
10
10
|
var _slicedToArray = require('@babel/runtime-corejs3/helpers/slicedToArray');
|
|
11
11
|
var _includesInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/includes');
|
|
12
|
-
require('@babel/runtime-corejs3/core-js-stable/instance/concat');
|
|
13
12
|
var _mapInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/map');
|
|
14
13
|
var _Object$keys = require('@babel/runtime-corejs3/core-js-stable/object/keys');
|
|
15
14
|
var _Object$getOwnPropertySymbols = require('@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols');
|
|
@@ -212,7 +211,7 @@ var messages$1 = messages;
|
|
|
212
211
|
|
|
213
212
|
const _excluded$1 = ["perPage", "perPageRange"];
|
|
214
213
|
function ownKeys(e, r) { var t = _Object$keys__default["default"](e); if (_Object$getOwnPropertySymbols__default["default"]) { var o = _Object$getOwnPropertySymbols__default["default"](e); r && (o = _filterInstanceProperty__default["default"](o).call(o, function (r) { return _Object$getOwnPropertyDescriptor__default["default"](e, r).enumerable; })), t.push.apply(t, o); } return t; }
|
|
215
|
-
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var
|
|
214
|
+
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context, _context2; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty__default["default"](_context = ownKeys(Object(t), !0)).call(_context, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](e, _Object$getOwnPropertyDescriptors__default["default"](t)) : _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(t))).call(_context2, function (r) { _Object$defineProperty__default["default"](e, r, _Object$getOwnPropertyDescriptor__default["default"](t, r)); }); } return e; }
|
|
216
215
|
const mapRangeToListOfOptions = perPageRange => {
|
|
217
216
|
switch (perPageRange) {
|
|
218
217
|
case 'xs':
|
|
@@ -224,7 +223,7 @@ const mapRangeToListOfOptions = perPageRange => {
|
|
|
224
223
|
case 'l':
|
|
225
224
|
return [200, 500];
|
|
226
225
|
default:
|
|
227
|
-
throw new Error(
|
|
226
|
+
throw new Error(`Invalid page range "${perPageRange}", expected one of "xs,s,m,l".`);
|
|
228
227
|
}
|
|
229
228
|
};
|
|
230
229
|
const PageSizeSelector = _ref => {
|
|
@@ -304,7 +303,7 @@ Pagination.displayName = 'Pagination';
|
|
|
304
303
|
var Pagination$1 = Pagination;
|
|
305
304
|
|
|
306
305
|
// NOTE: This string will be replaced on build time with the package version.
|
|
307
|
-
var version = "20.
|
|
306
|
+
var version = "20.6.0";
|
|
308
307
|
|
|
309
308
|
exports.PageNavigator = PageNavigator$1;
|
|
310
309
|
exports.PageSizeSelector = PageSizeSelector$1;
|
|
@@ -5,7 +5,6 @@ import { jsx, jsxs } from '@emotion/react/jsx-runtime';
|
|
|
5
5
|
import _defineProperty from '@babel/runtime-corejs3/helpers/esm/defineProperty';
|
|
6
6
|
import _slicedToArray from '@babel/runtime-corejs3/helpers/esm/slicedToArray';
|
|
7
7
|
import _includesInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/includes';
|
|
8
|
-
import _concatInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/concat';
|
|
9
8
|
import _mapInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/map';
|
|
10
9
|
import _Object$keys from '@babel/runtime-corejs3/core-js-stable/object/keys';
|
|
11
10
|
import _Object$getOwnPropertySymbols from '@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols';
|
|
@@ -187,7 +186,7 @@ var messages$1 = messages;
|
|
|
187
186
|
|
|
188
187
|
const _excluded$1 = ["perPage", "perPageRange"];
|
|
189
188
|
function ownKeys(e, r) { var t = _Object$keys(e); if (_Object$getOwnPropertySymbols) { var o = _Object$getOwnPropertySymbols(e); r && (o = _filterInstanceProperty(o).call(o, function (r) { return _Object$getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
|
|
190
|
-
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var
|
|
189
|
+
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context, _context2; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty(_context = ownKeys(Object(t), !0)).call(_context, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(e, _Object$getOwnPropertyDescriptors(t)) : _forEachInstanceProperty(_context2 = ownKeys(Object(t))).call(_context2, function (r) { _Object$defineProperty(e, r, _Object$getOwnPropertyDescriptor(t, r)); }); } return e; }
|
|
191
190
|
const mapRangeToListOfOptions = perPageRange => {
|
|
192
191
|
switch (perPageRange) {
|
|
193
192
|
case 'xs':
|
|
@@ -199,11 +198,10 @@ const mapRangeToListOfOptions = perPageRange => {
|
|
|
199
198
|
case 'l':
|
|
200
199
|
return [200, 500];
|
|
201
200
|
default:
|
|
202
|
-
throw new Error(
|
|
201
|
+
throw new Error(`Invalid page range "${perPageRange}", expected one of "xs,s,m,l".`);
|
|
203
202
|
}
|
|
204
203
|
};
|
|
205
204
|
const PageSizeSelector = _ref => {
|
|
206
|
-
var _context;
|
|
207
205
|
let _ref$perPage = _ref.perPage,
|
|
208
206
|
perPage = _ref$perPage === void 0 ? 20 : _ref$perPage,
|
|
209
207
|
_ref$perPageRange = _ref.perPageRange,
|
|
@@ -214,7 +212,7 @@ const PageSizeSelector = _ref => {
|
|
|
214
212
|
perPageSelectorId = _useState2[0];
|
|
215
213
|
const options = mapRangeToListOfOptions(perPageRange);
|
|
216
214
|
const hasValidPerPageOption = _includesInstanceProperty(options).call(options, perPage);
|
|
217
|
-
process.env.NODE_ENV !== "production" ? warning(hasValidPerPageOption,
|
|
215
|
+
process.env.NODE_ENV !== "production" ? warning(hasValidPerPageOption, `@commercetools-uikit/pagination: invalid page size ${perPage}. It must be one of the values of the selected range in "${options.toString()}".`) : void 0;
|
|
218
216
|
const onPerPageChange = props.onPerPageChange;
|
|
219
217
|
const handleSelectPerPage = useCallback(event => {
|
|
220
218
|
onPerPageChange(Number(event.target.value));
|
|
@@ -286,6 +284,6 @@ Pagination.displayName = 'Pagination';
|
|
|
286
284
|
var Pagination$1 = Pagination;
|
|
287
285
|
|
|
288
286
|
// NOTE: This string will be replaced on build time with the package version.
|
|
289
|
-
var version = "20.
|
|
287
|
+
var version = "20.6.0";
|
|
290
288
|
|
|
291
289
|
export { PageNavigator$1 as PageNavigator, PageSizeSelector$1 as PageSizeSelector, Pagination$1 as Pagination, version };
|
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": "20.
|
|
4
|
+
"version": "20.6.0",
|
|
5
5
|
"bugs": "https://github.com/commercetools/ui-kit/issues",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -9,7 +9,13 @@
|
|
|
9
9
|
"directory": "packages/components/pagination"
|
|
10
10
|
},
|
|
11
11
|
"homepage": "https://uikit.commercetools.com",
|
|
12
|
-
"keywords": [
|
|
12
|
+
"keywords": [
|
|
13
|
+
"javascript",
|
|
14
|
+
"typescript",
|
|
15
|
+
"design-system",
|
|
16
|
+
"react",
|
|
17
|
+
"uikit"
|
|
18
|
+
],
|
|
13
19
|
"license": "MIT",
|
|
14
20
|
"publishConfig": {
|
|
15
21
|
"access": "public"
|
|
@@ -17,24 +23,26 @@
|
|
|
17
23
|
"sideEffects": false,
|
|
18
24
|
"main": "dist/commercetools-uikit-pagination.cjs.js",
|
|
19
25
|
"module": "dist/commercetools-uikit-pagination.esm.js",
|
|
20
|
-
"files": [
|
|
26
|
+
"files": [
|
|
27
|
+
"dist"
|
|
28
|
+
],
|
|
21
29
|
"dependencies": {
|
|
22
30
|
"@babel/runtime": "^7.20.13",
|
|
23
31
|
"@babel/runtime-corejs3": "^7.20.13",
|
|
24
|
-
"@commercetools-uikit/constraints": "20.5.0",
|
|
25
|
-
"@commercetools-uikit/design-system": "20.5.0",
|
|
26
|
-
"@commercetools-uikit/icons": "20.5.0",
|
|
27
|
-
"@commercetools-uikit/label": "20.5.0",
|
|
28
|
-
"@commercetools-uikit/number-input": "20.5.0",
|
|
29
|
-
"@commercetools-uikit/secondary-icon-button": "20.5.0",
|
|
30
|
-
"@commercetools-uikit/select-input": "20.5.0",
|
|
31
|
-
"@commercetools-uikit/spacings": "20.5.0",
|
|
32
|
-
"@commercetools-uikit/text": "20.5.0",
|
|
33
|
-
"@commercetools-uikit/utils": "20.5.0",
|
|
34
32
|
"@emotion/react": "^11.10.5",
|
|
35
33
|
"@emotion/styled": "^11.10.5",
|
|
36
34
|
"formik": "^2.4.6",
|
|
37
|
-
"lodash": "4.
|
|
35
|
+
"lodash": "4.18.1",
|
|
36
|
+
"@commercetools-uikit/design-system": "^20.6.0",
|
|
37
|
+
"@commercetools-uikit/constraints": "^20.6.0",
|
|
38
|
+
"@commercetools-uikit/number-input": "^20.6.0",
|
|
39
|
+
"@commercetools-uikit/label": "^20.6.0",
|
|
40
|
+
"@commercetools-uikit/icons": "^20.6.0",
|
|
41
|
+
"@commercetools-uikit/secondary-icon-button": "^20.6.0",
|
|
42
|
+
"@commercetools-uikit/select-input": "^20.6.0",
|
|
43
|
+
"@commercetools-uikit/utils": "^20.6.0",
|
|
44
|
+
"@commercetools-uikit/text": "^20.6.0",
|
|
45
|
+
"@commercetools-uikit/spacings": "^20.6.0"
|
|
38
46
|
},
|
|
39
47
|
"devDependencies": {
|
|
40
48
|
"react": "19.2.0",
|
|
@@ -44,4 +52,4 @@
|
|
|
44
52
|
"react": "19.x",
|
|
45
53
|
"react-intl": "7.x"
|
|
46
54
|
}
|
|
47
|
-
}
|
|
55
|
+
}
|