@shopgate/engage 7.32.0-beta.2 → 7.32.0-beta.20

package/filter/components/FilterPageContent/components/Selector/components/ValueCheckbox/index.js

@@ -0,0 +1,77 @@
+import { memo, useCallback } from 'react';
+import noop from 'lodash/noop';
+import { Checkbox } from '@shopgate/engage/components';
+import { i18n } from '@shopgate/engage/core/helpers';
+import { makeStyles } from '@shopgate/engage/styles';
+
+/**
+ * `Checkbox` is untyped JavaScript whose optional props read as required from TypeScript.
+ */
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const CheckboxField = Checkbox;
+const useStyles = makeStyles()(theme => ({
+  root: {
+    paddingBottom: 0,
+    marginLeft: 0
+  },
+  checkbox: {
+    display: 'flex',
+    alignItems: 'flex-start',
+    padding: theme.spacing(0.75, 0),
+    '& .checkedIcon': {
+      color: theme.palette.secondary.main
+    }
+  },
+  label: {
+    width: '100%',
+    display: 'flex',
+    justifyContent: 'space-between',
+    gap: theme.spacing(1),
+    paddingLeft: theme.spacing(1),
+    [theme.breakpoints.up('md')]: {
+      width: 'max-content',
+      maxWidth: '100%'
+    }
+  }
+}));
+/**
+ * A single selectable value of a filter on the filter page.
+ * @returns The rendered component.
+ */
+const ValueCheckbox = ({
+  id,
+  label,
+  hits,
+  isActive = false,
+  onToggle = noop
+}) => {
+  const {
+    classes
+  } = useStyles();
+  const handleChange = useCallback(() => {
+    onToggle(id);
+  }, [id, onToggle]);
+  return /*#__PURE__*/_jsx("div", {
+    "data-test-id": id,
+    children: /*#__PURE__*/_jsx(CheckboxField, {
+      className: classes.root,
+      checkboxClassName: classes.checkbox,
+      name: id,
+      checked: isActive,
+      onChange: handleChange,
+      label: /*#__PURE__*/_jsxs("div", {
+        className: classes.label,
+        "aria-label": hits === undefined ? label : i18n.text('filter.hits', {
+          label,
+          count: hits
+        }),
+        children: [/*#__PURE__*/_jsx("span", {
+          children: label
+        }), hits !== undefined && /*#__PURE__*/_jsx("span", {
+          children: `(${hits})`
+        })]
+      })
+    })
+  });
+};
+export default /*#__PURE__*/memo(ValueCheckbox);

package/filter/components/FilterPageContent/components/Selector/index.d.ts

@@ -0,0 +1,43 @@
+export interface FilterValue {
+    /**
+     * Id of the filter value.
+     */
+    id: string;
+    /**
+     * Display label of the filter value.
+     */
+    label: string;
+    /**
+     * Number of products available for the filter value.
+     */
+    hits?: number;
+}
+export interface SelectorProps {
+    /**
+     * Id of the filter.
+     */
+    id: string;
+    /**
+     * Display label of the filter.
+     */
+    label: string;
+    /**
+     * The selectable values of the filter.
+     */
+    values: FilterValue[];
+    /**
+     * Whether multiple values can be selected at once.
+     */
+    multi?: boolean;
+    /**
+     * Invoked with the filter id and the updated selection whenever a value is toggled.
+     */
+    onChange?: (id: string, selected: string[]) => void;
+    /**
+     * The currently selected value ids.
+     */
+    selected?: string[] | null;
+}
+declare const _default: import("react").MemoExoticComponent<({ id, label, values, multi, onChange, selected: selectedFromProps, }: SelectorProps) => import("react").JSX.Element>;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/filter/components/FilterPageContent/components/Selector/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../filter/components/FilterPageContent/components/Selector/index.tsx"],"names":[],"mappings":"AA4CA,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IACpD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC5B;mIAaE,aAAa;AAwFhB,wBAA8B"}

package/filter/components/FilterPageContent/components/Selector/index.js

@@ -1,37 +1,54 @@
 import "core-js/modules/es.array.includes.js";
-import React, { useState, useEffect, useCallback, memo } from 'react';
-import PropTypes from 'prop-types';
+import { useState, useEffect, useCallback, useMemo, memo } from 'react';
+import noop from 'lodash/noop';
 import { Accordion, SurroundPortals } from '@shopgate/engage/components';
 import { i18n } from '@shopgate/engage/core/helpers';
 import { makeStyles } from '@shopgate/engage/styles';
 import { FilterItem } from '@shopgate/engage/filter';
 import { PORTAL_FILTER_SELECTOR } from '@shopgate/engage/filter/constants';
-import ValueButton from "./components/ValueButton";
+import ValueCheckbox from "./components/ValueCheckbox";
 import Toggle from "./components/Toggle";
 import Selected from "./components/Selected";
 import { jsx as _jsx } from "react/jsx-runtime";
-const useStyles = makeStyles()(() => ({
+const useStyles = makeStyles()(theme => ({
   accordion: {
     overflow: 'hidden'
   },
+  chevron: {
+    alignSelf: 'flex-start'
+  },
   content: {
-    marginLeft: -8,
-    marginBottom: -8
+    paddingBottom: theme.spacing(1),
+    display: 'flex',
+    flexDirection: 'column'
   }
 }));
 
 /**
- * The selector component.
- * @param {Object} props Props.
- * @returns {JSX.Element}
+ * Formats selected filter value labels into a readable enumeration.
+ * @param labels Labels of the selected values.
+ * @returns The formatted enumeration.
+ */
+const formatSelectedLabels = labels => {
+  const {
+    ListFormat
+  } = Intl;
+  if (typeof ListFormat !== 'function') {
+    return labels.join(', ');
+  }
+  return new ListFormat(i18n.getLang()).format(labels);
+};
+/**
+ * The selector component renders a single filter as an accordion with selectable values.
+ * @returns The rendered component.
  */
 const Selector = ({
   id,
   label,
   values,
-  multi,
-  onChange,
-  selected: selectedFromProps
+  multi = false,
+  onChange = noop,
+  selected: selectedFromProps = null
 }) => {
   const {
     classes
@@ -40,10 +57,7 @@ const Selector = ({
   useEffect(() => {
     setSelected(selectedFromProps || []);
   }, [selectedFromProps]);
-  const handleClick = useCallback(event => {
-    const {
-      value
-    } = event.target;
+  const handleToggle = useCallback(value => {
     setSelected(prev => {
       let newSelected = [].concat(prev, [value]);
       if (!multi && prev.length === 1) {
@@ -56,21 +70,24 @@ const Selector = ({
       return newSelected;
     });
   }, [id, multi, onChange]);
-  const handlePortalChange = useCallback(updatedId => {
-    handleClick({
-      target: {
-        value: updatedId
-      }
-    });
-  }, [handleClick]);
-  const renderLabel = useCallback(props => /*#__PURE__*/_jsx(Toggle, {
-    ...props,
+  const selectedValues = useMemo(() => values.filter(value => selected.includes(value.id)), [selected, values]);
+  const renderLabel = useCallback(() => /*#__PURE__*/_jsx(Toggle, {
     label: label,
     selected: /*#__PURE__*/_jsx(Selected, {
-      values: values,
-      selected: selected
+      values: selectedValues
     })
-  }), [label, selected, values]);
+  }), [label, selectedValues]);
+  const handleLabel = useMemo(() => {
+    if (selectedValues.length === 0) {
+      return i18n.text('filter.filter_by', {
+        label
+      });
+    }
+    return i18n.text('filter.filter_by_with_selected', {
+      label,
+      selected: formatSelectedLabels(selectedValues.map(value => value.label))
+    });
+  }, [label, selectedValues]);
   return /*#__PURE__*/_jsx(SurroundPortals, {
     portalName: PORTAL_FILTER_SELECTOR,
     portalProps: {
@@ -81,32 +98,27 @@ const Selector = ({
         isMultiSelect: multi
       },
       selectedValueIds: selected,
-      onChange: handlePortalChange
+      onChange: handleToggle
     },
     children: /*#__PURE__*/_jsx(FilterItem, {
       children: /*#__PURE__*/_jsx(Accordion, {
         renderLabel: renderLabel,
         testId: id,
-        handleLabel: i18n.text('filter.filter_by', {
-          label
-        }),
+        handleLabel: handleLabel,
         className: classes.accordion,
+        chevronClassName: classes.chevron,
         children: /*#__PURE__*/_jsx("div", {
           className: classes.content,
-          children: values.map(value => /*#__PURE__*/_jsx(ValueButton, {
+          children: values.map(value => /*#__PURE__*/_jsx(ValueCheckbox, {
             id: value.id,
             label: value.label,
-            isActive: selected && selected.includes(value.id),
-            onClick: handleClick
+            hits: value.hits,
+            isActive: selected.includes(value.id),
+            onToggle: handleToggle
           }, value.id))
         })
       })
     })
   });
 };
-Selector.defaultProps = {
-  multi: false,
-  onChange() {},
-  selected: null
-};
 export default /*#__PURE__*/memo(Selector);

package/filter/components/FilterPageContent/index.d.ts

@@ -0,0 +1,16 @@
+import type { ComponentType } from 'react';
+export interface FilterPageContentProps {
+    /**
+     * The component to be rendered as the app bar.
+     */
+    AppBarComponent?: ComponentType<{
+        title?: string;
+    }> | null;
+}
+/**
+ * The FilterPageContent component renders all filters for the filter page.
+ * @returns The rendered component.
+ */
+declare const FilterPageContent: ({ AppBarComponent }: FilterPageContentProps) => import("react").JSX.Element;
+export default FilterPageContent;
+//# sourceMappingURL=index.d.ts.map

package/filter/components/FilterPageContent/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../filter/components/FilterPageContent/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAyB3C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;CAC5D;AAED;;;GAGG;AACH,QAAA,MAAM,iBAAiB,GAAI,qBAA4B,sBAAsB,gCAmD5E,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/filter/components/FilterPageContent/index.js

@@ -1,78 +1,72 @@
-import React, { Fragment } from 'react';
-import PropTypes from 'prop-types';
-import { SurroundPortals, ResponsiveContainer } from '@shopgate/engage/components';
+import { Fragment } from 'react';
+import { SurroundPortals } from '@shopgate/engage/components';
 import { useFilterPage } from '@shopgate/engage/filter/hooks';
+import { makeStyles } from '@shopgate/engage/styles';
 import { PORTAL_FILTER_PRICE_RANGE, PORTAL_FILTER_PAGE_CONTENT, FILTER_TYPE_RANGE, FILTER_TYPE_MULTISELECT, PriceSlider } from '@shopgate/engage/filter';
 import Selector from "./components/Selector";
-import ApplyButton from "./components/ApplyButton";
-import ResetButton from "./components/ResetButton";
-
+import FilterButtonBar from "./components/FilterButtonBar";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const useStyles = makeStyles()(theme => ({
+  content: {
+    color: theme.palette.text.primary,
+    [theme.breakpoints.up('md')]: {
+      width: '100%',
+      maxWidth: 640,
+      margin: '0 auto'
+    }
+  }
+}));
 /**
  * The FilterPageContent component renders all filters for the filter page.
- * @param {Object} props The component props.
- * @param {React.ComponentType} props.AppBarComponent The component to be rendered as the app bar
- * @returns {JSX.Element}
+ * @returns The rendered component.
  */
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const FilterPageContent = ({
-  AppBarComponent
+  AppBarComponent = null
 }) => {
+  const {
+    classes
+  } = useStyles();
   const {
     apiFilters,
-    resetPossible,
-    hasChanged,
-    applyFilters,
-    resetAllFilters,
     getSelectedFilterValues,
     updateSelectedFilterValues
   } = useFilterPage();
   return /*#__PURE__*/_jsxs(SurroundPortals, {
     portalName: PORTAL_FILTER_PAGE_CONTENT,
     children: [AppBarComponent && /*#__PURE__*/_jsx(AppBarComponent, {
-      title: "titles.filter",
-      right: /*#__PURE__*/_jsx(ApplyButton, {
-        disabled: !hasChanged,
-        onClick: applyFilters
-      })
-    }), apiFilters.map(filter => {
-      const portalProps = {
-        filter
-      };
-      const value = getSelectedFilterValues(filter.id);
-      if (filter.type === FILTER_TYPE_RANGE) {
-        return /*#__PURE__*/_jsx(Fragment, {
-          children: /*#__PURE__*/_jsx(SurroundPortals, {
-            portalName: PORTAL_FILTER_PRICE_RANGE,
-            portalProps: portalProps,
-            children: /*#__PURE__*/_jsx(PriceSlider, {
-              id: filter.id,
-              min: filter.minimum,
-              max: filter.maximum,
-              onChange: updateSelectedFilterValues,
-              value: value
-            }, filter.id)
-          })
+      title: "titles.filter"
+    }), /*#__PURE__*/_jsx("div", {
+      className: classes.content,
+      children: apiFilters.map(filter => {
+        const portalProps = {
+          filter
+        };
+        const value = getSelectedFilterValues(filter.id);
+        if (filter.type === FILTER_TYPE_RANGE) {
+          return /*#__PURE__*/_jsx(Fragment, {
+            children: /*#__PURE__*/_jsx(SurroundPortals, {
+              portalName: PORTAL_FILTER_PRICE_RANGE,
+              portalProps: portalProps,
+              children: /*#__PURE__*/_jsx(PriceSlider, {
+                id: filter.id,
+                min: filter.minimum,
+                max: filter.maximum,
+                onChange: updateSelectedFilterValues,
+                value: value
+              }, filter.id)
+            })
+          }, filter.id);
+        }
+        return /*#__PURE__*/_jsx(Selector, {
+          id: filter.id,
+          label: filter.label,
+          values: filter.values,
+          multi: filter.type === FILTER_TYPE_MULTISELECT,
+          onChange: updateSelectedFilterValues,
+          selected: value
         }, filter.id);
-      }
-      return /*#__PURE__*/_jsx(Selector, {
-        id: filter.id,
-        label: filter.label,
-        values: filter.values,
-        multi: filter.type === FILTER_TYPE_MULTISELECT,
-        onChange: updateSelectedFilterValues,
-        selected: value
-      }, filter.id);
-    }), /*#__PURE__*/_jsx(ResponsiveContainer, {
-      breakpoint: "<sm",
-      appAlways: true,
-      children: /*#__PURE__*/_jsx(ResetButton, {
-        disabled: !resetPossible,
-        onClick: resetAllFilters
       })
-    })]
+    }), /*#__PURE__*/_jsx(FilterButtonBar, {})]
   });
 };
-FilterPageContent.defaultProps = {
-  AppBarComponent: null
-};
 export default FilterPageContent;