@shopgate/engage 7.32.0-beta.13 → 7.32.0-beta.15

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

@@ -1,55 +1,33 @@
-import React, { memo } from 'react';
-import PropTypes from 'prop-types';
+import { memo } from 'react';
 import { I18n, SurroundPortals } from '@shopgate/engage/components';
 import { Button } from '@shopgate/engage/components/v2';
-import { makeStyles } from '@shopgate/engage/styles';
 import { PORTAL_FILTER_RESET_BUTTON } from '@shopgate/engage/filter/constants';
 import { jsx as _jsx } from "react/jsx-runtime";
-const useStyles = makeStyles()(theme => ({
-  buttonContainer: {
-    marginTop: theme.spacing(0.5),
-    marginRight: theme.spacing(2),
-    marginBottom: 40,
-    textAlign: 'right'
-  }
-}));
-
 /**
- * The filter reset button component.
- * @param {Object} props The component props.
- * @param {boolean} props.disabled Whether the button is disabled
- * @param {Function} props.onClick Click handler for the button
- * @returns {JSX.Element}
+ * The filter reset button, rendered as "Clear all" in the filter button bar.
+ * @returns The rendered component.
  */
 const FilterResetButton = ({
-  disabled,
-  onClick
-}) => {
-  const {
-    classes
-  } = useStyles();
-  return /*#__PURE__*/_jsx(SurroundPortals, {
-    portalName: PORTAL_FILTER_RESET_BUTTON,
-    portalProps: {
-      disabled,
-      onClick
-    },
-    children: /*#__PURE__*/_jsx("div", {
-      className: classes.buttonContainer,
-      children: /*#__PURE__*/_jsx(Button, {
-        variant: "link",
-        color: "secondary",
-        onClick: onClick,
-        disabled: disabled,
-        testId: "clearAllButton",
-        children: /*#__PURE__*/_jsx(I18n.Text, {
-          string: "filter.reset"
-        })
-      })
+  disabled = false,
+  onClick,
+  className
+}) => /*#__PURE__*/_jsx(SurroundPortals, {
+  portalName: PORTAL_FILTER_RESET_BUTTON,
+  portalProps: {
+    disabled,
+    onClick
+  },
+  children: /*#__PURE__*/_jsx(Button, {
+    className: className,
+    variant: "outlined",
+    onClick: onClick,
+    disabled: disabled,
+    fullWidth: true,
+    size: "small",
+    testId: "clearAllButton",
+    children: /*#__PURE__*/_jsx(I18n.Text, {
+      string: "filter.clear_all"
     })
-  });
-};
-FilterResetButton.defaultProps = {
-  disabled: false
-};
+  })
+});
 export default /*#__PURE__*/memo(FilterResetButton);

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

@@ -0,0 +1,19 @@
+export interface SelectedValue {
+    /**
+     * Id of the filter value.
+     */
+    id: string;
+    /**
+     * Display label of the filter value.
+     */
+    label: string;
+}
+export interface SelectedProps {
+    /**
+     * The selected filter values, already ordered for display.
+     */
+    values: SelectedValue[];
+}
+declare const _default: import("react").MemoExoticComponent<({ values }: SelectedProps) => import("react").JSX.Element | null>;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../filter/components/FilterPageContent/components/Selector/components/Selected/index.tsx"],"names":[],"mappings":"AAkBA,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,aAAa,EAAE,CAAC;CACzB;yEAM6B,aAAa;AAgB3C,wBAA8B"}

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

@@ -1,63 +1,42 @@
-import "core-js/modules/es.array.includes.js";
-import "core-js/modules/es.array.reduce.js";
-import React, { Fragment, memo, useMemo } from 'react';
-import PropTypes from 'prop-types';
+import { memo } from 'react';
 import { makeStyles } from '@shopgate/engage/styles';
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-const useStyles = makeStyles()(() => ({
-  elipsed: {
-    maxWidth: '95%',
-    overflow: 'hidden',
-    textAlign: 'right',
-    textOverflow: 'ellipsis',
-    whiteSpace: 'nowrap'
+import { jsx as _jsx } from "react/jsx-runtime";
+const useStyles = makeStyles()(theme => ({
+  chips: {
+    display: 'flex',
+    flexWrap: 'wrap',
+    gap: theme.spacing(0.5)
   },
-  comma: {
-    ' + span': {
-      marginLeft: '0.65ch'
-    }
+  chip: {
+    ...theme.typography.body2,
+    padding: theme.spacing(0.25, 1.25),
+    borderRadius: theme.shape.borderRadius,
+    border: `1px solid ${theme.palette.secondary.main}`,
+    overflowWrap: 'anywhere'
   }
 }));
-
 /**
- * The filter selected component.
- * @param {Object} props Props.
- * @returns {JSX.Element|null}
+ * Renders the selected filter values as chips in the accordion header.
+ * @returns The rendered component.
  */
 const Selected = ({
-  selected,
   values
 }) => {
   const {
     classes
   } = useStyles();
-  const items = useMemo(() => {
-    if (!selected || selected.length === 0) {
-      return [];
-    }
-    return values.reduce((prevValues, value) => {
-      if (selected.includes(value.id)) {
-        prevValues.push(value.label);
-      }
-      return prevValues;
-    }, []);
-  }, [selected, values]);
-  if (!selected || selected.length === 0) {
+  if (values.length === 0) {
     return null;
   }
-  return /*#__PURE__*/_jsx(_Fragment, {
-    children: items.map((item, index) => /*#__PURE__*/_jsxs(Fragment, {
-      children: [/*#__PURE__*/_jsx("span", {
-        className: classes.elipsed,
-        children: item
-      }), index < items.length - 1 ? /*#__PURE__*/_jsx("span", {
-        className: classes.comma,
-        children: ", "
-      }) : '']
-    }, item))
+  return /*#__PURE__*/_jsx("div", {
+    className: classes.chips,
+    children: values.map(({
+      id,
+      label
+    }) => /*#__PURE__*/_jsx("span", {
+      className: classes.chip,
+      children: label
+    }, id))
   });
 };
-Selected.defaultProps = {
-  selected: null
-};
 export default /*#__PURE__*/memo(Selected);

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

@@ -0,0 +1,14 @@
+import type { ReactNode } from 'react';
+export interface ToggleProps {
+    /**
+     * The filter label.
+     */
+    label: ReactNode;
+    /**
+     * The selected values element rendered below the label.
+     */
+    selected?: ReactNode;
+}
+declare const _default: import("react").MemoExoticComponent<({ label, selected }: ToggleProps) => import("react").JSX.Element>;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../filter/components/FilterPageContent/components/Selector/components/Toggle/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAkBvC,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;kFAM2C,WAAW;AAavD,wBAA4B"}

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

@@ -1,71 +1,38 @@
-import React, { memo, useMemo } from 'react';
-import PropTypes from 'prop-types';
+import { memo } from 'react';
 import { makeStyles } from '@shopgate/engage/styles';
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const useStyles = makeStyles()(theme => ({
   toggle: {
     display: 'flex',
-    flexFlow: 'row no-wrap',
-    alignContent: 'stretch',
-    alignItems: 'flex-start'
+    flexDirection: 'column',
+    alignItems: 'flex-start',
+    gap: theme.spacing(1),
+    flex: 1,
+    minWidth: 0
   },
   label: {
-    whiteSpace: 'no-wrap',
-    flexShrink: 0,
-    flexGrow: 1,
-    textAlign: 'left',
-    maxWidth: '50%',
-    minWidth: '35%',
-    paddingRight: '16px'
-  },
-  selected: {
-    display: 'flex',
-    flexFlow: 'row wrap',
-    flexGrow: 1,
-    justifyContent: 'flex-end',
-    minWidth: '50%',
-    maxWidth: '65%'
-  },
-  closed: {
-    fontWeight: theme.typography.fontWeightRegular
-  },
-  open: {
-    fontWeight: theme.typography.fontWeightBold
+    ...theme.typography.body1,
+    textAlign: 'left'
   }
 }));
-
 /**
- * The toggle component.
- * @param {Object} props Props.
- * @returns {JSX.Element}
+ * Renders the filter label and its selected values in the accordion header.
+ * @returns The rendered component.
  */
 const Toggle = ({
   label,
-  open,
-  selected
+  selected = null
 }) => {
   const {
     classes,
     cx
   } = useStyles();
-  const labelClassName = useMemo(() => cx({
-    [classes.label]: true,
-    [classes.open]: open,
-    [classes.closed]: !open
-  }), [classes.closed, classes.label, classes.open, open, cx]);
   return /*#__PURE__*/_jsxs("div", {
     className: classes.toggle,
     children: [/*#__PURE__*/_jsx("span", {
-      className: labelClassName,
+      className: cx(classes.label, 'filter-selector-toggle-label'),
       children: label
-    }), selected && /*#__PURE__*/_jsx("span", {
-      className: classes.selected,
-      children: selected
-    })]
+    }), selected]
   });
 };
-Toggle.defaultProps = {
-  open: false,
-  selected: null
-};
 export default /*#__PURE__*/memo(Toggle);

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

@@ -0,0 +1,25 @@
+export interface ValueCheckboxProps {
+    /**
+     * Id of the filter value. Also used as the form element name and test id.
+     */
+    id: string;
+    /**
+     * Display label of the filter value. Rendered as is — never translated.
+     */
+    label: string;
+    /**
+     * Number of products that are available for the filter value.
+     */
+    hits?: number;
+    /**
+     * Whether the value is currently selected.
+     */
+    isActive?: boolean;
+    /**
+     * Invoked with the value id whenever the checkbox is toggled.
+     */
+    onToggle?: (id: string) => void;
+}
+declare const _default: import("react").MemoExoticComponent<({ id, label, hits, isActive, onToggle, }: ValueCheckboxProps) => import("react").JSX.Element>;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../filter/components/FilterPageContent/components/Selector/components/ValueCheckbox/index.tsx"],"names":[],"mappings":"AA6CA,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC;uGAYE,kBAAkB;AAkCrB,wBAAmC"}

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"}