@zohodesk/components 1.4.9 → 1.4.10-exp-0

package/README.md

@@ -2,6 +2,22 @@
 
 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.11
+
+- **Select, MultiSelect**
+  - `isVirtualizerEnabled` prop supported to manage bulk amount of options rendering
+
+- **Suggestions**
+  - **Virtualizer** adopted to manage bulk amount of options rendering with `isVirtualizerEnabled` prop support
+
+# 1.4.10
+
+- **Select, MultiSelect**
+  - Searching with leading spaces is not reflected the results correctly. Issue Fixed.
+
+- **Select**
+  - Fixed performance issue in options formatting caused by unnecessary rendering triggers
+
 # 1.4.9
 
 - **MultiSelect , MultiSelectWithAvatar, AdvancedMultiSelect, AdvancedGroupMultiSelect**

package/es/MultiSelect/MultiSelect.js

@@ -81,6 +81,7 @@ export class MultiSelectComponent extends React.Component {
     this.handleSearchOptions = debounce(this.handleSearchOptions.bind(this), searchDebounceTime);
     this.handleScroll = this.handleScroll.bind(this);
     this.handleScrollFuncCall = debounce(this.handleScrollFuncCall.bind(this), 500);
+    this.setSuggestionsVirtualizerContainerRefFunction = this.setSuggestionsVirtualizerContainerRefFunction.bind(this);
   }
 
   componentDidMount() {
@@ -798,6 +799,7 @@ export class MultiSelectComponent extends React.Component {
 
   suggestionContainerRef(el) {
     this.suggestionContainer = el;
+    typeof this.setSuggestionsVirtualizerRef === 'function' && this.setSuggestionsVirtualizerRef(el);
   }
 
   suggestionItemRef(el, index, id) {
@@ -862,6 +864,11 @@ export class MultiSelectComponent extends React.Component {
     });
   }
 
+  setSuggestionsVirtualizerContainerRefFunction(refFunc) {
+    this.setSuggestionsVirtualizerRef = refFunc;
+    this.suggestionContainer && refFunc(this.suggestionContainer);
+  }
+
   getSelectionUI() {
     let isResponsive = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     let {
@@ -1042,6 +1049,7 @@ export class MultiSelectComponent extends React.Component {
       isLoading,
       selectAllText,
       needSelectAll,
+      isVirtualizerEnabled,
       limit
     } = this.props;
     const {
@@ -1124,6 +1132,8 @@ export class MultiSelectComponent extends React.Component {
       className: style[palette]
     }, searchText) : suggestions.length ? /*#__PURE__*/React.createElement(Suggestions, {
       suggestions: suggestions,
+      isVirtualizerEnabled: isVirtualizerEnabled,
+      setVirtualizerContainerRefFunction: this.setSuggestionsVirtualizerContainerRefFunction,
       getRef: this.suggestionItemRef,
       hoverOption: hoverOption,
       onClick: this.handleSelectOption,

package/es/MultiSelect/Suggestions.js

@@ -1,140 +1,114 @@
 /**** Libraries ****/
-import React from 'react';
+import React, { useMemo } from 'react';
 import { Suggestions_propTypes } from "./props/propTypes";
 import { Suggestions_defaultProps } from "./props/defaultProps";
+import { Virtualizer } from '@zohodesk/virtualizer';
 /**** Components ****/
 
 import ListItem from "../ListItem/ListItem";
 import ListItemWithAvatar from "../ListItem/ListItemWithAvatar";
 import ListItemWithIcon from "../ListItem/ListItemWithIcon";
 import { Container, Box } from "../Layout";
+import { DUMMY_OBJECT, DUMMY_ARRAY } from "../utils/Common";
+
+function SuggestionsVirtualizerContainer(_ref) {
+  let {
+    eleRef,
+    children,
+    setVirtualizerContainerRefFunction
+  } = _ref;
+  useMemo(() => {
+    typeof setVirtualizerContainerRefFunction === 'function' && setVirtualizerContainerRefFunction(eleRef);
+  }, [eleRef, setVirtualizerContainerRefFunction]);
+  return /*#__PURE__*/React.createElement(React.Fragment, null, children);
+}
+
 export default class Suggestions extends React.PureComponent {
-  render() {
+  constructor(props) {
+    super(props);
+    this.renderSuggestionList = this.renderSuggestionList.bind(this);
+    this.renderVirtualizerSuggestionListItem = this.renderVirtualizerSuggestionListItem.bind(this);
+  }
+
+  renderSuggestionList(_ref2) {
+    let {
+      suggestion,
+      index,
+      ref
+    } = _ref2;
     const {
-      suggestions,
       getRef,
       hoverOption,
       onClick,
       onMouseEnter,
       needTick,
       needBorder,
-      selectedOptions = [],
+      selectedOptions = DUMMY_ARRAY,
       activeId,
       hoverId,
-      dataId,
       listItemSize,
-      className,
       avatarPalette,
       palette,
-      htmlId,
       a11y,
       needMultiLineText,
       limit,
       limitReachedMessage
     } = this.props;
     const {
-      ariaParentRole,
-      ariaMultiselectable
-    } = a11y;
+      id,
+      value,
+      secondaryValue,
+      photoURL,
+      icon,
+      optionType,
+      iconSize,
+      isDisabled,
+      listItemProps,
+      listItemCustomProps = DUMMY_OBJECT
+    } = suggestion;
+    const isActive = activeId === id || selectedOptions.indexOf(id) >= 0;
+    const isHighlight = hoverOption === index || id === hoverId ? true : false;
     const selectedOptionsLength = selectedOptions.length;
-    return /*#__PURE__*/React.createElement(Container, {
-      isCover: false,
-      role: ariaParentRole,
-      id: htmlId,
-      tabindex: "0",
-      "aria-multiselectable": ariaMultiselectable
-    }, /*#__PURE__*/React.createElement(Box, {
-      dataId: `${dataId}`,
-      className: className ? className : ''
-    }, suggestions.map((suggestion, index) => {
-      const {
-        id,
-        value,
-        secondaryValue,
-        photoURL,
-        icon,
-        optionType,
-        iconSize,
-        isDisabled,
-        listItemProps,
-        listItemCustomProps = {}
-      } = 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 : isLimitReached,
-        needMultiLineText,
-        ...listItemCustomProps
+    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 : isLimitReached,
+      needMultiLineText,
+      ...listItemCustomProps
+    };
+
+    if (listItemProps) {
+      commonProps.customProps = {
+        ListItemProps: { ...listItemProps
+        }
       };
+    }
 
-      if (listItemProps) {
-        commonProps.customProps = {
-          ListItemProps: { ...listItemProps
-          }
-        };
-      }
+    if (isLimitReached) {
+      commonProps.disableTitle = limitReachedMessage;
+    }
 
-      if (isLimitReached) {
-        commonProps.disableTitle = limitReachedMessage;
-      }
+    function getListItemRef(ele, index, id) {
+      ref && ref(ele);
 
-      if (optionType === 'avatar') {
-        return /*#__PURE__*/React.createElement(ListItemWithAvatar, { ...commonProps,
-          autoHover: false,
-          getRef: getRef,
-          highlight: isHighlight,
-          id: id,
-          imgSrc: photoURL,
-          key: `${id}avatarListItem`,
-          name: value,
-          onClick: onClick,
-          onMouseEnter: onMouseEnter,
-          value: value,
-          title: value,
-          needTick: needTick,
-          needBorder: needBorder,
-          active: isActive,
-          size: listItemSize,
-          avatarPalette: avatarPalette,
-          palette: palette,
-          a11y: list_a11y,
-          secondaryValue: secondaryValue
-        });
-      } else if (optionType === 'icon') {
-        return /*#__PURE__*/React.createElement(ListItemWithIcon, { ...commonProps,
-          autoHover: false,
-          getRef: getRef,
-          highlight: isHighlight,
-          id: id,
-          key: `${id}iconListItem`,
-          onClick: onClick,
-          onMouseEnter: onMouseEnter,
-          value: value,
-          title: value,
-          iconName: icon,
-          needTick: needTick,
-          needBorder: needBorder,
-          active: isActive,
-          iconSize: iconSize,
-          size: listItemSize,
-          palette: palette,
-          a11y: list_a11y,
-          secondaryValue: secondaryValue
-        });
+      if (typeof getRef === 'function') {
+        getRef(ele, index, id);
       }
+    }
 
-      return /*#__PURE__*/React.createElement(ListItem, { ...commonProps,
+    if (optionType === 'avatar') {
+      return /*#__PURE__*/React.createElement(ListItemWithAvatar, { ...commonProps,
         autoHover: false,
-        getRef: getRef,
+        getRef: getListItemRef,
         highlight: isHighlight,
         id: id,
-        key: `${id}listItem`,
+        imgSrc: photoURL,
+        key: `${id}avatarListItem`,
+        name: value,
         onClick: onClick,
         onMouseEnter: onMouseEnter,
         value: value,
@@ -143,8 +117,103 @@ export default class Suggestions extends React.PureComponent {
         needBorder: needBorder,
         active: isActive,
         size: listItemSize,
+        avatarPalette: avatarPalette,
         palette: palette,
-        a11y: list_a11y
+        a11y: list_a11y,
+        secondaryValue: secondaryValue
+      });
+    } else if (optionType === 'icon') {
+      return /*#__PURE__*/React.createElement(ListItemWithIcon, { ...commonProps,
+        autoHover: false,
+        getRef: getListItemRef,
+        highlight: isHighlight,
+        id: id,
+        key: `${id}iconListItem`,
+        onClick: onClick,
+        onMouseEnter: onMouseEnter,
+        value: value,
+        title: value,
+        iconName: icon,
+        needTick: needTick,
+        needBorder: needBorder,
+        active: isActive,
+        iconSize: iconSize,
+        size: listItemSize,
+        palette: palette,
+        a11y: list_a11y,
+        secondaryValue: secondaryValue
+      });
+    }
+
+    return /*#__PURE__*/React.createElement(ListItem, { ...commonProps,
+      autoHover: false,
+      getRef: getListItemRef,
+      highlight: isHighlight,
+      id: id,
+      key: `${id}listItem`,
+      onClick: onClick,
+      onMouseEnter: onMouseEnter,
+      value: value,
+      title: value,
+      needTick: needTick,
+      needBorder: needBorder,
+      active: isActive,
+      size: listItemSize,
+      palette: palette,
+      a11y: list_a11y
+    });
+  }
+
+  renderVirtualizerSuggestionListItem(_ref3) {
+    let {
+      index,
+      ref
+    } = _ref3;
+    const {
+      suggestions
+    } = this.props;
+    const suggestion = suggestions[index];
+    return this.renderSuggestionList({
+      suggestion,
+      index,
+      ref
+    });
+  }
+
+  render() {
+    const {
+      suggestions,
+      dataId,
+      className,
+      isVirtualizerEnabled,
+      htmlId,
+      a11y,
+      setVirtualizerContainerRefFunction
+    } = this.props;
+    const {
+      ariaParentRole,
+      ariaMultiselectable
+    } = a11y;
+    return /*#__PURE__*/React.createElement(Container, {
+      isCover: false,
+      role: ariaParentRole,
+      id: htmlId,
+      tabindex: "0",
+      "aria-multiselectable": ariaMultiselectable
+    }, /*#__PURE__*/React.createElement(Box, {
+      dataId: `${dataId}`,
+      className: className ? className : ''
+    }, isVirtualizerEnabled ? /*#__PURE__*/React.createElement(Virtualizer, {
+      containerType: SuggestionsVirtualizerContainer,
+      elementRenderer: this.renderVirtualizerSuggestionListItem,
+      elementsCount: suggestions.length,
+      isElementsFixedHeight: false,
+      dataId: `${dataId}_virtualizer`,
+      setVirtualizerContainerRefFunction: setVirtualizerContainerRefFunction
+    }) : suggestions.map((suggestion, index) => {
+      return this.renderSuggestionList({
+        suggestion,
+        index
       });
     })));
   }

package/es/MultiSelect/props/defaultProps.js

@@ -86,6 +86,7 @@ export const MultiSelect_defaultProps = {
   autoComplete: getLibraryConfig('autoComplete'),
   dataId: 'multiSelect',
   dropBoxSize: 'small',
+  isVirtualizerEnabled: false,
   isAnimate: true,
   isDisabled: false,
   isPopupOpenOnEnter: false,
@@ -167,5 +168,6 @@ export const SelectedOptions_defaultProps = {
 };
 export const Suggestions_defaultProps = {
   a11y: {},
+  isVirtualizerEnabled: false,
   needMultiLineText: false
 };

package/es/MultiSelect/props/propTypes.js

@@ -31,6 +31,7 @@ export const MultiSelect_propTypes = {
   disableAction: PropTypes.bool,
   dropBoxSize: PropTypes.oneOf(['small', 'medium', 'large']),
   emptyMessage: PropTypes.string.isRequired,
+  isVirtualizerEnabled: PropTypes.bool,
   getContainerRef: PropTypes.func,
   getNextOptions: PropTypes.func,
   getPublicMethods: PropTypes.func,
@@ -168,6 +169,8 @@ export const Suggestions_propTypes = {
   avatarPalette: PropTypes.string,
   className: PropTypes.string,
   dataId: PropTypes.string,
+  isVirtualizerEnabled: PropTypes.bool,
+  setVirtualizerContainerRefFunction: PropTypes.func,
   getRef: PropTypes.func,
   hoverId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
   hoverOption: PropTypes.number,

package/es/Select/Select.js

@@ -18,7 +18,7 @@ import { ResponsiveReceiver } from "../Responsive/CustomResponsive";
 import Loader from '@zohodesk/svg/lib/Loader/Loader';
 /**** Methods ****/
 
-import { makeFormatOptions, makeGetMultiSelectFilterSuggestions as makeGetFilterSuggestions, makeGetSelectedValueText as makeGetSelectedValue } from "../utils/dropDownUtils";
+import { dummyObj, makeFormatOptions, makeGetMultiSelectFilterSuggestions as makeGetFilterSuggestions, makeGetSelectedValueText as makeGetSelectedValue } from "../utils/dropDownUtils";
 import { debounce, scrollTo, getIsEmptyValue, getSearchString, findScrollEnd, getKeyValue } from "../utils/Common.js";
 /**** CSS ****/
 
@@ -106,6 +106,7 @@ export class SelectComponent extends Component {
     this.handleAddNewOption = this.handleAddNewOption.bind(this);
     this.handleExposePopupHandlers = this.handleExposePopupHandlers.bind(this);
     this.handleGetAddNewOptionText = this.handleGetAddNewOptionText.bind(this);
+    this.setSuggestionsVirtualizerContainerRefFunction = this.setSuggestionsVirtualizerContainerRefFunction.bind(this);
     this.valueInputTypeString = '';
     this.valueInputSearchString = '';
     this.autoSelectSuggestions = [];
@@ -251,10 +252,10 @@ export class SelectComponent extends Component {
       valueField,
       textField,
       allowValueFallback,
-      customProps = {}
+      customProps = dummyObj
     } = props;
     let {
-      listItemProps = {}
+      listItemProps = dummyObj
     } = customProps;
     return this.formatOptions({
       options,
@@ -529,6 +530,7 @@ export class SelectComponent extends Component {
 
   suggestionContainerRef(el) {
     this.suggestionContainer = el;
+    typeof this.setSuggestionsVirtualizerRef === 'function' && this.setSuggestionsVirtualizerRef(el);
   }
 
   suggestionItemRef(el, index, id) {
@@ -676,6 +678,11 @@ export class SelectComponent extends Component {
     });
   }
 
+  setSuggestionsVirtualizerContainerRefFunction(refFunc) {
+    this.setSuggestionsVirtualizerRef = refFunc;
+    this.suggestionContainer && refFunc(this.suggestionContainer);
+  }
+
   render() {
     let {
       needSearch,
@@ -728,6 +735,7 @@ export class SelectComponent extends Component {
       targetOffset,
       isRestrictScroll,
       dropBoxPortalId,
+      isVirtualizerEnabled,
       renderCustomToggleIndicator,
       renderCustomSearchClearComponent
     } = this.props;
@@ -932,6 +940,8 @@ export class SelectComponent extends Component {
         eleRef: this.suggestionContainerRef
       }, suggestions.length ? /*#__PURE__*/React.createElement(Suggestions, {
         activeId: selectedId,
+        isVirtualizerEnabled: isVirtualizerEnabled,
+        setVirtualizerContainerRefFunction: this.setSuggestionsVirtualizerContainerRefFunction,
         suggestions: suggestions,
         getRef: this.suggestionItemRef,
         hoverOption: hoverIndex,

package/es/Select/SelectWithIcon.js

@@ -193,7 +193,7 @@ class SelectWithIcon extends Component {
     } = this.props;
 
     if (options.length) {
-      datas = options.filter(obj => obj[valueKey].toLowerCase().includes(searchValue.toLowerCase()));
+      datas = options.filter(obj => obj[valueKey].toLowerCase().includes(searchValue.toLowerCase().trim()));
     }
 
     return datas;

package/es/Select/__tests__/Select.spec.js

@@ -246,14 +246,22 @@ describe('Select -', () => {
     userEvent.type(within(getByTestId(dropboxTestId)).getByRole('textbox'), '2');
     expect(getAllByRole(listItemRole)).toHaveLength(1);
     expect(asFragment()).toMatchSnapshot();
-  }); // test('Should render the only options matching search value even with additional spaces before and after', () => {
-  //   const { getByRole, getAllByRole, asFragment, getByTestId } = render(<Select needSearch options={options} />);
-  //   userEvent.click(getByRole(selectInputRole));
-  //   userEvent.type(within(getByTestId(dropboxTestId)).getByRole('textbox'), '  2  ');
-  //   expect(getAllByRole(listItemRole)).toHaveLength(1);
-  //   expect(asFragment()).toMatchSnapshot();
-  // });
-
+  });
+  test('Should render the only options matching search value even with additional spaces before and after', () => {
+    const {
+      getByRole,
+      getAllByRole,
+      asFragment,
+      getByTestId
+    } = render( /*#__PURE__*/React.createElement(Select, {
+      needSearch: true,
+      options: options
+    }));
+    userEvent.click(getByRole(selectInputRole));
+    userEvent.type(within(getByTestId(dropboxTestId)).getByRole('textbox'), '  2  ');
+    expect(getAllByRole(listItemRole)).toHaveLength(1);
+    expect(asFragment()).toMatchSnapshot();
+  });
   test('Should trigger given onSearch, when type on the search input', async () => {
     const mockOnSearch = jest.fn();
     const {