@zohodesk/components 1.4.7 → 1.4.9

package/README.md

@@ -2,15 +2,28 @@
 
 Dot UI is a customizable React component library built to deliver a clean, accessible, and developer-friendly UI experience. It offers a growing set of reusable components designed to align with modern design systems and streamline application development across projects.
 
+# 1.4.9
+
+- **MultiSelect , MultiSelectWithAvatar, AdvancedMultiSelect, AdvancedGroupMultiSelect**
+  - `limit` prop supported
+  - `limitReachedMessage` prop supported in i18nKeys
+
+# 1.4.8
+
+- Added UNSAFE_ prefix to deprecated lifecycle methods: componentWillMount, componentWillReceiveProps, and componentWillUpdate.
+
+- **Popup**
+  - Handled potential memory leaks by `event listeners`.
+  - Added unmount handling for `requestAnimationFrame` to ensure proper cleanup.
+
+
 # 1.4.7
 
-- **Card**
-  - Added support for reverse infinite scroll with `isRecentOnBottom`.
+- **Card** - Added support for reverse infinite scroll with `isRecentOnBottom`.
 
 # 1.4.6
 
-- **Popup**
-  - - Added fixed popup scroll block behavior support to iframe elements (same-origin only).
+- **Popup** -  Added fixed popup scroll block behavior support to iframe elements (same-origin only).
 
 # 1.4.5
 

package/es/Accordion/Accordion.js

@@ -25,7 +25,7 @@ export default class Accordion extends React.Component {
     });
   }
 
-  componentWillReceiveProps(nextProps) {
+  UNSAFE_componentWillReceiveProps(nextProps) {
     if (this.props.selectedItem !== nextProps.selectedItem && !this.props.disableInternalState) {
       this.setState({
         selectedItem: nextProps.selectedItem

package/es/Card/Card.js

@@ -102,7 +102,7 @@ export default class Card extends Component {
     //this.onClearScroll = debounce(this.setScroll.bind(this, false), 500);
   }
 
-  componentWillReceiveProps(nextProps) {
+  UNSAFE_componentWillReceiveProps(nextProps) {
     if (this.from !== nextProps.from) {
       this.from = nextProps.from;
     }

package/es/MultiSelect/AdvancedGroupMultiSelect.js

@@ -1,6 +1,7 @@
 import React from 'react';
 import { AdvancedGroupMultiSelect_propTypes } from "./props/propTypes";
 import { AdvancedGroupMultiSelect_defaultProps } from "./props/defaultProps";
+import { MULTISELECT_I18N_KEYS } from "./constants";
 /**** Components ****/
 
 import Loader from '@zohodesk/svg/lib/Loader/Loader';
@@ -185,7 +186,8 @@ class AdvancedGroupMultiSelect extends React.Component {
 
   handleSelectedOptionIdChange(selectedGroupOptions, normalizedFormatOptions, normalizedSelectedOptions) {
     const {
-      allowValueFallback
+      allowValueFallback,
+      limit
     } = this.props;
     let newSelectedOptions = selectedGroupOptions.map(option => optionIdGrouping(option.id, option.groupId));
     let selectedOptionsLength = newSelectedOptions.length;
@@ -197,7 +199,8 @@ class AdvancedGroupMultiSelect extends React.Component {
       selectedOptions: newSelectedOptions,
       normalizedFormatOptions: formatOptions,
       selectedOptionsLength,
-      allowValueFallback
+      allowValueFallback,
+      limit
     });
   }
 
@@ -390,7 +393,8 @@ class AdvancedGroupMultiSelect extends React.Component {
       getNextOptions,
       isPopupOpen,
       isPopupOpenOnEnter,
-      onKeyDown
+      onKeyDown,
+      limit
     } = this.props;
     let highLightedSelectOptionsLen = highLightedSelectOptions.length;
 
@@ -442,7 +446,7 @@ class AdvancedGroupMultiSelect extends React.Component {
           hoverIndex: hoverIndex + 1
         });
       }
-    } else if (keyCode === 13) {
+    } else if (keyCode === 13 && selectedOptions.length < limit) {
       //enter key
       let id = suggestions[hoverIndex] || {};
       isPopupOpen && !getIsEmptyValue(id) && this.handleSelectOption(id, null, null, e);
@@ -884,13 +888,15 @@ class AdvancedGroupMultiSelect extends React.Component {
       needEffect,
       autoComplete,
       getTargetRef,
-      isFocus
+      isFocus,
+      limit
     } = this.props;
     let {
-      clearText = 'Clear all'
+      clearText = MULTISELECT_I18N_KEYS.clearText,
+      limitReachedMessage = MULTISELECT_I18N_KEYS.limitReachedMessage
     } = i18nKeys;
     let {
-      clearLabel = 'Clear all'
+      clearLabel = MULTISELECT_I18N_KEYS.clearText
     } = a11y;
     i18nKeys = Object.assign({}, i18nKeys, {
       emptyText: i18nKeys.emptyText || emptyMessage,
@@ -1026,7 +1032,7 @@ class AdvancedGroupMultiSelect extends React.Component {
       }, /*#__PURE__*/React.createElement(Card, {
         customClass: `${style.box} ${style[`${palette}Box`]}`,
         onScroll: this.handleScroll
-      }, needSelectAll ? /*#__PURE__*/React.createElement(CardHeader, null, /*#__PURE__*/React.createElement(MultiSelectHeader, {
+      }, needSelectAll && !(limit >= 0) ? /*#__PURE__*/React.createElement(CardHeader, null, /*#__PURE__*/React.createElement(MultiSelectHeader, {
         onSelect: this.handleSelectAll,
         selectAllText: selectAllText,
         suggestions: suggestionOptionIds,
@@ -1065,6 +1071,8 @@ class AdvancedGroupMultiSelect extends React.Component {
           a11y: {
             role: 'option'
           },
+          limit: limit,
+          limitReachedMessage: limitReachedMessage,
           dataId: `${dataId}_Options`
         }));
       }) : /*#__PURE__*/React.createElement(EmptyState, {

package/es/MultiSelect/AdvancedMultiSelect.js

@@ -2,6 +2,7 @@
 import React from 'react';
 import { AdvancedMultiSelect_propTypes } from "./props/propTypes";
 import { AdvancedMultiSelect_defaultProps } from "./props/defaultProps";
+import { MULTISELECT_I18N_KEYS } from "./constants";
 /**** Components ****/
 
 import { MultiSelectComponent } from "./MultiSelect";
@@ -177,7 +178,8 @@ export class AdvancedMultiSelectComponent extends MultiSelectComponent {
     const {
       selectedOptionsLimit,
       selectedOptionDetails,
-      allowValueFallback
+      allowValueFallback,
+      limit
     } = props;
     showedSelectedOptionsCount = getIsEmptyValue(showedSelectedOptionsCount) ? selectedOptionsLimit : showedSelectedOptionsCount;
     const {
@@ -191,7 +193,8 @@ export class AdvancedMultiSelectComponent extends MultiSelectComponent {
       selectedOptions,
       normalizedFormatOptions: formatOptions,
       selectedOptionsLength: showedSelectedOptionsCount,
-      allowValueFallback: allowValueFallback
+      allowValueFallback,
+      limit
     });
   }
 
@@ -385,7 +388,8 @@ export class AdvancedMultiSelectComponent extends MultiSelectComponent {
       positionsOffset,
       targetOffset,
       isRestrictScroll,
-      isFocus
+      isFocus,
+      limit
     } = this.props;
     let {
       SuggestionsProps = {},
@@ -395,10 +399,11 @@ export class AdvancedMultiSelectComponent extends MultiSelectComponent {
       containerClass = ''
     } = customClass;
     const {
-      clearText = 'Clear all'
+      clearText = MULTISELECT_I18N_KEYS.clearText,
+      limitReachedMessage = MULTISELECT_I18N_KEYS.limitReachedMessage
     } = i18nKeys;
     const {
-      clearLabel = 'Clear all'
+      clearLabel = MULTISELECT_I18N_KEYS.clearText
     } = a11y;
     i18nKeys = Object.assign({}, i18nKeys, {
       emptyText: i18nKeys.emptyText || emptyMessage,
@@ -541,7 +546,7 @@ export class AdvancedMultiSelectComponent extends MultiSelectComponent {
       }, /*#__PURE__*/React.createElement(Card, {
         customClass: style.box,
         onScroll: this.handleScroll
-      }, needSelectAll ? /*#__PURE__*/React.createElement(CardHeader, null, /*#__PURE__*/React.createElement(MultiSelectHeader, {
+      }, needSelectAll && !(limit >= 0) ? /*#__PURE__*/React.createElement(CardHeader, null, /*#__PURE__*/React.createElement(MultiSelectHeader, {
         onSelect: this.handleSelectAll,
         selectAllText: selectAllText,
         suggestions: suggestions,
@@ -563,6 +568,8 @@ export class AdvancedMultiSelectComponent extends MultiSelectComponent {
           role: 'option'
         },
         dataId: `${dataIdMultiSelectComp}_Options`,
+        limit: limit,
+        limitReachedMessage: limitReachedMessage,
         ...SuggestionsProps
       }) : /*#__PURE__*/React.createElement(EmptyState, {
         isLoading: isFetchingOptions,

package/es/MultiSelect/EmptyState.js

@@ -2,6 +2,7 @@
 import React from 'react';
 import { EmptyState_propTypes } from "./props/propTypes";
 import { EmptyState_defaultProps } from "./props/defaultProps";
+import { MULTISELECT_I18N_KEYS } from "./constants";
 /**** CSS ****/
 
 import style from "./MultiSelect.module.css";
@@ -23,7 +24,7 @@ export default class EmptyState extends React.PureComponent {
       a11y
     } = this.props;
     let {
-      loadingText = 'Loading',
+      loadingText = MULTISELECT_I18N_KEYS.loadingText,
       emptyText = emptyMessage,
       noMoreText = noMoreOptionsMessage,
       searchEmptyText = searchEmptyMessage

package/es/MultiSelect/MultiSelect.js

@@ -3,6 +3,7 @@ import React from 'react';
 import { MultiSelect_propTypes } from "./props/propTypes";
 import { MultiSelect_defaultProps } from "./props/defaultProps";
 import { defaultProps as MobileHeader_defaultProps } from "./MobileHeader/props/defaultProps";
+import { MULTISELECT_I18N_KEYS } from "./constants";
 /**** Components ****/
 
 import Popup from "../Popup/Popup";
@@ -89,7 +90,7 @@ export class MultiSelectComponent extends React.Component {
     //   suggestionContainer.addEventListener('scroll', this.handleScroll);
   }
 
-  componentWillReceiveProps(nextProps) {
+  UNSAFE_componentWillReceiveProps(nextProps) {
     const {
       selectedOptions,
       options,
@@ -234,12 +235,14 @@ export class MultiSelectComponent extends React.Component {
 
   handleGetSelectedOptions(selectedOptions, normalizedFormatOptions, props) {
     const {
-      allowValueFallback
+      allowValueFallback,
+      limit
     } = props;
     return this.getSelectedOptions({
       selectedOptions,
       normalizedFormatOptions,
-      allowValueFallback
+      allowValueFallback,
+      limit
     });
   }
 
@@ -313,8 +316,10 @@ export class MultiSelectComponent extends React.Component {
       getNextOptions,
       isPopupOpen,
       isPopupOpenOnEnter,
-      onKeyDown
+      onKeyDown,
+      limit
     } = this.props;
+    const allowKeyboardActions = !limit || limit && selectedOptions.length < limit;
     const highLightedSelectOptionsLen = highLightedSelectOptions.length;
 
     if (isPopupOpen && (keyCode === 38 || keyCode === 40 || keyCode === 13 || keyCode === 27 || keyCode === 9)) {
@@ -334,7 +339,7 @@ export class MultiSelectComponent extends React.Component {
 
     const suggestionsLen = suggestions.length;
 
-    if (suggestionsLen && isPopupOpen && keyCode === 38) {
+    if (suggestionsLen && isPopupOpen && keyCode === 38 && allowKeyboardActions) {
       //up arrow
 
       /*if (hoverOption === 0) { //disable first to last option higlight
@@ -345,7 +350,7 @@ export class MultiSelectComponent extends React.Component {
           hoverOption: hoverOption - 1
         });
       }
-    } else if (suggestionsLen && isPopupOpen && keyCode === 40) {
+    } else if (suggestionsLen && isPopupOpen && keyCode === 40 && allowKeyboardActions) {
       //down arrow
 
       /*else if (hoverOption === suggestionsLen - 1 || hoverOption === null) {
@@ -362,8 +367,8 @@ export class MultiSelectComponent extends React.Component {
           hoverOption: hoverOption + 1
         });
       }
-    } else if (keyCode === 13) {
-      //enter key
+    } else if (keyCode === 13 && allowKeyboardActions) {
+      //enter ke
       const selectedOption = suggestions[hoverOption] || {};
       const {
         id
@@ -727,14 +732,16 @@ export class MultiSelectComponent extends React.Component {
       needToCloseOnSelect,
       togglePopup,
       selectedOptions: propSelectedOptions,
-      disabledOptions = dummyArray
+      disabledOptions = dummyArray,
+      limit
     } = this.props;
     const {
       newSelectedOptions
     } = filterSelectedOptions({
       selectedOptions,
       propSelectedOptions,
-      disabledOptions
+      disabledOptions,
+      limit
     });
     const selectedOptionsLen = newSelectedOptions.length;
     const allSelectedOptionsDetails = [];
@@ -894,10 +901,10 @@ export class MultiSelectComponent extends React.Component {
       searchStr
     } = this.state;
     const {
-      clearText = 'Clear all'
+      clearText = MULTISELECT_I18N_KEYS.clearText
     } = i18nKeys;
     const {
-      clearLabel = 'Clear all',
+      clearLabel = MULTISELECT_I18N_KEYS.clearLabel,
       ariaLabelledby
     } = a11y;
     let {
@@ -1034,7 +1041,8 @@ export class MultiSelectComponent extends React.Component {
       boxSize,
       isLoading,
       selectAllText,
-      needSelectAll
+      needSelectAll,
+      limit
     } = this.props;
     const {
       selectedOptions,
@@ -1045,7 +1053,8 @@ export class MultiSelectComponent extends React.Component {
       selectedOptionIds
     } = this.state;
     const {
-      searchText = 'Searching...'
+      searchText = MULTISELECT_I18N_KEYS.searchText,
+      limitReachedMessage = MULTISELECT_I18N_KEYS.limitReachedMessage
     } = i18nKeys;
     const suggestions = this.handleFilterSuggestions();
     const setAriaId = this.getNextAriaId();
@@ -1099,7 +1108,7 @@ export class MultiSelectComponent extends React.Component {
       onClick: this.handlePopupClose
     }, /*#__PURE__*/React.createElement("div", {
       className: style.effect
-    }, this.getSelectionUI(true))) : null, needSelectAll ? /*#__PURE__*/React.createElement(CardHeader, null, /*#__PURE__*/React.createElement(MultiSelectHeader, {
+    }, this.getSelectionUI(true))) : null, needSelectAll && !(limit >= 0) ? /*#__PURE__*/React.createElement(CardHeader, null, /*#__PURE__*/React.createElement(MultiSelectHeader, {
       onSelect: this.handleSelectAll,
       selectAllText: selectAllText,
       suggestions: suggestions,
@@ -1125,7 +1134,9 @@ export class MultiSelectComponent extends React.Component {
       selectedOptions: selectedOptionIds,
       a11y: {
         role: 'option'
-      }
+      },
+      limit: limit,
+      limitReachedMessage: limitReachedMessage
     }) : /*#__PURE__*/React.createElement(EmptyState, {
       isLoading: isFetchingOptions,
       options: options,

package/es/MultiSelect/MultiSelectWithAvatar.js

@@ -3,6 +3,7 @@ import React from 'react';
 import { MultiSelectWithAvatar_propTypes } from "./props/propTypes";
 import { MultiSelectWithAvatar_defaultProps } from "./props/defaultProps";
 import { defaultProps as MobileHeader_defaultProps } from "./MobileHeader/props/defaultProps";
+import { MULTISELECT_I18N_KEYS } from "./constants";
 /**** Components ****/
 
 import { MultiSelectComponent } from "./MultiSelect";
@@ -93,11 +94,15 @@ class MultiSelectWithAvatarComponent extends MultiSelectComponent {
       needEffect,
       isLoading,
       keepSelectedOptions,
-      customProps
+      customProps,
+      limit
     } = this.props;
     let {
       SuggestionsProps = {}
     } = customProps;
+    let {
+      limitReachedMessage = MULTISELECT_I18N_KEYS.limitReachedMessage
+    } = i18nKeys;
     i18nKeys = Object.assign({}, MobileHeader_defaultProps.i18nKeys, i18nKeys, {
       emptyText: i18nKeys.emptyText || emptyMessage,
       searchEmptyText: i18nKeys.searchEmptyText || searchEmptyMessage,
@@ -158,7 +163,7 @@ class MultiSelectWithAvatarComponent extends MultiSelectComponent {
       onClick: this.handlePopupClose
     }, /*#__PURE__*/React.createElement("div", {
       className: style.effect
-    }, this.getSelectionUI(true)))) : null, needSelectAll ? /*#__PURE__*/React.createElement(CardHeader, null, /*#__PURE__*/React.createElement(MultiSelectHeader, {
+    }, this.getSelectionUI(true)))) : null, needSelectAll && !(limit >= 0) ? /*#__PURE__*/React.createElement(CardHeader, null, /*#__PURE__*/React.createElement(MultiSelectHeader, {
       onSelect: this.handleSelectAll,
       selectAllText: selectAllText,
       suggestions: suggestions,
@@ -184,6 +189,8 @@ class MultiSelectWithAvatarComponent extends MultiSelectComponent {
       a11y: {
         role: 'option'
       },
+      limit: limit,
+      limitReachedMessage: limitReachedMessage,
       ...SuggestionsProps
     }) : /*#__PURE__*/React.createElement(EmptyState, {
       isLoading: isFetchingOptions,

package/es/MultiSelect/SelectedOptions.js

@@ -22,10 +22,12 @@ export default class SelectedOptions extends React.PureComponent {
       onSelect,
       size,
       palette,
-      dataId
+      dataId,
+      limit
     } = this.props;
     const isDarkPalette = palette === 'dark' ? 'dark' : 'danger';
-    return /*#__PURE__*/React.createElement(React.Fragment, null, selectedOptions.map(option => {
+    const selectedData = limit && limit > 0 ? selectedOptions.slice(0, limit) : selectedOptions;
+    return /*#__PURE__*/React.createElement(React.Fragment, null, selectedData.map(option => {
       const {
         id,
         value,

package/es/MultiSelect/Suggestions.js

@@ -28,12 +28,15 @@ export default class Suggestions extends React.PureComponent {
       palette,
       htmlId,
       a11y,
-      needMultiLineText
+      needMultiLineText,
+      limit,
+      limitReachedMessage
     } = this.props;
     const {
       ariaParentRole,
       ariaMultiselectable
     } = a11y;
+    const selectedOptionsLength = selectedOptions.length;
     return /*#__PURE__*/React.createElement(Container, {
       isCover: false,
       role: ariaParentRole,
@@ -58,13 +61,14 @@ export default class Suggestions extends React.PureComponent {
       } = suggestion;
       const isActive = activeId === id || selectedOptions.indexOf(id) >= 0;
       const isHighlight = hoverOption === index || id === hoverId ? true : false;
+      const isLimitReached = selectedOptionsLength >= limit && !isActive;
       const list_a11y = Object.assign({}, a11y, {
         ariaSelected: isActive,
         ariaLabel: value,
         'data-a11y-list-active': isHighlight
       });
       const commonProps = {
-        isDisabled,
+        isDisabled: isDisabled ? isDisabled : isLimitReached,
         needMultiLineText,
         ...listItemCustomProps
       };
@@ -76,6 +80,10 @@ export default class Suggestions extends React.PureComponent {
         };
       }
 
+      if (isLimitReached) {
+        commonProps.disableTitle = limitReachedMessage;
+      }
+
       if (optionType === 'avatar') {
         return /*#__PURE__*/React.createElement(ListItemWithAvatar, { ...commonProps,
           autoHover: false,

package/es/MultiSelect/__tests__/MultiSelect.spec.js

@@ -1,6 +1,8 @@
 import React from 'react';
 import { render } from '@testing-library/react';
 import MultiSelect from "../MultiSelect";
+const testData = ['text1', 'text2', 'text3', 'text4', 'text5', 'text6', 'text7', 'text8', 'text9', 'text10'];
+const testSelectedData = ['text1', 'text2', 'text3'];
 describe('MultiSelect', () => {
   test('rendering the defult props', () => {
     const {
@@ -8,4 +10,27 @@ describe('MultiSelect', () => {
     } = render( /*#__PURE__*/React.createElement(MultiSelect, null));
     expect(asFragment()).toMatchSnapshot();
   });
+  test('rendering with limit feature', () => {
+    const {
+      asFragment
+    } = render( /*#__PURE__*/React.createElement(MultiSelect, {
+      valueField: "id",
+      textField: "text",
+      options: testData,
+      selectedOptions: testSelectedData,
+      needSelectAll: true,
+      selectAllText: "Select All",
+      placeHolder: "Select Text",
+      i18nKeys: {
+        clearText: 'Clear Selected Items',
+        loadingText: 'Fetching...',
+        emptyText: 'No Options .',
+        noMoreText: 'No More Options .',
+        searchEmptyText: 'No Matches Found .'
+      },
+      needResponsive: true,
+      limit: 3
+    }));
+    expect(asFragment()).toMatchSnapshot();
+  });
 });

package/es/MultiSelect/__tests__/Suggestions.spec.js

@@ -1,6 +1,53 @@
 import React from 'react';
 import { render } from '@testing-library/react';
 import Suggestions from "../Suggestions";
+const sampleData = [{
+  "id": 2,
+  "value": "text2",
+  "optionType": "default",
+  "listItemProps": {
+    "style": {
+      "color": "red"
+    }
+  }
+}, {
+  "id": 3,
+  "value": "text3",
+  "optionType": "default",
+  "listItemProps": {
+    "style": {
+      "color": "blue"
+    }
+  }
+}, {
+  "id": 4,
+  "value": "text4",
+  "optionType": "default"
+}, {
+  "id": 5,
+  "value": "text5",
+  "optionType": "default"
+}, {
+  "id": 6,
+  "value": "text6",
+  "optionType": "default"
+}, {
+  "id": 7,
+  "value": "text7",
+  "optionType": "default"
+}, {
+  "id": 8,
+  "value": "text8",
+  "optionType": "default"
+}, {
+  "id": 9,
+  "value": "text9",
+  "optionType": "default"
+}, {
+  "id": 10,
+  "value": "text10",
+  "optionType": "default"
+}];
 describe('Suggestions', () => {
   test('rendering the defult props', () => {
     const {
@@ -10,4 +57,15 @@ describe('Suggestions', () => {
     }));
     expect(asFragment()).toMatchSnapshot();
   });
+  test('rendering with limit props', () => {
+    const {
+      asFragment
+    } = render( /*#__PURE__*/React.createElement(Suggestions, {
+      selectedOptions: [1, 2, 3, 4],
+      suggestions: sampleData,
+      limit: 3,
+      limitReachedMessage: "Limit Reached"
+    }));
+    expect(asFragment()).toMatchSnapshot();
+  });
 });