@carto/meridian-ds 1.5.0-alpha.split → 1.5.1-alpha-virtual-autocomplete.9

package/dist/components/index.cjs

@@ -3,14 +3,15 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const jsxRuntime = require("react/jsx-runtime");
 const React = require("react");
 const material = require("@mui/material");
-const TablePaginationActions = require("../TablePaginationActions-CFGXm44W.cjs");
+const TablePaginationActions = require("../TablePaginationActions-mbbjzV6Y.cjs");
 const ArrowDown = require("../ArrowDown-8fLj23Ge.cjs");
 const OpenDiagonallyRight = require("../OpenDiagonallyRight-CM1tojUq.cjs");
 const reactIntl = require("react-intl");
 const iconsMaterial = require("@mui/icons-material");
-const Alert$1 = require("../Alert-BiOR9aar.cjs");
+const Alert$1 = require("../Alert-BzEgeyQJ.cjs");
 require("cartocolor");
-const MenuItem = require("../MenuItem-Br2jY2lt.cjs");
+const MenuItem = require("../MenuItem-C4bG5WHw.cjs");
+const reactWindow = require("react-window");
 const DatePicker$1 = require("@mui/x-date-pickers/DatePicker");
 const xDatePickers = require("@mui/x-date-pickers");
 const TimePicker$1 = require("@mui/x-date-pickers/TimePicker");
@@ -479,10 +480,10 @@ function ToggleButtonGroup({
 }
 const StyledMenu = material.styled(material.Menu, {
   shouldForwardProp: (prop) => !["extended", "width", "height"].includes(prop)
-})(({ theme, extended, width, height }) => ({
+})(({ extended, width, height }) => ({
   ...extended && {
     ".MuiMenuItem-root": {
-      minHeight: theme.spacing(6)
+      minHeight: TablePaginationActions.MENU_ITEM_SIZE_EXTENDED
     }
   },
   ...width && {
@@ -522,10 +523,10 @@ function _Menu({ extended, width, height, MenuListProps, ...otherProps }, ref) {
 const Menu$1 = React.forwardRef(_Menu);
 const StyledMenuList = material.styled(material.MenuList, {
   shouldForwardProp: (prop) => !["extended", "width", "height"].includes(prop)
-})(({ theme, extended, width, height }) => ({
+})(({ extended, width, height }) => ({
   ...extended && {
     ".MuiMenuItem-root": {
-      minHeight: theme.spacing(6)
+      minHeight: TablePaginationActions.MENU_ITEM_SIZE_EXTENDED
     }
   },
   "&.MuiList-root": {
@@ -556,7 +557,8 @@ function _MenuList({ extended, width, height, ...otherProps }, ref) {
 }
 const MenuList = React.forwardRef(_MenuList);
 const StyledMenuItem$1 = material.styled(MenuItem.MenuItem)(() => ({
-  marginTop: "0 !important"
+  marginTop: "0 !important",
+  marginBottom: "0 !important"
 }));
 const LinkFilter = material.styled(material.Link)(
   ({ disabled, theme }) => ({
@@ -796,12 +798,20 @@ function _MultipleSelectField({
       },
       children: [
         showFilters && /* @__PURE__ */ jsxRuntime.jsx(
-          MenuItemFilter,
+          material.Box,
           {
-            areAllSelected,
-            areAnySelected,
-            selectAll,
-            selectAllDisabled
+            sx: {
+              mb: 1
+            },
+            children: /* @__PURE__ */ jsxRuntime.jsx(
+              MenuItemFilter,
+              {
+                areAllSelected,
+                areAnySelected,
+                selectAll,
+                selectAllDisabled
+              }
+            )
           }
         ),
         options == null ? void 0 : options.map((option) => {
@@ -1108,11 +1118,123 @@ function UploadField({
     )
   ] });
 }
+const AUTOCOMPLETE_GROUP_HEADER_PROPERTY = "__isGroupHeader";
+function isAutocompleteListGroupHeader(option) {
+  return typeof option === "object" && option !== null && AUTOCOMPLETE_GROUP_HEADER_PROPERTY in option;
+}
+const getDefaultOptionLabel = (option) => {
+  return option && typeof option === "object" ? option.title ?? String(option) : String(option);
+};
+const createOptionWithMultiple = (option, multiple) => {
+  return typeof option !== "object" || option === null ? { value: option, multiple } : { ...option, multiple };
+};
+const getDefaultLimitTagsText = (more) => /* @__PURE__ */ jsxRuntime.jsxs("span", { "data-testid": "more-options-tag", children: [
+  "+",
+  more
+] });
+function createCounterRenderTags({
+  formatCounter,
+  options = [],
+  size = "small",
+  getOptionLabel = getDefaultOptionLabel
+}) {
+  const CounterRenderTags = (value) => {
+    if (value.length === 0) {
+      return null;
+    }
+    const selectedCount = value.length;
+    const selectableOptions = options.filter(
+      (option) => !isAutocompleteListGroupHeader(option)
+    );
+    const totalCount = selectableOptions.length;
+    const text = formatCounter({
+      selectedCount,
+      totalCount,
+      selectedItems: value,
+      allItems: selectableOptions,
+      getOptionLabel
+    });
+    return /* @__PURE__ */ jsxRuntime.jsx(
+      TablePaginationActions.Typography,
+      {
+        variant: size === "small" ? "body2" : "body1",
+        component: "span",
+        "data-testid": "counter-tag",
+        sx: {
+          ml: 1
+        },
+        children: text
+      }
+    );
+  };
+  return CounterRenderTags;
+}
+function createCounterFormatter({
+  counterText,
+  allText,
+  showSingleItemText = true
+}) {
+  return ({
+    selectedCount,
+    totalCount,
+    selectedItems,
+    getOptionLabel
+  }) => {
+    if (selectedCount === totalCount && totalCount > 0) {
+      return allText;
+    } else if (selectedCount === 1 && showSingleItemText) {
+      return getOptionLabel(selectedItems[0]);
+    } else {
+      return `${selectedCount} ${counterText}`;
+    }
+  };
+}
+function createAutocompleteGroupByList(options, groupBy, extended) {
+  const grouped = options.reduce(
+    (acc, option) => {
+      const group = groupBy(option);
+      if (!acc[group]) {
+        acc[group] = [];
+      }
+      acc[group].push(option);
+      return acc;
+    },
+    {}
+  );
+  const result = [];
+  Object.keys(grouped).forEach((title) => {
+    result.push({ [AUTOCOMPLETE_GROUP_HEADER_PROPERTY]: true, title, extended });
+    const groupOptions = grouped[title];
+    if (groupOptions) {
+      result.push(...groupOptions);
+    }
+  });
+  return result;
+}
+function warnDeprecatedGroupBy(componentName) {
+  if (process.env.NODE_ENV !== "production") {
+    console.error(
+      `${componentName}: The \`groupBy\` prop is deprecated and breaks virtualization. Use \`createAutocompleteGroupByList\` instead:
+
+\`\`\`
+import { createAutocompleteGroupByList, ${componentName} } from "@carto/meridian-ds/components"
+
+const groupedOptions = createAutocompleteGroupByList(options, (option) => option.category)
+
+<${componentName} options={groupedOptions} />
+\`\`\`
+`
+    );
+  }
+}
 function _Autocomplete({
   disabled,
   loading,
   ...props
 }, ref) {
+  if (props.groupBy) {
+    warnDeprecatedGroupBy("Autocomplete");
+  }
   return /* @__PURE__ */ jsxRuntime.jsx(
     material.Autocomplete,
     {
@@ -1129,15 +1251,24 @@ function _Autocomplete({
   );
 }
 const Autocomplete = React.forwardRef(_Autocomplete);
-const getDefaultOptionLabel = (option) => {
-  return option && typeof option === "object" ? option.title ?? String(option) : String(option);
-};
-const createOptionWithMultiple = (option, multiple) => {
-  return typeof option !== "object" || option === null ? { value: option, multiple } : { ...option, multiple };
-};
-const getDefaultLimitTagsText = (more) => /* @__PURE__ */ jsxRuntime.jsx("span", { "data-testid": "more-options-tag", children: `+${more}` });
 function useAutocompleteRenderOption() {
   const renderOption = (props, option, state, getOptionLabel, customIcon) => {
+    const { key, ...otherProps } = props;
+    if (isAutocompleteListGroupHeader(option)) {
+      return /* @__PURE__ */ React.createElement(
+        MenuItem.MenuItem,
+        {
+          ...otherProps,
+          subtitle: true,
+          extended: option.extended,
+          key,
+          "aria-disabled": true,
+          "aria-selected": false
+        },
+        option.title
+      );
+    }
+    const regularOption = option;
     const {
       title,
       inputValue,
@@ -1154,9 +1285,8 @@ function useAutocompleteRenderOption() {
       alternativeTitle,
       secondaryText,
       multiple
-    } = option;
-    const { key, ...otherProps } = props;
-    const isPrimitiveOptionType = typeof option === "string" || typeof option === "number";
+    } = regularOption;
+    const isPrimitiveOptionType = typeof regularOption === "string" || typeof regularOption === "number";
     const getOptionLabelText = (getOptionLabel2, option2, alternativeTitle2, title2) => {
       if (alternativeTitle2) return alternativeTitle2;
       if (title2) return title2;
@@ -1190,7 +1320,7 @@ function useAutocompleteRenderOption() {
             /* @__PURE__ */ jsxRuntime.jsxs(material.ListItemText, { children: [
               getOptionLabelText(
                 getOptionLabel ?? getDefaultOptionLabel,
-                option,
+                regularOption,
                 alternativeTitle,
                 title
               ),
@@ -1277,8 +1407,16 @@ function useMultipleAutocomplete({
   options,
   value,
   onChange,
-  getOptionLabel
+  getOptionLabel,
+  size,
+  counterFormatter,
+  counterText,
+  allSelectedText
 }) {
+  const intl = reactIntl.useIntl();
+  const intlConfig = TablePaginationActions.useImperativeIntl(intl);
+  const defaultCounterText = counterText || intlConfig.formatMessage({ id: "c4r.form.selected" });
+  const defaultAllSelectedText = allSelectedText || intlConfig.formatMessage({ id: "c4r.form.allSelected" });
   const [multipleValue, setMultipleValue] = React.useState(
     Array.isArray(value) ? value : value ? [value] : []
   );
@@ -1287,10 +1425,13 @@ function useMultipleAutocomplete({
     const newValue = Array.isArray(value) ? value : value ? [value] : [];
     setMultipleValue(newValue);
   }, [value]);
-  const allSelected = multipleValue.length === options.length;
-  const someSelected = multipleValue.length > 0 && multipleValue.length < options.length;
+  const selectableOptions = options.filter(
+    (option) => !isAutocompleteListGroupHeader(option)
+  );
+  const allSelected = multipleValue.length === selectableOptions.length;
+  const someSelected = multipleValue.length > 0 && multipleValue.length < selectableOptions.length;
   const handleSelectAll = (event) => {
-    const newValue = allSelected ? [] : [...options];
+    const newValue = allSelected ? [] : [...selectableOptions];
     setMultipleValue(newValue);
     onChange == null ? void 0 : onChange(
       event,
@@ -1312,31 +1453,173 @@ function useMultipleAutocomplete({
       getOptionLabel
     );
   };
+  const getCounterRenderTags = React.useCallback(() => {
+    const formatter = counterFormatter || createCounterFormatter({
+      counterText: defaultCounterText,
+      allText: defaultAllSelectedText
+    });
+    return createCounterRenderTags({
+      formatCounter: formatter,
+      options,
+      size,
+      getOptionLabel: getOptionLabel ? (option) => getOptionLabel(option) : void 0
+    });
+  }, [
+    options,
+    counterFormatter,
+    defaultCounterText,
+    defaultAllSelectedText,
+    size,
+    getOptionLabel
+  ]);
   return {
     multipleValue,
     allSelected,
     someSelected,
     handleSelectAll,
     handleChange,
-    multipleRenderOption
+    multipleRenderOption,
+    getCounterRenderTags
   };
 }
-function _ListboxWithFilter({
+const List = material.styled("ul")(
+  ({ theme, hasFilters }) => ({
+    ...!hasFilters && {
+      paddingTop: `${theme.spacing(1)} !important`
+    }
+  })
+);
+const ItemWrapper = material.styled("div")(({ style, theme, isSubtitle, isExtended, isMultiple }) => {
+  const getSubtitleStyles = () => {
+    const baseStyles = {
+      height: TablePaginationActions.MENU_ITEM_SIZE_DENSE,
+      minHeight: TablePaginationActions.MENU_ITEM_SIZE_DENSE,
+      marginTop: `${theme.spacing(1)} !important`,
+      alignItems: "flex-end",
+      ...theme.typography.caption,
+      fontWeight: 500
+    };
+    if (isExtended) {
+      baseStyles.alignItems = "center";
+      if (isMultiple) {
+        baseStyles.marginLeft = theme.spacing(0.5);
+      }
+    }
+    return baseStyles;
+  };
+  return {
+    pointerEvents: "none",
+    // To avoid the extra div to receive the click event
+    "& .MuiMenuItem-root": {
+      pointerEvents: "auto",
+      // Allow pointer events for the menu item
+      marginTop: 0,
+      "&:first-of-type": {
+        marginTop: "0 !important"
+      }
+    },
+    ...isSubtitle && {
+      "& .MuiAutocomplete-option.MuiMenuItem-root": getSubtitleStyles(),
+      // First item has no divider
+      "&:not(:first-of-type)": {
+        "&::before": {
+          content: '""',
+          position: "absolute",
+          zIndex: 1,
+          top: theme.spacing(0.5),
+          left: 0,
+          right: 0,
+          height: "1px",
+          backgroundColor: theme.palette.divider
+        }
+      }
+    },
+    ...!isSubtitle && {
+      "& .MuiAutocomplete-option": {
+        minHeight: `${style == null ? void 0 : style.height}px !important`
+      }
+    }
+  };
+});
+function _AutocompleteList({
   children,
   showFilters,
   allSelected,
   someSelected,
   handleSelectAll = () => void 0,
   multiple,
+  extended,
+  itemHeight,
+  maxListHeight = TablePaginationActions.MENU_LIST_MAX_SIZE,
   ...otherProps
 }, ref) {
+  const childrenArray = React.useMemo(() => {
+    return React.Children.toArray(children).map((child) => {
+      if (!React.isValidElement(child)) {
+        return {
+          child,
+          isSubtitle: false,
+          isExtended: false,
+          isMultiple: !!multiple
+        };
+      }
+      const props = child.props;
+      return {
+        child,
+        isSubtitle: props.subtitle === true,
+        isExtended: props.extended === true,
+        isMultiple: !!multiple
+      };
+    });
+  }, [children, multiple]);
+  const defaultItemHeight = itemHeight ?? (extended ? TablePaginationActions.MENU_ITEM_SIZE_EXTENDED : TablePaginationActions.MENU_ITEM_SIZE_DEFAULT);
+  const listboxHeight = React.useMemo(() => {
+    const filterHeight = showFilters && multiple ? TablePaginationActions.MENU_ITEM_SIZE_EXTENDED : 0;
+    const availableHeight = maxListHeight - filterHeight;
+    const calculatedHeight = Math.min(
+      childrenArray.length * defaultItemHeight,
+      availableHeight
+    );
+    return Math.max(calculatedHeight, defaultItemHeight);
+  }, [
+    showFilters,
+    multiple,
+    maxListHeight,
+    childrenArray.length,
+    defaultItemHeight
+  ]);
+  const renderItem = ({
+    index,
+    style
+  }) => {
+    const item = childrenArray[index];
+    if (!item) return null;
+    const { child, isSubtitle, isExtended, isMultiple } = item;
+    return /* @__PURE__ */ jsxRuntime.jsx(
+      ItemWrapper,
+      {
+        style,
+        isSubtitle,
+        isExtended,
+        isMultiple,
+        "data-name": "virtual-menu-item",
+        children: child
+      }
+    );
+  };
   return /* @__PURE__ */ jsxRuntime.jsxs(
-    "ul",
+    List,
     {
       ref,
       ...otherProps,
       role: "listbox",
+      "data-list-height": listboxHeight,
+      "data-item-height": defaultItemHeight,
       "aria-multiselectable": multiple,
+      hasFilters: showFilters,
+      style: {
+        maxHeight: maxListHeight + defaultItemHeight
+      },
       children: [
         showFilters && multiple && /* @__PURE__ */ jsxRuntime.jsx(
           MenuItemFilter,
@@ -1346,12 +1629,21 @@ function _ListboxWithFilter({
             selectAll: handleSelectAll
           }
         ),
-        children
+        /* @__PURE__ */ jsxRuntime.jsx(
+          reactWindow.FixedSizeList,
+          {
+            height: listboxHeight,
+            width: "100%",
+            itemCount: childrenArray.length,
+            itemSize: defaultItemHeight,
+            children: renderItem
+          }
+        )
       ]
     }
   );
 }
-const ListboxWithFilter = React.forwardRef(_ListboxWithFilter);
+const AutocompleteList = React.forwardRef(_AutocompleteList);
 function _CreatableAutocomplete({
   newItemLabel,
   newItemIcon,
@@ -1361,23 +1653,41 @@ function _CreatableAutocomplete({
   disabled,
   loading,
   showFilters,
+  showCounter = false,
+  counterFormatter,
+  counterText,
+  allSelectedText,
   options = [],
   value,
   onChange,
   getLimitTagsText,
+  renderTags,
+  itemHeight,
+  maxListHeight,
+  extended,
+  groupBy,
   ...props
 }, ref) {
+  if (groupBy) {
+    warnDeprecatedGroupBy("CreatableAutocomplete");
+  }
   const { freeSolo = true, ...otherProps } = props;
   const {
     multipleValue,
     allSelected,
     someSelected,
     handleSelectAll,
-    handleChange
+    handleChange,
+    getCounterRenderTags
   } = useMultipleAutocomplete({
     options,
     value,
-    onChange
+    onChange,
+    getOptionLabel,
+    size: props.size,
+    counterFormatter,
+    counterText,
+    allSelectedText
   });
   const {
     creatableFilterOptions,
@@ -1389,6 +1699,17 @@ function _CreatableAutocomplete({
     newItemIcon,
     multiple
   });
+  const listboxProps = {
+    showFilters,
+    allSelected,
+    someSelected,
+    handleSelectAll,
+    multiple,
+    itemHeight,
+    maxListHeight,
+    extended
+  };
+  const finalRenderTags = showCounter && multiple && !renderTags ? getCounterRenderTags() : renderTags;
   return /* @__PURE__ */ jsxRuntime.jsx(
     material.Autocomplete,
     {
@@ -1400,18 +1721,13 @@ function _CreatableAutocomplete({
       filterOptions: creatableFilterOptions,
       getOptionLabel: creatableOptionLabel,
       renderOption: creatableRenderOption,
+      renderTags: finalRenderTags,
       freeSolo,
       forcePopupIcon: true,
       multiple,
       disableCloseOnSelect: disableCloseOnSelect ?? multiple,
-      ListboxComponent: ListboxWithFilter,
-      ListboxProps: {
-        showFilters,
-        allSelected,
-        someSelected,
-        handleSelectAll,
-        multiple
-      },
+      ListboxComponent: AutocompleteList,
+      ListboxProps: listboxProps,
       getLimitTagsText: getLimitTagsText ?? getDefaultLimitTagsText,
       disabled: disabled || loading,
       popupIcon: loading ? /* @__PURE__ */ jsxRuntime.jsx(material.CircularProgress, { size: 18, color: "inherit" }) : /* @__PURE__ */ jsxRuntime.jsx(ArrowDown.ArrowDown, {}),
@@ -1426,26 +1742,54 @@ function _MultipleAutocomplete({
   disabled,
   loading,
   showFilters,
+  showCounter = false,
+  counterFormatter,
+  counterText,
+  allSelectedText,
   options,
   value,
   onChange,
   getOptionLabel,
   getLimitTagsText,
+  renderTags,
+  itemHeight,
+  maxListHeight,
+  extended,
+  groupBy,
   ...props
 }, ref) {
+  if (groupBy) {
+    warnDeprecatedGroupBy("MultipleAutocomplete");
+  }
   const {
     multipleValue,
     allSelected,
     someSelected,
     handleSelectAll,
     handleChange,
-    multipleRenderOption
+    multipleRenderOption,
+    getCounterRenderTags
   } = useMultipleAutocomplete({
     options,
     value,
     onChange,
-    getOptionLabel
+    getOptionLabel,
+    size: props.size,
+    counterFormatter,
+    counterText,
+    allSelectedText
   });
+  const listboxProps = {
+    showFilters,
+    allSelected,
+    someSelected,
+    handleSelectAll,
+    multiple: true,
+    itemHeight,
+    maxListHeight,
+    extended
+  };
+  const finalRenderTags = showCounter && !renderTags ? getCounterRenderTags() : renderTags;
   return /* @__PURE__ */ jsxRuntime.jsx(
     material.Autocomplete,
     {
@@ -1456,14 +1800,9 @@ function _MultipleAutocomplete({
       onChange: handleChange,
       getOptionLabel,
       renderOption: renderOption ?? multipleRenderOption,
-      ListboxComponent: ListboxWithFilter,
-      ListboxProps: {
-        showFilters,
-        allSelected,
-        someSelected,
-        handleSelectAll,
-        multiple: true
-      },
+      renderTags: finalRenderTags,
+      ListboxComponent: AutocompleteList,
+      ListboxProps: listboxProps,
       multiple: true,
       getLimitTagsText: getLimitTagsText ?? getDefaultLimitTagsText,
       disableCloseOnSelect,
@@ -1474,6 +1813,30 @@ function _MultipleAutocomplete({
   );
 }
 const MultipleAutocomplete = React.forwardRef(_MultipleAutocomplete);
+function useAutocomplete({
+  getOptionLabel = getDefaultOptionLabel
+}) {
+  const { renderOption: autocompleteRenderOption } = useAutocompleteRenderOption();
+  const internalGetOptionLabel = (option) => {
+    if (isAutocompleteListGroupHeader(option)) {
+      return option.title;
+    }
+    return getOptionLabel(option);
+  };
+  const singleRenderOption = (props, option, state) => {
+    const optionWithMultiple = createOptionWithMultiple(option, false);
+    return autocompleteRenderOption(
+      props,
+      optionWithMultiple,
+      state,
+      internalGetOptionLabel
+    );
+  };
+  return {
+    singleRenderOption,
+    getOptionLabel: internalGetOptionLabel
+  };
+}
 const _CopiableComponent = ({
   children,
   disabled,
@@ -4698,9 +5061,11 @@ exports.Typography = TablePaginationActions.Typography;
 exports.Alert = Alert$1.Alert;
 exports.IconButton = Alert$1.IconButton;
 exports.MenuItem = MenuItem.MenuItem;
+exports.AUTOCOMPLETE_GROUP_HEADER_PROPERTY = AUTOCOMPLETE_GROUP_HEADER_PROPERTY;
 exports.AccordionGroup = AccordionGroup;
 exports.AppBar = AppBar;
 exports.Autocomplete = Autocomplete;
+exports.AutocompleteList = AutocompleteList;
 exports.Avatar = Avatar;
 exports.Button = Button;
 exports.CodeAreaDialog = CodeAreaDialog;
@@ -4744,5 +5109,8 @@ exports.TooltipData = TooltipData;
 exports.UploadField = UploadField;
 exports.UploadFieldBase = UploadFieldBase;
 exports.copyString = copyString;
+exports.createAutocompleteGroupByList = createAutocompleteGroupByList;
 exports.dialogDimensionsBySize = dialogDimensionsBySize;
+exports.isAutocompleteListGroupHeader = isAutocompleteListGroupHeader;
+exports.useAutocomplete = useAutocomplete;
 exports.useCopyValue = useCopyValue;