@pareto-engineering/design-system 2.0.0-alpha.7 → 2.0.0-alpha.70

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

@@ -0,0 +1,241 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useEffect, useRef } from 'react'
+
+import PropTypes from 'prop-types'
+
+import { useCombobox } from 'downshift'
+
+import styleNames from '@pareto-engineering/bem'
+
+import { FormLabel, FormDescription } from 'ui/f'
+
+import { Popover, LoadingCircle } from 'ui/a'
+
+import { Button } from 'ui/b'
+
+// Local Definitions
+
+import { Menu } from '../Menu'
+
+const baseClassName = styleNames.base
+
+const componentClassName = 'combobox'
+
+/**
+ * This is the component description.
+ */
+const Combobox = ({
+  id,
+  className:userClassName,
+  style,
+  label,
+  name,
+  options:items,
+  getOptions,
+  setValue,
+  description,
+  value,
+  color,
+  minLength,
+  isFetching,
+  transformSearch,
+  disabled,
+  optional,
+  // ...otherProps
+}) => {
+  const {
+    isOpen,
+    selectItem,
+    selectedItem,
+    inputValue,
+    setInputValue,
+    getLabelProps,
+    getMenuProps,
+    getInputProps,
+    highlightedIndex,
+    getComboboxProps,
+    getItemProps,
+  } = useCombobox({
+    items,
+    initialSelectedItem:value,
+    itemToString       :(item) => (item ? item.label : ''),
+    onInputValueChange :({ inputValue:searchInputValue }) => {
+      const transformedInput = transformSearch(searchInputValue)
+      if (transformedInput.length > minLength) {
+        getOptions(transformedInput)
+      }
+    },
+  })
+
+  // If the user has selected an item, we'll set the value of the field
+  // or if the combobox state has a selected item, we'll set the value to the formik state
+  useEffect(() => {
+    if (selectedItem) {
+      setValue(selectedItem)
+    }
+  }, [selectedItem])
+
+  // If the formik state has a value, we'll set the selected item to the combobox state
+  useEffect(() => {
+    if (value?.value !== selectedItem?.value) {
+      selectItem(value)
+    }
+  }, [value])
+
+  const parentRef = useRef(null)
+
+  const resetInputValue = () => setInputValue('')
+
+  return (
+    <div
+      id={id}
+      className={[
+
+        baseClassName,
+
+        componentClassName,
+        userClassName,
+        `y-${color}`,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={style}
+      ref={parentRef}
+    >
+      <FormLabel
+        {...getLabelProps()}
+        name={name}
+        optional={optional}
+      >
+        {label}
+      </FormLabel>
+
+      <div {...getComboboxProps()} className="input-wrapper">
+        <input {...getInputProps()} className="input" disabled={disabled} />
+        {isFetching && (
+        <LoadingCircle className="x-main2" />
+        )}
+        {inputValue.length > minLength && !isFetching && (
+          <Button isSimple isCompact color="main2" onClick={resetInputValue}>
+            <span className="f-icons">
+              Y
+            </span>
+          </Button>
+        )}
+      </div>
+
+      <Popover
+        isOpen={isOpen}
+        parentRef={parentRef}
+      >
+        <Menu
+          isOpen={isOpen}
+          getItemProps={getItemProps}
+          highlightedIndex={highlightedIndex}
+          items={items}
+          {...getMenuProps()}
+        />
+      </Popover>
+
+      <FormDescription className="v50 mt-v s-1" description={description} name={name} />
+    </div>
+  )
+}
+
+Combobox.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 value of the custom select input
+   */
+  value:PropTypes.shape({
+    value:PropTypes.string,
+    label:PropTypes.string,
+  }),
+
+  /**
+   * The base color of the combobox 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,
+
+  /**
+   * Whether the input filed shpuld be disabled
+   */
+  disabled:PropTypes.bool,
+
+  /**
+  * Whether the input is optional or not
+  */
+  optional:PropTypes.bool,
+}
+
+Combobox.defaultProps = {
+  // someProp: false
+}
+
+export default Combobox

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

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

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

@@ -0,0 +1,103 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import PropTypes from 'prop-types'
+
+import styleNames from '@pareto-engineering/bem'
+
+// Local Definitions
+
+const baseClassName = styleNames.base
+
+const componentClassName = 'menu'
+
+/**
+ * This is the component description.
+ */
+const Menu = React.forwardRef(({
+  id,
+  className:userClassName,
+  style,
+  items,
+  isOpen,
+  highlightedIndex,
+  getItemProps,
+  ...otherProps
+}, ref) => (
+  <ul
+    id={id}
+    className={[
+
+      baseClassName,
+
+      componentClassName,
+      userClassName,
+    ]
+      .filter((e) => e)
+      .join(' ')}
+    style={style}
+    ref={ref}
+    {...otherProps}
+  >
+    {isOpen && items.map((item, index) => (
+      <li
+        key={item.label}
+        {...getItemProps({ item, index })}
+        className={[
+          'item',
+          highlightedIndex === index && styleNames.modifierActive,
+        ].filter(Boolean)
+          .join(' ')}
+      >
+        <p>
+          {item.label}
+        </p>
+      </li>
+    ))}
+  </ul>
+))
+Menu.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 items to be displayed in the menu
+   */
+  items:PropTypes.arrayOf(PropTypes.shape({
+    value:PropTypes.string,
+    label:PropTypes.string,
+  })),
+
+  /**
+   * Whether or not the menu is open
+   */
+  isOpen:PropTypes.bool,
+
+  /**
+   * The index of the highlighted item
+   */
+  highlightedIndex:PropTypes.number,
+
+  /**
+   * The function to get the item props
+   */
+  getItemProps:PropTypes.func,
+}
+
+Menu.defaultProps = {
+  // someProp:false
+}
+
+export default Menu

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

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

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

@@ -0,0 +1,340 @@
+/* @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,
+  optional,
+  options:items,
+  getOptions,
+  setValue,
+  description,
+  value,
+  color,
+  isFetching,
+  minLength,
+  transformSearch,
+  disabled,
+  // ...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,
+    inputValue,
+    setInputValue,
+  } = 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)
+
+  const resetInputValue = () => setInputValue('')
+
+  return (
+    <div
+      id={id}
+      className={[
+
+        baseClassName,
+
+        componentClassName,
+        userClassName,
+        `y-${color}`,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={style}
+    >
+
+      <FormLabel
+        {...getLabelProps()}
+        name={name}
+        optional={optional}
+      >
+        {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"
+          disabled={disabled}
+        />
+        {isFetching && (
+        <LoadingCircle className="x-main2" />
+        )}
+        {inputValue.length > minLength && !isFetching && (
+          <Button
+            isSimple
+            isCompact
+            color="main2"
+            onClick={resetInputValue}
+          >
+            <span className="f-icons">
+              Y
+            </span>
+          </Button>
+        )}
+      </div>
+
+      <Popover
+        isOpen={isOpen}
+        parentRef={parentRef}
+      >
+        <Menu
+          isOpen={isOpen}
+          getItemProps={getItemProps}
+          highlightedIndex={highlightedIndex}
+          items={getFilteredItems()}
+          {...getMenuProps()}
+        />
+      </Popover>
+
+      <FormDescription className="v50 mt-v s-1" description={description} name={name} />
+
+    </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 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,
+
+  /**
+   * Whether the input filed shpuld be disabled
+   */
+  disabled:PropTypes.bool,
+
+  /**
+  * Whether the input is optional or not
+  */
+  optional:PropTypes.bool,
+}
+
+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

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

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

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