@pareto-engineering/design-system 4.0.0-alpha.61 → 4.0.0-alpha.63

package/dist/es/f/fields/V2/QueryCombobox/common/MultipleCombobox/MultipleCombobox.js

@@ -0,0 +1,293 @@
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+/* @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/exports';
+import { useCombobox, useMultipleSelection } from 'downshift';
+import { Button } from "../../../../../../b";
+import { Popover, LoadingCircle } from "../../../../../../a";
+import { FormDescriptionV2, FormLabelV2 } from "../../../../..";
+import { lookUpInputValueFromFetchedOptions } from "../../../../../common";
+
+// 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,
+  labelColor,
+  name,
+  optional,
+  options: items,
+  getOptions,
+  setValue,
+  description,
+  value,
+  color,
+  isFetching,
+  minLength,
+  transformSearch,
+  disabled,
+  placeholder,
+  setOptions,
+  promptCreateNewOption
+  // ...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 (promptCreateNewOption) {
+      lookUpInputValueFromFetchedOptions({
+        items,
+        inputValue,
+        setOptions,
+        minLength
+      });
+    }
+  }, [inputValue, items, promptCreateNewOption]);
+  useEffect(() => {
+    if (value?.length > 0 && (testIfArraysAreUnique(value, selectedItems) || testIfArraysAreUnique(selectedItems, value))) {
+      setSelectedItems(value);
+    }
+  }, [value]);
+  const parentRef = useRef(null);
+  const resetInputValue = () => setInputValue('');
+  return /*#__PURE__*/React.createElement("div", _extends({
+    id: id,
+    className: [baseClassName, componentClassName, userClassName].filter(e => e).join(' '),
+    style: style,
+    ref: parentRef
+  }, getComboboxProps()), /*#__PURE__*/React.createElement(FormLabelV2, _extends({
+    className: [baseClassName, componentClassName].filter(e => e).join(' ')
+  }, getLabelProps(), {
+    name: name,
+    optional: optional,
+    color: labelColor
+  }), label), selectedItems?.length > 0 && /*#__PURE__*/React.createElement("div", {
+    className: "selected-items"
+  }, selectedItems.map((selectedItem, index) => /*#__PURE__*/React.createElement("div", _extends({
+    key: selectedItem.label
+  }, getSelectedItemProps({
+    selectedItem,
+    index
+  }), {
+    className: "item"
+  }), /*#__PURE__*/React.createElement(Button, {
+    onClick: e => {
+      e.stopPropagation();
+      removeSelectedItem(selectedItem);
+    },
+    isCompact: true,
+    color: color
+  }, /*#__PURE__*/React.createElement("span", null, selectedItem.label), /*#__PURE__*/React.createElement("span", {
+    className: "icon close"
+  }, "Y"))))), /*#__PURE__*/React.createElement("input", _extends({}, getInputProps(getDropdownProps({
+    preventKeyAction: isOpen
+  })), {
+    className: "input",
+    disabled: disabled,
+    placeholder: placeholder
+  })), isFetching && /*#__PURE__*/React.createElement(LoadingCircle, {
+    className: "x-main"
+  }), inputValue.length > minLength && !isFetching && /*#__PURE__*/React.createElement(Button, {
+    isSimple: true,
+    isCompact: true,
+    color: "interactive",
+    onClick: resetInputValue
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "icon"
+  }, "Y")), /*#__PURE__*/React.createElement(FormDescriptionV2, {
+    className: "s-1",
+    description: description,
+    name: name
+  }), /*#__PURE__*/React.createElement(Popover, {
+    isOpen: isOpen,
+    parentRef: parentRef
+  }, /*#__PURE__*/React.createElement(Menu, _extends({
+    className: `y-${color}`,
+    isOpen: isOpen,
+    getItemProps: getItemProps,
+    highlightedIndex: highlightedIndex,
+    items: getFilteredItems()
+  }, getMenuProps()))));
+};
+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,
+  /**
+   * The placeholder text for the input
+   */
+  placeholder: PropTypes.string
+};
+MultipleCombobox.defaultProps = {
+  // someProp: false
+};
+export default MultipleCombobox;

package/dist/es/f/fields/V2/QueryCombobox/common/MultipleCombobox/index.js

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

package/dist/es/f/fields/V2/QueryCombobox/common/index.js

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

package/dist/es/f/fields/V2/QueryCombobox/index.js

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

package/dist/es/f/fields/V2/QueryCombobox/styles.scss

@@ -0,0 +1,127 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+/* stylelint-disable max-nesting-depth -- needed here */
+/* stylelint-disable selector-max-compound-selectors -- needed here */
+
+@use "@pareto-engineering/bem";
+@use "@pareto-engineering/styles/src/mixins";
+@use "@pareto-engineering/styles/src/globals" as *;
+
+$default-input-padding: .55em .75em;
+$default-gap: var(--gap);
+$default-loading-circle-displacement: .5em;
+$default-input-border-radius: var(--theme-default-input-border-radius);
+$default-border: var(--theme-default-input-border);
+$hover-border: var(--theme-hover-input-border);
+$focus-border: var(--theme-focus-input-border);
+$default-background: var(--background-inputs);
+$on-default-background: var(--paragraph);
+$disabled-background: var(--background-inputs-30);
+$on-disabled-background: var(--on-background-inputs-30);
+
+.#{bem.$base}.combobox,
+.#{bem.$base}.multiple-combobox {
+  display: flex;
+  flex-direction: column;
+  outline: none;
+  position: relative;
+
+  > .#{bem.$base}.form-label {
+    margin-bottom: var(--gap);
+  }
+
+
+  .#{bem.$base}.popover {
+    border: $default-border;
+    border-radius: $default-input-border-radius;
+    width: 100%;
+
+    >.menu {
+      list-style: none;
+      margin: 0;
+      outline: 0;
+      padding: 0;
+
+      >.item {
+        border-radius: $default-input-border-radius;
+        padding: $default-input-padding;
+
+        > p {
+          margin: 0;
+        }
+
+        &.#{bem.$modifier-active} {
+          background-color: var(--y);
+
+          > p {
+            color: var(--on-y);
+          }
+        }
+      }
+    }
+  }
+
+  >.#{bem.$base}.loading-circle,
+  >.#{bem.$base}.button {
+    position: absolute;
+    right: $default-loading-circle-displacement;
+  }
+
+  >.#{bem.$base}.loading-circle {
+    top: calc($default-loading-circle-displacement * 1.5);
+  }
+
+  >.#{bem.$base}.button {
+    top: $default-loading-circle-displacement;
+  }
+
+  > .input {
+    background: $default-background;
+    border: $default-border;
+    border-radius: calc(var(--theme-default-border-radius) / 2);
+    color: $on-default-background;
+    outline: none;
+    padding: $default-input-padding;
+
+    &::placeholder {
+      color: var(--metadata);
+    }
+
+    &:disabled {
+      background-color: $disabled-background;
+      color: $on-disabled-background;
+    }
+
+    &:not(:disabled) {
+      &:hover,
+      &:active {
+        border: $hover-border;
+      }
+
+      &:focus {
+        border: $focus-border;
+      }
+    }
+  }
+}
+
+
+.#{bem.$base}.multiple-combobox {
+  >.selected-items {
+    display: flex;
+    flex-wrap: wrap;
+    gap: calc($default-gap / 2);
+    margin-bottom: calc($default-gap / 2);
+
+    >.item {
+      >.#{bem.$base}.button {
+        align-items: center;
+        display: flex;
+        gap: calc($default-gap / 2);
+      }
+
+      .close {
+        font-size: calc(var(--s-3) * 1em);
+      }
+    }
+  }
+}

package/dist/es/f/fields/V2/QuerySelect/QuerySelect.js

@@ -0,0 +1,186 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react';
+import { useState, useEffect } from 'react';
+import { useRelayEnvironment, fetchQuery } from 'react-relay';
+import { useField } from 'formik';
+import PropTypes from 'prop-types';
+
+// Local Definitions
+
+import { SelectInput } from "../../..";
+
+/**
+ * This is the component description.
+ */
+const QuerySelect = ({
+  id,
+  className: userClassName,
+  style,
+  name,
+  label,
+  labelColor,
+  optional,
+  query,
+  variables,
+  optionsKeyMap,
+  description,
+  disabled,
+  color,
+  loadingOption,
+  defaultOption,
+  validate
+  // ...otherProps
+}) => {
+  const [,, helpers] = useField({
+    name,
+    validate
+  });
+  const {
+    setError
+  } = helpers;
+  const environment = useRelayEnvironment();
+  const [isFetching, setIsFetching] = useState(false);
+  const [options, setOptions] = useState([]);
+  const {
+    graphql,
+    accessor
+  } = query;
+  const getOptions = () => {
+    if (isFetching) return;
+    fetchQuery(environment, graphql, variables).subscribe({
+      start: () => {
+        setIsFetching(true);
+        setOptions([loadingOption]);
+      },
+      complete: () => {
+        setIsFetching(false);
+      },
+      error: fetchError => {
+        setIsFetching(false);
+        if (setError) setError(fetchError.message);
+      },
+      next: data => {
+        setOptions([defaultOption, ...data[accessor].edges.map(({
+          node
+        }) => ({
+          value: node[optionsKeyMap.value],
+          label: optionsKeyMap.getLabel(node)
+        }))]);
+      }
+    });
+  };
+  useEffect(() => {
+    getOptions();
+  }, [variables]);
+  return /*#__PURE__*/React.createElement(SelectInput, {
+    id: id,
+    className: userClassName,
+    style: style,
+    name: name,
+    label: label,
+    optional: optional,
+    color: color,
+    labelColor: labelColor,
+    description: description,
+    disabled: isFetching || disabled,
+    options: options,
+    isLoading: isFetching
+  });
+};
+QuerySelect.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 name of the custom select input
+   */
+  name: PropTypes.string,
+  /**
+   * The label of the custom select input
+   */
+  label: PropTypes.string,
+  /**
+   * The custom select input description
+   */
+  description: PropTypes.string,
+  /**
+   * Whether the input should be disabled
+   */
+  disabled: PropTypes.bool,
+  /**
+   * The base color of the custom select input
+   */
+  color: PropTypes.string,
+  /**
+   * The label color of the custom select input
+   */
+  labelColor: PropTypes.string,
+  /**
+   * The graphql query to fetch the options and the accessor to destructure the results from
+   */
+  query: PropTypes.shape({
+    accessor: PropTypes.string,
+    graphql: PropTypes.oneOfType([PropTypes.string, PropTypes.object]).isRequired
+  }),
+  /**
+   *  The variables that might be required to be used in the query to fetch
+   *  select options.
+   */
+  variables: PropTypes.objectOf(PropTypes.string),
+  /**
+   *  The select option keys to be used to map the data to the select options.
+   * i.e `{ value: 'id', label: 'name' }`
+   */
+  optionsKeyMap: PropTypes.shape({
+    value: PropTypes.string.isRequired,
+    getLabel: PropTypes.func.isRequired
+  }).isRequired,
+  /**
+   * The default select option for the query select
+   */
+  defaultOption: PropTypes.shape({
+    value: PropTypes.string.isRequired,
+    label: PropTypes.string.isRequired,
+    disabled: PropTypes.bool.isRequired
+  }),
+  /**
+   * The option to dipslayed when the select options are being fetched
+   */
+  loadingOption: PropTypes.shape({
+    value: PropTypes.string.isRequired,
+    label: PropTypes.string.isRequired,
+    disabled: PropTypes.bool.isRequired
+  }),
+  /**
+   * The query select field validator function
+   */
+  validate: PropTypes.func,
+  /*
+  * Whether the input is optional or not
+  */
+  optional: PropTypes.bool
+};
+QuerySelect.defaultProps = {
+  disabled: false,
+  color: 'paragraph',
+  defaultOption: {
+    value: '',
+    label: 'Select an option',
+    disabled: true
+  },
+  loadingOption: {
+    value: '',
+    label: 'Fetching Options',
+    disabled: true
+  }
+};
+export default QuerySelect;

package/dist/es/f/fields/V2/QuerySelect/index.js

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