@pareto-engineering/design-system 2.0.0-alpha.46 → 2.0.0-alpha.49

package/src/ui/f/fields/QueryCombobox/QueryCombobox.jsx

@@ -11,7 +11,7 @@ import PropTypes from 'prop-types'
 
 // Local Definitions
 
-import { Combobox } from './common'
+import { Combobox, MultipleCombobox } from './common'
 
 /**
  * This is the component description.
@@ -21,17 +21,18 @@ const QueryCombobox = ({
   style,
   className,
   query,
-  // multiple,
+  multiple,
   name,
   label,
   color,
   description,
   disabled,
   debounceMs,
-  graphQlNode,
   searchVariable,
   extraVariables,
   optionsKeyMap,
+  minLength,
+  transformSearch,
   // ...otherProps
 }) => {
   useLayoutEffect(() => {
@@ -50,6 +51,8 @@ const QueryCombobox = ({
 
   const [options, setOptions] = useState([])
 
+  const { graphql, accessor } = query
+
   const getOptions = (inputValue) => {
     if (isFetching) return
 
@@ -64,7 +67,7 @@ const QueryCombobox = ({
 
     fetchQuery(
       environment,
-      query,
+      graphql,
       variables,
     )
       .subscribe({
@@ -79,7 +82,7 @@ const QueryCombobox = ({
           if (setError)setError(fetchError.message)
         },
         next:(data) => {
-          setOptions(data[graphQlNode].edges.map(({ node }) => ({
+          setOptions(data[accessor].edges.map(({ node }) => ({
             value:node[optionsKeyMap.value],
             label:node[optionsKeyMap.label],
           })))
@@ -103,9 +106,11 @@ const QueryCombobox = ({
     color,
     isFetching,
     className,
+    minLength,
+    transformSearch,
   }
 
-  const Input = Combobox
+  const Input = multiple ? MultipleCombobox : Combobox
 
   return <Input {...comboboxProps} />
 }
@@ -157,12 +162,15 @@ QueryCombobox.propTypes = {
   debounceMs:PropTypes.number,
 
   /**
-   * The query to fetch the options
+   * The graphql query to fetch the options and the accessor to destructure the results from
    */
-  query:PropTypes.oneOfType([
-    PropTypes.string,
-    PropTypes.object,
-  ]).isRequired,
+  query:PropTypes.shape({
+    accessor:PropTypes.string,
+    graphql :PropTypes.oneOfType([
+      PropTypes.string,
+      PropTypes.object,
+    ]).isRequired,
+  }),
 
   /**
    *  The extra variables required to be used in the query.
@@ -192,6 +200,16 @@ QueryCombobox.propTypes = {
    * The variable to be used to search the data
    */
   searchVariable:PropTypes.string,
+
+  /**
+   * The minimum length of the search input to start fetching the options
+   */
+  minLength:PropTypes.number,
+
+  /**
+   * The function to transform the search input
+   */
+  transformSearch:PropTypes.func,
 }
 
 QueryCombobox.defaultProps = {
@@ -199,9 +217,11 @@ QueryCombobox.defaultProps = {
     value:'id',
     label:'name',
   },
-  multiple      :false,
-  color         :'background2',
-  searchVariable:'search',
+  multiple       :false,
+  color          :'background2',
+  searchVariable :'search',
+  transformSearch:(search) => search,
+  minLength      :2,
 }
 
 export default QueryCombobox

package/src/ui/f/fields/QueryCombobox/common/Combobox/Combobox.jsx

@@ -37,8 +37,9 @@ const Combobox = ({
   description,
   value,
   color,
-  loadingCircleColor,
+  minLength,
   isFetching,
+  transformSearch,
   // ...otherProps
 }) => {
   const {
@@ -56,7 +57,10 @@ const Combobox = ({
     initialSelectedItem:value,
     itemToString       :(item) => (item ? item.label : ''),
     onInputValueChange :({ inputValue }) => {
-      getOptions(inputValue)
+      const transformedInput = transformSearch(inputValue)
+      if (transformedInput.length > minLength) {
+        getOptions(transformedInput)
+      }
     },
   })
 
@@ -87,7 +91,6 @@ const Combobox = ({
         componentClassName,
         userClassName,
         `y-${color}`,
-        `x-${loadingCircleColor}`,
       ]
         .filter((e) => e)
         .join(' ')}
@@ -101,7 +104,7 @@ const Combobox = ({
       <div {...getComboboxProps()} className="input-wrapper">
         <input {...getInputProps()} className="input" />
         {isFetching && (
-        <LoadingCircle />
+        <LoadingCircle className="x-main2" />
         )}
       </div>
 
@@ -202,13 +205,18 @@ Combobox.propTypes = {
   isFetching:PropTypes.bool.isRequired,
 
   /**
-   * The loading circle color
+   * The minimum length of the search input to start fetching the options
    */
-  loadingCircleColor:PropTypes.string,
+  minLength:PropTypes.number,
+
+  /**
+   * The function to transform the search input
+   */
+  transformSearch:PropTypes.func,
 }
 
 Combobox.defaultProps = {
-  loadingCircleColor:'main2',
+  // someProp: false
 }
 
 export default Combobox

package/src/ui/f/fields/QueryCombobox/common/MultipleCombobox/MultipleCombobox.jsx

@@ -0,0 +1,318 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useState, useEffect, useRef } from 'react'
+
+import PropTypes from 'prop-types'
+
+import styleNames from '@pareto-engineering/bem'
+
+import { useCombobox, useMultipleSelection } from 'downshift'
+
+import { Button } from 'ui/b'
+
+import { Popover, LoadingCircle } from 'ui/a'
+
+import { FormDescription, FormLabel } from 'ui/f'
+
+// Local Definitions
+
+import { Menu } from '../Menu'
+
+const baseClassName = styleNames.base
+
+const componentClassName = 'multiple-combobox'
+
+/**
+ *  @param {Array[Object]} first - first array to check if it has an item not in the second array.
+ *  @param {Array[Object]} second - second array to check against the first array.
+ *
+ * @returns {Boolean} - true if the first array has an item not in the second array.
+ */
+const testIfArraysAreUnique = (first, second) => first
+  .filter((objInFirstArray) => !second
+    .some((objInSecondArray) => objInFirstArray.value === objInSecondArray.value))
+  .length > 0
+
+/**
+ * This is the component description.
+ */
+const MultipleCombobox = ({
+  id,
+  className:userClassName,
+  style,
+  label,
+  name,
+  options:items,
+  getOptions,
+  setValue,
+  error,
+  description,
+  value,
+  color,
+  isFetching,
+  minLength,
+  transformSearch,
+  // ...otherProps
+}) => {
+  const [searchInputValue, setSearchInputValue] = useState('')
+  const {
+    getSelectedItemProps,
+    getDropdownProps,
+    addSelectedItem,
+    removeSelectedItem,
+    setSelectedItems,
+    selectedItems,
+  } = useMultipleSelection({
+    initialSelectedItems:value || [],
+  })
+
+  /**
+   * @returns {Boolean} - Unique items from the options array so that the combobox
+   * shows only the options that are not yet selected.
+ */
+  const getFilteredItems = () => items
+    .filter((item) => selectedItems
+      .findIndex((e) => e.label === item.label) < 0)
+
+  const {
+    isOpen,
+    getLabelProps,
+    getMenuProps,
+    getInputProps,
+    getComboboxProps,
+    highlightedIndex,
+    getItemProps,
+  } = useCombobox({
+    searchInputValue,
+    defaultHighlightedIndex:0, // after selection, highlight the first item.
+    selectedItem           :null,
+    items                  :getFilteredItems(),
+    circularNavigation     :true,
+    stateReducer           :(state, actionAndChanges) => {
+      const { changes, type } = actionAndChanges
+      switch (type) {
+        case useCombobox.stateChangeTypes.InputKeyDownEnter:
+        case useCombobox.stateChangeTypes.ItemClick:
+          return {
+            ...changes,
+            isOpen:true, // keep the menu open after selection.
+          }
+        default:
+          break
+      }
+      return changes
+    },
+    onStateChange:({ inputValue:newSearchInputValue, type, selectedItem }) => {
+      switch (type) {
+        case useCombobox.stateChangeTypes.InputChange: {
+          const transformedInput = transformSearch(newSearchInputValue)
+          if (transformedInput.length > minLength) {
+            getOptions(transformedInput)
+          }
+          setSearchInputValue(newSearchInputValue)
+          break
+        }
+        case useCombobox.stateChangeTypes.InputKeyDownEnter:
+        case useCombobox.stateChangeTypes.ItemClick:
+        case useCombobox.stateChangeTypes.InputBlur:
+          if (selectedItem) {
+            setSearchInputValue('')
+            addSelectedItem(selectedItem)
+          }
+          break
+        default:
+          break
+      }
+    },
+  })
+
+  useEffect(() => {
+    if (selectedItems?.length > 0) {
+      setValue(selectedItems)
+    }
+  }, [selectedItems])
+
+  useEffect(() => {
+    if (value?.length > 0 && (
+      testIfArraysAreUnique(value, selectedItems)
+      || testIfArraysAreUnique(selectedItems, value)
+    )) {
+      setSelectedItems(value)
+    }
+  }, [value])
+
+  const parentRef = useRef(null)
+
+  return (
+    <div
+      id={id}
+      className={[
+
+        baseClassName,
+
+        componentClassName,
+        userClassName,
+        `y-${color}`,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={style}
+    >
+
+      <FormLabel {...getLabelProps()} name={name}>
+        {label}
+      </FormLabel>
+
+      {selectedItems?.length > 0 && (
+      <div className="selected-items">
+        {selectedItems.map((selectedItem, index) => (
+          <div
+            key={selectedItem.label}
+            {...getSelectedItemProps({ selectedItem, index })}
+            className="item"
+          >
+            <Button
+              onClick={(e) => {
+                e.stopPropagation()
+                removeSelectedItem(selectedItem)
+              }}
+              isCompact
+              isSimple
+              color={color}
+            >
+              <span className="v25 mr-v">{selectedItem.label}</span>
+              <span className="f-icons close">Y</span>
+            </Button>
+          </div>
+        ))}
+      </div>
+      )}
+      <div {...getComboboxProps()} className="input-wrapper">
+        <input
+          {...getInputProps(
+            getDropdownProps({ preventKeyAction: isOpen }),
+          )}
+          className="input"
+        />
+        {isFetching && (
+        <LoadingCircle className="x-main2" />
+        )}
+      </div>
+
+      <Popover
+        isOpen={isOpen}
+        parentRef={parentRef}
+      >
+        <Menu
+          isOpen={isOpen}
+          getItemProps={getItemProps}
+          highlightedIndex={highlightedIndex}
+          items={getFilteredItems()}
+          {...getMenuProps()}
+        />
+      </Popover>
+
+      {(description || error) && (
+      <FormDescription isError={!!error}>
+        { error || description }
+      </FormDescription>
+      )}
+
+    </div>
+  )
+}
+
+MultipleCombobox.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id:PropTypes.string,
+
+  /**
+   * The HTML class names for this element
+   */
+  className:PropTypes.string,
+
+  /**
+   * The React-written, css properties for this element.
+   */
+  style:PropTypes.objectOf(PropTypes.string),
+
+  /**
+   * The label of the custom select input
+   */
+  label:PropTypes.string,
+
+  /**
+   * The custom select input options from the backend
+   */
+  options:PropTypes.arrayOf(
+    PropTypes.shape({
+      value:PropTypes.string,
+      label:PropTypes.string,
+    }),
+  ),
+
+  /**
+   * The name of the custom select input
+   */
+  name:PropTypes.string,
+
+  /**
+   * The function to fetch the options from the backend
+   */
+  getOptions:PropTypes.func,
+
+  /**
+   * The function to set the value of the custom select input
+   */
+  setValue:PropTypes.func.isRequired,
+
+  /**
+   * The custom select input description
+   */
+  description:PropTypes.string,
+
+  /**
+   * The error object
+   */
+  error:PropTypes.objectOf(PropTypes.string),
+
+  /**
+   * The value of the custom select input
+   */
+  value:PropTypes.arrayOf(
+    PropTypes.shape({
+      value:PropTypes.string,
+      label:PropTypes.string,
+    }),
+  ),
+
+  /**
+   * The base color of the custom select input
+   */
+  color:PropTypes.string,
+
+  /**
+   * Whether the query getting the combobox options is inFlight
+   */
+  isFetching:PropTypes.bool.isRequired,
+
+  /**
+   * The minimum length of the search input to start fetching the options
+   */
+  minLength:PropTypes.number,
+
+  /**
+   * The function to transform the search input
+   */
+  transformSearch:PropTypes.func,
+
+}
+
+MultipleCombobox.defaultProps = {
+  // someProp: false
+}
+
+export default MultipleCombobox

package/src/ui/f/fields/QueryCombobox/common/MultipleCombobox/index.js

@@ -0,0 +1,2 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+export { default as MultipleCombobox } from './MultipleCombobox'

package/src/ui/f/fields/QueryCombobox/common/index.js

@@ -1,2 +1,3 @@
 export { Menu } from './Menu'
 export { Combobox } from './Combobox'
+export { MultipleCombobox } from './MultipleCombobox'

package/src/ui/f/fields/QueryCombobox/styles.scss

@@ -5,6 +5,7 @@
 $default-input-padding: .75em .75em .55em;
 $default-padding: 1em;
 $default-margin: 1em;
+$default-gap: 1em;
 $default-loading-circle-displacement: 1em;
 
 .#{bem.$base}.combobox,
@@ -73,12 +74,17 @@ $default-loading-circle-displacement: 1em;
 .#{bem.$base}.multiple-combobox {
     >.selected-items {
         display: flex;
+        gap: $default-gap / 2;
+        flex-wrap: wrap;
+        margin-bottom: $default-margin / 2;
 
-        /* stylelint-disable selector-max-universal -- Allow */
-        >*:not(:first-child) {
-            margin-left: $default-margin;
-        }
+        >.item {
+            background-color: var(--main2);
+            padding: $default-padding / 4;
 
-        /* stylelint-enable selector-max-universal */
+            .close {
+                font-size: calc(var(--s-3) * 1em);
+            }
+        }
     }
 }