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

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

@@ -0,0 +1,214 @@
+/* @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'
+
+// 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,
+  error,
+  description,
+  value,
+  color,
+  loadingCircleColor,
+  isFetching,
+  // ...otherProps
+}) => {
+  const {
+    isOpen,
+    selectItem,
+    selectedItem,
+    getLabelProps,
+    getMenuProps,
+    getInputProps,
+    highlightedIndex,
+    getComboboxProps,
+    getItemProps,
+  } = useCombobox({
+    items,
+    initialSelectedItem:value,
+    itemToString       :(item) => (item ? item.label : ''),
+    onInputValueChange :({ inputValue }) => {
+      getOptions(inputValue)
+    },
+  })
+
+  // 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)
+
+  return (
+    <div
+      id={id}
+      className={[
+
+        baseClassName,
+
+        componentClassName,
+        userClassName,
+        `y-${color}`,
+        `x-${loadingCircleColor}`,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={style}
+      ref={parentRef}
+    >
+      <FormLabel {...getLabelProps()} name={name}>
+        {label}
+      </FormLabel>
+
+      <div {...getComboboxProps()} className="input-wrapper">
+        <input {...getInputProps()} className="input" />
+        {isFetching && (
+        <LoadingCircle />
+        )}
+      </div>
+
+      <Popover
+        isOpen={isOpen}
+        parentRef={parentRef}
+      >
+        <Menu
+          isOpen={isOpen}
+          getItemProps={getItemProps}
+          highlightedIndex={highlightedIndex}
+          items={items}
+          {...getMenuProps()}
+        />
+      </Popover>
+
+      {(description || error) && (
+      <FormDescription isError={!!error}>
+        { error || description }
+      </FormDescription>
+      )}
+    </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 error object
+   */
+  error:PropTypes.objectOf(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 loading circle color
+   */
+  loadingCircleColor:PropTypes.string,
+}
+
+Combobox.defaultProps = {
+  loadingCircleColor:'main2',
+}
+
+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/index.js

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

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'

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

@@ -0,0 +1,84 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+
+@use "@pareto-engineering/bem";
+
+$default-input-padding: .75em .75em .55em;
+$default-padding: 1em;
+$default-margin: 1em;
+$default-loading-circle-displacement: 1em;
+
+.#{bem.$base}.combobox,
+.#{bem.$base}.multiple-combobox {
+    position: relative;
+
+    .#{bem.$base}.label {
+        margin-bottom: $default-margin
+    }
+
+    .#{bem.$base}.popover {
+        width: 100%;
+
+        >.menu {
+            list-style: none;
+            margin: 0;
+            outline: 0;
+            padding: 0;
+
+            >.item {
+                padding: $default-padding / 2;
+
+                &.#{bem.$modifier-active} {
+                    background-color: var(--background2);
+                }
+            }
+        }
+    }
+
+    >.input-wrapper {
+        position: relative;
+
+        >.#{bem.$base}.loading-circle {
+            position: absolute;
+            top: $default-loading-circle-displacement;
+            right: $default-loading-circle-displacement;
+        }
+
+        >.input {
+            background: var(--light-y);
+            border: var(--theme-border-style) var(--dark-y);
+            color: var(--on-y);
+            padding: $default-input-padding;
+            width: 100%;
+
+            &::placeholder {
+                color: var(--metadata);
+            }
+
+            &:not(:disabled):hover {
+                border: var(--theme-border-style) var(--light-background4);
+            }
+
+            &:disabled {
+                background-color: var(--dark-y);
+            }
+
+            &:focus {
+                background: var(--light-background4);
+            }
+        }
+    }
+}
+
+
+.#{bem.$base}.multiple-combobox {
+    >.selected-items {
+        display: flex;
+
+        /* stylelint-disable selector-max-universal -- Allow */
+        >*:not(:first-child) {
+            margin-left: $default-margin;
+        }
+
+        /* stylelint-enable selector-max-universal */
+    }
+}

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

@@ -55,7 +55,7 @@ const SelectInput = ({
       style={style}
       // {...otherProps}
     >
-      <FormLabel className="input-label" name={name}>{label}</FormLabel>
+      <FormLabel name={name}>{label}</FormLabel>
       <select className="input" {...field} value={field.value || ''} id={name} disabled={disabled}>
         {
         options.map((option) => {

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

@@ -6,24 +6,27 @@
 
 
 $default-padding: 0.75em;
-
+$default-margin: 1em;
 
 .#{bem.$base}.select-input {
   display: flex;
   flex-direction: column;
 
+  .#{bem.$base}.label {
+    margin-bottom: $default-margin
+  }
 
   .input {
     border: var(--theme-border-style) var(--dark-y);
     background: var(--light-y);
-    color:var(--on-y);
+    color: var(--on-y);
     padding: $default-padding;
 
-     &:not(:disabled):hover{
+    &:not(:disabled):hover {
       border: var(--theme-border-style) var(--light-background4);
     }
 
-     &:disabled {
+    &:disabled {
       background-color: var(--dark-y);
     }
 
@@ -31,5 +34,4 @@ $default-padding: 0.75em;
       background: var(--y);
     }
   }
-}
-
+}

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

@@ -3,3 +3,4 @@ export { SelectInput } from './SelectInput'
 export { ChoicesInput } from './ChoicesInput'
 export { TextareaInput } from './TextareaInput'
 export { RatingsInput } from './RatingsInput'
+export { QueryCombobox } from './QueryCombobox'

package/src/ui/index.js

@@ -5,3 +5,4 @@ export * from './c'
 export * from './d'
 export * from './f'
 export * from './utils'
+export * from './test'

package/src/ui/test/QueryLoader/QueryLoader.jsx

@@ -0,0 +1,41 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useEffect, Suspense } from 'react'
+
+import { useQueryLoader } from 'react-relay'
+
+// Local Definitions
+
+import { PreloadedTestData } from './common'
+
+const testQuery = graphql`
+  query QueryLoaderHelloQuery {
+    hello
+  }
+`
+
+/**
+ * This is the component description.
+ */
+const QueryLoader = () => {
+  const [queryReference, loadQuery] = useQueryLoader(testQuery)
+
+  useEffect(() => {
+    loadQuery({})
+  }, [])
+
+  return (
+    <Suspense fallback="loading">
+      {queryReference ? (
+        <PreloadedTestData queryReference={queryReference} query={testQuery} />
+      ) : null}
+    </Suspense>
+  )
+}
+
+QueryLoader.defaultProps = {
+  // someProp:false
+}
+
+export default QueryLoader

package/src/ui/test/QueryLoader/__generated__/QueryLoaderHelloQuery.graphql.js

@@ -0,0 +1,68 @@
+/**
+ * @flow
+ */
+
+/* eslint-disable */
+
+'use strict';
+
+/*::
+import type { ConcreteRequest } from 'relay-runtime';
+export type QueryLoaderHelloQueryVariables = {||};
+export type QueryLoaderHelloQueryResponse = {|
+  +hello: ?string
+|};
+export type QueryLoaderHelloQuery = {|
+  variables: QueryLoaderHelloQueryVariables,
+  response: QueryLoaderHelloQueryResponse,
+|};
+*/
+
+
+/*
+query QueryLoaderHelloQuery {
+  hello
+}
+*/
+
+const node/*: ConcreteRequest*/ = (function(){
+var v0 = [
+  {
+    "alias": null,
+    "args": null,
+    "kind": "ScalarField",
+    "name": "hello",
+    "storageKey": null
+  }
+];
+return {
+  "fragment": {
+    "argumentDefinitions": [],
+    "kind": "Fragment",
+    "metadata": null,
+    "name": "QueryLoaderHelloQuery",
+    "selections": (v0/*: any*/),
+    "type": "Query",
+    "abstractKey": null
+  },
+  "kind": "Request",
+  "operation": {
+    "argumentDefinitions": [],
+    "kind": "Operation",
+    "name": "QueryLoaderHelloQuery",
+    "selections": (v0/*: any*/)
+  },
+  "params": {
+    "cacheID": "463f9ee8a82dd6ec8dedeb28649cce74",
+    "id": null,
+    "metadata": {},
+    "name": "QueryLoaderHelloQuery",
+    "operationKind": "query",
+    "text": "query QueryLoaderHelloQuery {\n  hello\n}\n"
+  }
+};
+})();
+// prettier-ignore
+(node/*: any*/).hash = 'b92d001ab0208bd484a99f77c274d5ef';
+
+module.exports = node;

package/src/ui/test/QueryLoader/common/PreloadedTestData/PreloadedTestData.jsx

@@ -0,0 +1,51 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import PropTypes from 'prop-types'
+
+import { usePreloadedQuery } from 'react-relay'
+
+/**
+ * This is the component description.
+ */
+const PreloadedTestData = ({
+  query,
+  queryReference,
+  // ...otherProps
+}) => {
+  const data = usePreloadedQuery(query, queryReference)
+
+  return (
+    <pre>
+      {JSON.stringify(data, null, 2)}
+    </pre>
+  )
+}
+
+PreloadedTestData.propTypes = {
+  /**
+   * The query to be used to query the test data
+   */
+  query:PropTypes.objectOf(
+    PropTypes.PropTypes.oneOfType([
+      PropTypes.string,
+      PropTypes.object,
+    ]),
+  ),
+
+  /**
+   *  The query reference to be used to access the preloaded data
+   */
+  queryReference:PropTypes.objectOf(
+    PropTypes.PropTypes.oneOfType([
+      PropTypes.string,
+      PropTypes.object,
+    ]),
+  ),
+}
+
+PreloadedTestData.defaultProps = {
+  // someProp:false
+}
+
+export default PreloadedTestData

package/src/ui/test/QueryLoader/common/PreloadedTestData/index.js

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

package/src/ui/test/QueryLoader/common/index.js

@@ -0,0 +1 @@
+export { PreloadedTestData } from './PreloadedTestData'

package/src/ui/test/QueryLoader/index.js

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

package/src/ui/test/index.js

@@ -0,0 +1 @@
+export { QueryLoader } from './QueryLoader'