@pareto-engineering/design-system 2.0.0-alpha.9 → 3.0.0-alpha.18

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

@@ -0,0 +1,213 @@
+/* @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 'ui/f'
+
+/**
+ * This is the component description.
+ */
+const QuerySelect = ({
+  id,
+  className:userClassName,
+  style,
+  name,
+  label,
+  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 (
+    <SelectInput
+      id={id}
+      className={userClassName}
+      style={style}
+      name={name}
+      label={label}
+      optional={optional}
+      color={color}
+      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 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        :'background2',
+  defaultOption:{
+    value   :'',
+    label   :'Select an option',
+    disabled:true,
+  },
+  loadingOption:{
+    value   :'',
+    label   :'Fetching Options',
+    disabled:true,
+  },
+}
+
+export default QuerySelect

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

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

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

@@ -5,11 +5,12 @@ import { useState, useLayoutEffect, memo } from 'react'
 
 import PropTypes from 'prop-types'
 
-import styleNames from '@pareto-engineering/bem'
+import styleNames from '@pareto-engineering/bem/exports'
 
 // Local Definitions
 
 import { Rating } from './common'
+import { FormLabel } from '../../common'
 
 const baseClassName = styleNames.base
 
@@ -25,9 +26,13 @@ const RatingsInput = ({
   name,
   ratingCount,
   showRatingValue,
+  oneInputLabel,
+  label,
+  labelColor,
   labelMax,
   labelMin,
   displayRatingsLabel,
+  optional,
   // ...otherProps
 }) => {
   useLayoutEffect(() => {
@@ -47,24 +52,36 @@ const RatingsInput = ({
         .filter((e) => e)
         .join(' ')}
       style={style}
-      // {...otherProps}
     >
-      {displayRatingsLabel && <p className="label-text md-s-1 s-2 x-metadata c-x">{labelMin}</p>}
-      {[...Array(ratingCount)].map((_, index) => {
-        const ratingValue = index + 1
-        return (
-          <Rating
-            key={ratingValue}
-            ratingId={`${name}-${ratingValue}`}
-            value={ratingValue}
-            name={name}
-            hover={hover}
-            setHover={setHover}
-            showRatingValue={showRatingValue}
-          />
-        )
-      })}
-      {displayRatingsLabel && <p className="label-text md-s-1 s-2 x-metadata c-x">{labelMax}</p>}
+      <FormLabel
+        className={[
+          'input-label', oneInputLabel ? 'md-s2 s0 v1 mb-v' : 'v50 mb-v']
+          .filter((e) => e)
+          .join(' ')}
+        name={name}
+        color={labelColor}
+        optional={optional}
+      >
+        { label }
+      </FormLabel>
+      <div className="stars">
+        {displayRatingsLabel && <p className="label-text md-s-1 s-2 x-metadata c-x">{labelMin}</p>}
+        {[...Array(ratingCount)].map((_, index) => {
+          const ratingValue = index + 1
+          return (
+            <Rating
+              key={ratingValue}
+              ratingId={`${name}-${ratingValue}`}
+              value={ratingValue}
+              name={name}
+              hover={hover}
+              setHover={setHover}
+              showRatingValue={showRatingValue}
+            />
+          )
+        })}
+        {displayRatingsLabel && <p className="label-text md-s-1 s-2 x-metadata c-x">{labelMax}</p>}
+      </div>
     </div>
   )
 }
@@ -97,6 +114,10 @@ RatingsInput.propTypes = {
    * Determines if the rating start value should be shown
    */
   showRatingValue    :PropTypes.bool,
+  /**
+   * The label of the ratings input
+   */
+  label              :PropTypes.string.isRequired,
   /**
    * description for the highest rating value
    */
@@ -109,11 +130,25 @@ RatingsInput.propTypes = {
    * If the rating lables should be shown
    */
   displayRatingsLabel:PropTypes.bool,
+  /**
+   * Whether the input is optional or not
+   */
+  optional           :PropTypes.bool,
+  /**
+ * If the slide will only have one input
+ */
+  oneInputLabel      :PropTypes.bool,
+
+  /**
+ * String that will represent color for the label
+ */
+  labelColor:PropTypes.string,
 }
 
 RatingsInput.defaultProps = {
-  labelMin:'not satisfied.',
-  labelMax:'very satisfied.',
+  labelMin  :'not satisfied.',
+  labelMax  :'very satisfied.',
+  labelColor:'main2',
 }
 
 export default memo(RatingsInput)

package/src/ui/f/fields/RatingsInput/common/Rating/Rating.jsx

@@ -5,7 +5,7 @@ import PropTypes from 'prop-types'
 
 import { useField } from 'formik'
 
-import styleNames from '@pareto-engineering/bem'
+import styleNames from '@pareto-engineering/bem/exports'
 
 // Local Definitions
 
@@ -25,12 +25,13 @@ const Rating = ({
   ratingId,
   hover,
   setHover,
+  validate,
   activeBackgroundColor,
   inactiveBackgroundColor,
   showRatingValue,
   // ...otherProps
 }) => {
-  const [field] = useField(name)
+  const [field] = useField({ name, validate })
 
   return (
     <div
@@ -59,7 +60,7 @@ const Rating = ({
         <span
           className={[
             'f-icons',
-            value <= (hover || Number(field.value)) ? 'c-x' : 'c-dark-y',
+            value <= (hover || Number(field.value)) ? 'c-x' : 'c-hard-y',
           ]
             .filter((e) => e)
             .join(' ')}
@@ -125,6 +126,11 @@ Rating.propTypes = {
    * Determines if the rating start value should be shown
    */
   showRatingValue        :PropTypes.bool,
+
+  /**
+   * The rating field validator function
+   */
+  validate:PropTypes.func,
 }
 
 Rating.defaultProps = {

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

@@ -7,34 +7,43 @@ $default-transition: all .2s;
 
 .#{bem.$base}.ratings-input {
   display: flex;
+  flex-direction: column;
 
-  >:not(:last-child) {
-    margin-right: $default-rating-icon-margin;
+  p {
+    padding: $default-padding;
   }
 
-  .#{bem.$base}.rating {
+  .stars {
     display: flex;
 
-    input {
-      opacity: 0;
-      position: absolute;
-      visibility: none;
-      z-index: -1;
+    >:not(:last-child) {
+      margin-right: $default-rating-icon-margin;
     }
-
-    label {
+  
+    .#{bem.$base}.rating {
       display: flex;
-      flex-direction: column;
-      align-items: center;
-      padding: $default-padding;
-      transition: $default-transition;
-      cursor: pointer;
+  
+      input {
+        opacity: 0;
+        position: absolute;
+        visibility: none;
+        z-index: -1;
+      }
+  
+      label {
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        padding: $default-padding;
+        transition: $default-transition;
+        cursor: pointer;
+      }
+    }
+  
+    .label-text {
+      margin-bottom: 0;
+      align-self: flex-end;
     }
-  }
-
-  .label-text {
-    margin-bottom: 0;
-    align-self: flex-end;
   }
 }
 

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

@@ -7,7 +7,9 @@ import { useField } from 'formik'
 
 import PropTypes from 'prop-types'
 
-import styleNames from '@pareto-engineering/bem'
+import styleNames from '@pareto-engineering/bem/exports'
+
+import { LoadingCircle } from 'ui/a'
 
 import { FormLabel, FormDescription } from '../../common'
 
@@ -26,15 +28,21 @@ const SelectInput = ({
   style,
   name,
   label,
+  color,
   options,
+  validate,
+  optional,
+  description,
   disabled,
+  isLoading,
+  autoComplete,
   // ...otherProps
 }) => {
   useLayoutEffect(() => {
     import('./styles.scss')
   }, [])
 
-  const [field, meta] = useField(name)
+  const [field] = useField({ name, validate })
 
   return (
     <div
@@ -45,25 +53,45 @@ const SelectInput = ({
 
         componentClassName,
         userClassName,
+        `y-${color}`,
       ]
         .filter((e) => e)
         .join(' ')}
       style={style}
       // {...otherProps}
     >
-      <FormLabel className="input-label" name={name}>{label}</FormLabel>
-      <select className="input v25 pv-v" {...field} id={name} disabled={disabled}>
-        {
+      <FormLabel name={name} optional={optional}>{label}</FormLabel>
+      <div className="select-wrapper">
+        <select
+          className="input"
+          {...field}
+          value={field.value || ''}
+          id={name}
+          disabled={disabled}
+          autoComplete={autoComplete}
+        >
+          {
         options.map((option) => {
           // i.e if option is a string like "blah", return { value: "blah", label: "blah" }
           const newOption = typeof option === 'string' ? { value: option, label: option } : option
+
           return (
-            <option key={newOption.value} value={newOption.value}>{newOption.label}</option>
+            <option
+              key={newOption.value}
+              value={newOption.value}
+              disabled={newOption?.disabled || false}
+            >
+              {newOption.label}
+            </option>
           )
         })
       }
-      </select>
-      {meta.error && meta.touched && <FormDescription error>{meta.error}</FormDescription>}
+        </select>
+        {isLoading && (
+        <LoadingCircle className="x-main2" />
+        )}
+      </div>
+      <FormDescription className="v50 mt-v s-1" description={description} name={name} />
     </div>
   )
 }
@@ -93,22 +121,58 @@ SelectInput.propTypes = {
    */
   label:PropTypes.string,
 
+  /**
+   * The input field validator function
+   */
+  validate:PropTypes.func,
+
+  /**
+   * The select input description
+   */
+  description:PropTypes.string,
+
   /**
    * The options of the select input
    */
   options:PropTypes.arrayOf(
     PropTypes.oneOfType(
-      [PropTypes.string, PropTypes.shape({ value: PropTypes.string, label: PropTypes.string })],
+      [
+        PropTypes.string,
+        PropTypes.shape({
+          value   :PropTypes.string,
+          label   :PropTypes.string,
+          disabled:PropTypes.bool,
+        })],
     ),
   ),
   /**
    * Whether the select input should be disabled
    */
   disabled:PropTypes.bool,
+
+  /**
+   * The color of the select input
+   */
+  color:PropTypes.string,
+
+  /*
+  * Whether the query that is fetching the select options is still in flight
+  */
+  isLoading   :PropTypes.bool,
+  /**
+   * The autoComplete value that the browser should watch for the input
+   */
+  autoComplete:PropTypes.string,
+
+  /**
+  * Whether the input is optional or not
+  */
+  optional:PropTypes.bool,
 }
 
 SelectInput.defaultProps = {
   disabled:false,
+  color   :'background2',
 }
 
 export default memo(SelectInput)

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

@@ -5,26 +5,46 @@
 @use "../../../form.scss";
 
 
-$default-padding: 0.75em 0.75em 0.55em;
-
+$default-padding: 0.75em;
+$default-margin: 1em;
 
 .#{bem.$base}.select-input {
   display: flex;
   flex-direction: column;
 
-
-  .input-label {
-    color: var(--main1);
+  .#{bem.$base}.label {
+    margin-bottom: $default-margin
   }
 
-  .input {
-    background: var(--light-background1);
-    color: var(--on-background1);
-    padding: $default-padding;
+  .select-wrapper {
+    position: relative;
 
-    &:focus {
-      background: var(--dark-background1);
+    >.#{bem.$base}.loading-circle {
+      position: absolute;
+      right: 0;
+      top: 50%;
+      transform: translateY(-50%);
     }
-  }
-}
 
+    >.input {
+      width: 100%;
+      border: var(--theme-border-style) var(--hard-y);
+      background: var(--soft-y);
+      color: var(--on-y);
+      padding: $default-padding;
+
+      &:not(:disabled):hover {
+        border: var(--theme-border-style) var(--soft-background4);
+      }
+
+      &:disabled {
+        background-color: var(--hard-y);
+        appearance: none;
+      }
+
+      &:focus {
+        background: var(--y);
+      }
+    }
+  }
+}