@pingux/astro 1.10.0-alpha.1 → 1.10.0-alpha.2

package/lib/cjs/components/ArrayField/ArrayField.js

@@ -58,9 +58,11 @@ var _Text = _interopRequireDefault(require("../Text"));
 
 var _statuses = _interopRequireDefault(require("../../utils/devUtils/constants/statuses"));
 
+var _isValidPositiveInt = _interopRequireDefault(require("../../utils/devUtils/props/isValidPositiveInt"));
+
 var _react2 = require("@emotion/react");
 
-var _excluded = ["addButtonLabel", "defaultValue", "value", "label", "helperText", "status", "onAdd", "onChange", "onDelete", "renderField"],
+var _excluded = ["addButtonLabel", "defaultValue", "value", "label", "helperText", "status", "onAdd", "onChange", "onDelete", "renderField", "maxSize", "maxSizeText"],
     _excluded2 = ["id", "onComponentRender", "fieldValue"];
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof _WeakMap !== "function") return null; var cacheBabelInterop = new _WeakMap(); var cacheNodeInterop = new _WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -84,6 +86,8 @@ var ArrayField = function ArrayField(_ref) {
       onChange = _ref.onChange,
       onDelete = _ref.onDelete,
       renderField = _ref.renderField,
+      maxSize = _ref.maxSize,
+      maxSizeText = _ref.maxSizeText,
       others = (0, _objectWithoutProperties2["default"])(_ref, _excluded);
   var isControlled = value !== undefined;
   var createEmptyField = (0, _react.useCallback)(function () {
@@ -147,6 +151,7 @@ var ArrayField = function ArrayField(_ref) {
       return (0, _concat["default"])(_context = []).call(_context, oldValues, [createEmptyField()]);
     });
   }, [createEmptyField, onAdd]);
+  var isLimitReached = !!maxSize && (value || fieldValues).length >= maxSize;
   return (0, _react2.jsx)(_Box["default"], others, (0, _react2.jsx)(_Text["default"], {
     variant: "label"
   }, label), (0, _react2.jsx)(_Box["default"], {
@@ -165,7 +170,9 @@ var ArrayField = function ArrayField(_ref) {
     }, onComponentRender ? onComponentRender(id, fieldValue, onFieldValueChange, onFieldDelete, isDisabled, otherFieldProps) : renderField(id, fieldValue, onFieldValueChange, onFieldDelete, isDisabled, otherFieldProps));
   })), helperText && (0, _react2.jsx)(_FieldHelperText["default"], {
     status: status
-  }, helperText), (0, _react2.jsx)(_Button["default"], {
+  }, helperText), isLimitReached && (0, _react2.jsx)(_FieldHelperText["default"], {
+    status: _statuses["default"].DEFAULT
+  }, maxSizeText || "Maximum ".concat(maxSize, " items.")), !isLimitReached && (0, _react2.jsx)(_Button["default"], {
     "aria-label": "Add field",
     variant: "text",
     onPress: onFieldAdd,
@@ -213,7 +220,13 @@ ArrayField.propTypes = {
   renderField: _propTypes["default"].func,
 
   /** Determines the helper text styling. */
-  status: _propTypes["default"].oneOf((0, _values["default"])(_statuses["default"]))
+  status: _propTypes["default"].oneOf((0, _values["default"])(_statuses["default"])),
+
+  /** Determines the maximum number of items */
+  maxSize: _isValidPositiveInt["default"],
+
+  /** Text to display when the maximum number of items is reached */
+  maxSizeText: _propTypes["default"].node
 };
 ArrayField.defaultProps = {
   addButtonLabel: '+ Add'

package/lib/cjs/components/ArrayField/ArrayField.stories.js

@@ -8,7 +8,7 @@ _Object$defineProperty(exports, "__esModule", {
   value: true
 });
 
-exports["default"] = exports.Uncontrolled = exports.Controlled = void 0;
+exports["default"] = exports.WithLimitedItemsNumber = exports.Uncontrolled = exports.Controlled = void 0;
 
 var _filter = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/filter"));
 
@@ -58,6 +58,16 @@ var _default = {
       control: {
         type: 'text'
       }
+    },
+    maxSize: {
+      control: {
+        type: 'number'
+      }
+    },
+    maxSizeText: {
+      control: {
+        type: 'text'
+      }
     }
   }
 };
@@ -220,4 +230,35 @@ var Controlled = function Controlled() {
   });
 };
 
-exports.Controlled = Controlled;
+exports.Controlled = Controlled;
+
+var WithLimitedItemsNumber = function WithLimitedItemsNumber(_ref3) {
+  var args = (0, _extends2["default"])({}, _ref3);
+  return (0, _react2.jsx)(_index.ArrayField, (0, _extends2["default"])({
+    defaultValue: defaultData,
+    renderField: function renderField(id, fieldValue, onFieldValueChange, onFieldDelete, isDisabled, otherFieldProps) {
+      return (0, _react2.jsx)(_index.TextField, (0, _extends2["default"])({
+        "aria-label": "Text field",
+        value: fieldValue,
+        onChange: function onChange(e) {
+          return onFieldValueChange(e, id);
+        },
+        mr: "xs",
+        slots: {
+          inContainer: (0, _react2.jsx)(_index.ArrayFieldDeleteButton, {
+            isDisabled: isDisabled,
+            onDelete: function onDelete() {
+              return onFieldDelete(id);
+            }
+          })
+        }
+      }, otherFieldProps));
+    },
+    sx: {
+      width: '400px'
+    },
+    maxSize: 3
+  }, args));
+};
+
+exports.WithLimitedItemsNumber = WithLimitedItemsNumber;

package/lib/cjs/components/ArrayField/ArrayField.test.js

@@ -218,4 +218,27 @@ test('check if tooltip on delete button renders on hover', function () {
   _testWrapper.fireEvent.mouseEnter(button);
 
   expect(_testWrapper.screen.queryByRole('tooltip')).not.toBeInTheDocument();
+});
+test('removes add button if max number of fields is reached', function () {
+  getComponent({
+    renderField: renderField,
+    maxSize: 3
+  });
+  expect(_testWrapper.screen.getAllByLabelText('Text field')).toHaveLength(2);
+
+  _testWrapper.fireEvent.click(_testWrapper.screen.getByText('+ Add'));
+
+  expect(_testWrapper.screen.getAllByLabelText('Text field')).toHaveLength(3);
+  expect(_testWrapper.screen.queryByText('+ Add')).not.toBeInTheDocument();
+  expect(_testWrapper.screen.getByText('Maximum 3 items.')).toBeInTheDocument();
+});
+test('displays max size label if provided', function () {
+  var maxSizeText = 'Too many fields';
+  getComponent({
+    renderField: renderField,
+    maxSize: 1,
+    maxSizeText: maxSizeText
+  });
+  expect(_testWrapper.screen.queryByText('+ Add')).not.toBeInTheDocument();
+  expect(_testWrapper.screen.getByText(maxSizeText)).toBeInTheDocument();
 });

package/lib/components/ArrayField/ArrayField.js

@@ -12,7 +12,7 @@ import _defineProperty from "@babel/runtime-corejs3/helpers/esm/defineProperty";
 import _mapInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/map";
 import _slicedToArray from "@babel/runtime-corejs3/helpers/esm/slicedToArray";
 import _objectWithoutProperties from "@babel/runtime-corejs3/helpers/esm/objectWithoutProperties";
-var _excluded = ["addButtonLabel", "defaultValue", "value", "label", "helperText", "status", "onAdd", "onChange", "onDelete", "renderField"],
+var _excluded = ["addButtonLabel", "defaultValue", "value", "label", "helperText", "status", "onAdd", "onChange", "onDelete", "renderField", "maxSize", "maxSizeText"],
     _excluded2 = ["id", "onComponentRender", "fieldValue"];
 
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -27,6 +27,7 @@ import Button from '../Button';
 import FieldHelperText from '../FieldHelperText';
 import Text from '../Text';
 import statuses from '../../utils/devUtils/constants/statuses';
+import isValidPositiveInt from '../../utils/devUtils/props/isValidPositiveInt';
 import { jsx as ___EmotionJSX } from "@emotion/react";
 
 var ArrayField = function ArrayField(_ref) {
@@ -42,6 +43,8 @@ var ArrayField = function ArrayField(_ref) {
       onChange = _ref.onChange,
       onDelete = _ref.onDelete,
       renderField = _ref.renderField,
+      maxSize = _ref.maxSize,
+      maxSizeText = _ref.maxSizeText,
       others = _objectWithoutProperties(_ref, _excluded);
 
   var isControlled = value !== undefined;
@@ -106,6 +109,7 @@ var ArrayField = function ArrayField(_ref) {
       return _concatInstanceProperty(_context = []).call(_context, oldValues, [createEmptyField()]);
     });
   }, [createEmptyField, onAdd]);
+  var isLimitReached = !!maxSize && (value || fieldValues).length >= maxSize;
   return ___EmotionJSX(Box, others, ___EmotionJSX(Text, {
     variant: "label"
   }, label), ___EmotionJSX(Box, {
@@ -125,7 +129,9 @@ var ArrayField = function ArrayField(_ref) {
     }, onComponentRender ? onComponentRender(id, fieldValue, onFieldValueChange, onFieldDelete, isDisabled, otherFieldProps) : renderField(id, fieldValue, onFieldValueChange, onFieldDelete, isDisabled, otherFieldProps));
   })), helperText && ___EmotionJSX(FieldHelperText, {
     status: status
-  }, helperText), ___EmotionJSX(Button, {
+  }, helperText), isLimitReached && ___EmotionJSX(FieldHelperText, {
+    status: statuses.DEFAULT
+  }, maxSizeText || "Maximum ".concat(maxSize, " items.")), !isLimitReached && ___EmotionJSX(Button, {
     "aria-label": "Add field",
     variant: "text",
     onPress: onFieldAdd,
@@ -173,7 +179,13 @@ ArrayField.propTypes = {
   renderField: PropTypes.func,
 
   /** Determines the helper text styling. */
-  status: PropTypes.oneOf(_Object$values(statuses))
+  status: PropTypes.oneOf(_Object$values(statuses)),
+
+  /** Determines the maximum number of items */
+  maxSize: isValidPositiveInt,
+
+  /** Text to display when the maximum number of items is reached */
+  maxSizeText: PropTypes.node
 };
 ArrayField.defaultProps = {
   addButtonLabel: '+ Add'

package/lib/components/ArrayField/ArrayField.stories.js

@@ -37,6 +37,16 @@ export default {
       control: {
         type: 'text'
       }
+    },
+    maxSize: {
+      control: {
+        type: 'number'
+      }
+    },
+    maxSizeText: {
+      control: {
+        type: 'text'
+      }
     }
   }
 };
@@ -193,4 +203,33 @@ export var Controlled = function Controlled() {
       width: '400px'
     }
   });
+};
+export var WithLimitedItemsNumber = function WithLimitedItemsNumber(_ref3) {
+  var args = _extends({}, _ref3);
+
+  return ___EmotionJSX(ArrayField, _extends({
+    defaultValue: defaultData,
+    renderField: function renderField(id, fieldValue, onFieldValueChange, onFieldDelete, isDisabled, otherFieldProps) {
+      return ___EmotionJSX(TextField, _extends({
+        "aria-label": "Text field",
+        value: fieldValue,
+        onChange: function onChange(e) {
+          return onFieldValueChange(e, id);
+        },
+        mr: "xs",
+        slots: {
+          inContainer: ___EmotionJSX(ArrayFieldDeleteButton, {
+            isDisabled: isDisabled,
+            onDelete: function onDelete() {
+              return onFieldDelete(id);
+            }
+          })
+        }
+      }, otherFieldProps));
+    },
+    sx: {
+      width: '400px'
+    },
+    maxSize: 3
+  }, args));
 };

package/lib/components/ArrayField/ArrayField.test.js

@@ -191,4 +191,25 @@ test('check if tooltip on delete button renders on hover', function () {
   fireEvent.mouseMove(button);
   fireEvent.mouseEnter(button);
   expect(screen.queryByRole('tooltip')).not.toBeInTheDocument();
+});
+test('removes add button if max number of fields is reached', function () {
+  getComponent({
+    renderField: renderField,
+    maxSize: 3
+  });
+  expect(screen.getAllByLabelText('Text field')).toHaveLength(2);
+  fireEvent.click(screen.getByText('+ Add'));
+  expect(screen.getAllByLabelText('Text field')).toHaveLength(3);
+  expect(screen.queryByText('+ Add')).not.toBeInTheDocument();
+  expect(screen.getByText('Maximum 3 items.')).toBeInTheDocument();
+});
+test('displays max size label if provided', function () {
+  var maxSizeText = 'Too many fields';
+  getComponent({
+    renderField: renderField,
+    maxSize: 1,
+    maxSizeText: maxSizeText
+  });
+  expect(screen.queryByText('+ Add')).not.toBeInTheDocument();
+  expect(screen.getByText(maxSizeText)).toBeInTheDocument();
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pingux/astro",
-  "version": "1.10.0-alpha.1",
+  "version": "1.10.0-alpha.2",
   "description": "PingUX themeable React component library",
   "author": "ux-development@pingidentity.com",
   "license": "Apache-2.0",