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

package/src/ui/c/index.js

@@ -1,3 +1,5 @@
 export { Hero } from './Hero'
 export { ContentSlides, useContentSlides } from './ContentSlides'
 export { Shortener } from './Shortener'
+export { SocialMediaShareButton } from './SocialMediaShareButton'
+export { Modal } from './Modal'

package/src/ui/f/FormInput/FormInput.jsx

@@ -1,7 +1,7 @@
 /* @pareto-engineering/generator-front 1.0.12 */
 import * as React from 'react'
 
-import { memo } from 'react'
+import { memo, useLayoutEffect } from 'react'
 
 import PropTypes from 'prop-types'
 
@@ -10,6 +10,11 @@ import {
   TextareaInput,
   ChoicesInput,
   SelectInput,
+  QueryCombobox,
+  QuerySelect,
+  RatingsInput,
+  Checkbox,
+  QueryChoices,
 } from '../fields'
 
 // Local Definitions
@@ -28,6 +33,10 @@ const FormInput = ({
   disabled,
   ...otherProps
 }) => {
+  useLayoutEffect(() => {
+    import('./styles.scss')
+  }, [])
+
   const newClassName = [
     className,
     componentClassName,
@@ -60,6 +69,54 @@ const FormInput = ({
       />
     )
   }
+  if (type === 'query-combobox') {
+    return (
+      <QueryCombobox
+        className={newClassName}
+        disabled={disabled}
+        {...otherProps}
+      />
+    )
+  }
+  if (type === 'query-select') {
+    return (
+      <QuerySelect
+        className={newClassName}
+        disabled={disabled}
+        {...otherProps}
+      />
+    )
+  }
+
+  if (type === 'query-choices') {
+    return (
+      <QueryChoices
+        className={newClassName}
+        disabled={disabled}
+        {...otherProps}
+      />
+    )
+  }
+
+  if (type === 'rating') {
+    return (
+      <RatingsInput
+        className={newClassName}
+        {...otherProps}
+      />
+    )
+  }
+
+  if (type === 'checkbox') {
+    return (
+      <Checkbox
+        className={newClassName}
+        disabled={disabled}
+        {...otherProps}
+      />
+    )
+  }
+
   if (extraTypes?.[type]) {
     const Component = extraTypes[type]
     return (
@@ -102,6 +159,9 @@ FormInput.propTypes = {
     'select',
     'choices',
     'textarea',
+    'query-combobox',
+    'url',
+    'rating',
     // to be removed
     'extendedTypeInput',
   ]),

package/src/ui/f/FormInput/styles.scss

@@ -0,0 +1,11 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+
+@use "@pareto-engineering/bem";
+
+$default-margin: 1em;
+
+.#{bem.$base}.form-input {
+    &+& {
+        margin-top: $default-margin;
+    }
+}

package/src/ui/f/common/Debugger/Debugger.jsx

@@ -41,7 +41,7 @@ const Debugger = ({
         .join(' ')}
       style={style}
     >
-      <Button onClick={toggleDebugger} color="main1">
+      <Button onClick={toggleDebugger} color="main2">
         { isOpen
           ? 'Close FormDebugger'
           : 'Open FormDebugger'}

package/src/ui/f/common/Description/Description.jsx

@@ -3,6 +3,8 @@ import * as React from 'react'
 
 import { useLayoutEffect } from 'react'
 
+import { useField } from 'formik'
+
 import PropTypes from 'prop-types'
 
 import styleNames from '@pareto-engineering/bem'
@@ -20,8 +22,8 @@ const Description = ({
   id,
   className:userClassName,
   style,
-  children,
-  isError,
+  description,
+  name,
   color,
   // ...otherProps
 }) => {
@@ -29,25 +31,27 @@ const Description = ({
     import('./styles.scss')
   }, [])
 
-  return (
-    <div
-      id={id}
-      className={[
-
-        baseClassName,
-
-        componentClassName,
-        userClassName,
-        isError ? 'x-error' : `x-${color}`,
-      ]
-        .filter((e) => e)
-        .join(' ')}
-      style={style}
-      // {...otherProps}
-    >
-      {children}
-    </div>
-  )
+  const [field, meta] = useField(name)
+
+  if (description || ((meta.touched || field.value) && meta.error)) {
+    return (
+      <div
+        id={id}
+        className={[
+          baseClassName,
+          componentClassName,
+          userClassName,
+          meta.error ? 'x-error' : `x-${color}`,
+        ]
+          .filter((e) => e)
+          .join(' ')}
+        style={style}
+      >
+        { meta.error || description}
+      </div>
+    )
+  }
+  return null
 }
 
 Description.propTypes = {
@@ -67,22 +71,23 @@ Description.propTypes = {
   style:PropTypes.objectOf(PropTypes.string),
 
   /**
-   *  The children JSX
+   * The base color for the description
    */
-  children:PropTypes.node,
+  color:PropTypes.string,
+
   /**
-   * The base color for the description
+   * Input description - extra description to guide a use in filling the input
    */
-  color   :PropTypes.string,
+  description:PropTypes.string,
+
   /**
-   * isError
+   * The input name (html - and Formik state)
    */
-  isError :PropTypes.bool,
+  name:PropTypes.string.isRequired,
 }
 
 Description.defaultProps = {
-  isError:false,
-  color  :'metadata',
+  color:'metadata',
 }
 
 export default Description

package/src/ui/f/common/Label/Label.jsx

@@ -11,7 +11,7 @@ import styleNames from '@pareto-engineering/bem'
 
 const baseClassName = styleNames.base
 
-const componentClassName = 'label'
+const componentClassName = 'form-label'
 
 /**
  * This is the component description.
@@ -23,6 +23,7 @@ const Label = ({
   children,
   name,
   color,
+  optional,
   as:Wrapper,
   // ...otherProps
 }) => {
@@ -46,6 +47,7 @@ const Label = ({
       // {...otherProps}
     >
       {children}
+      {optional && ' (Optional)'}
     </Wrapper>
   )
 }
@@ -85,12 +87,16 @@ Label.propTypes = {
    */
   color:PropTypes.string,
 
+  /**
+   * Whether the input should have an optional tag
+   */
+  optional:PropTypes.bool,
 }
 
 Label.defaultProps = {
-  // someProp:false
-  as   :'label',
-  color:'main1',
+  as      :'label',
+  color   :'main2',
+  optional:false,
 }
 
 export default Label

package/src/ui/f/common/Label/styles.scss

@@ -3,9 +3,6 @@
 @use "@pareto-engineering/bem";
 @use "../../../form.scss";
 
-
-.#{bem.$base}.label {
- color: var(--x);
+.#{bem.$base}.form-label {
+ color: var(--dark-x);
 }
-
-

package/src/ui/f/fields/{CheckboxInput/CheckboxInput.jsx → Checkbox/Checkbox.jsx}

@@ -1,41 +1,41 @@
 /* @pareto-engineering/generator-front 1.0.12 */
 import * as React from 'react'
 
-import { useLayoutEffect, memo } from 'react'
-
-import { useField } from 'formik'
+import { useLayoutEffect } from 'react'
 
 import PropTypes from 'prop-types'
 
 import styleNames from '@pareto-engineering/bem'
 
+import { useField } from 'formik'
+
 import { FormLabel, FormDescription } from '../../common'
 
 // Local Definitions
 
 const baseClassName = styleNames.base
 
-const componentClassName = 'checkbox-input'
+const componentClassName = 'checkbox'
 
 /**
  * This is the component description.
  */
-const CheckboxInput = ({
+const Checkbox = ({
   id,
   className:userClassName,
   style,
-  children,
-  value,
   name,
+  label,
+  description,
+  disabled,
+  optional,
   // ...otherProps
 }) => {
   useLayoutEffect(() => {
     import('./styles.scss')
   }, [])
 
-  const [field, meta] = useField(name)
-
-  const isOptionSelected = !!(field.value?.length > 0 && field.value.includes(value))
+  const [field] = useField({ name, type: 'checkbox' })
 
   return (
     <div
@@ -52,23 +52,24 @@ const CheckboxInput = ({
       style={style}
       // {...otherProps}
     >
-      <div
-        className={`${isOptionSelected ? 'selected' : 'not-selected'} input-content uc v1 pv-v`}
-      >
-        <FormLabel name={name}>
-          <input {...field} id={name} value={value} className="input" type="checkbox" />
-          <span>
-            {children}
-          </span>
-        </FormLabel>
-      </div>
-      {meta.error && meta.touched && <FormDescription error>{meta.error}</FormDescription>}
-
+      {label && (
+      <FormLabel name={name} optional={optional}>
+        {label}
+      </FormLabel>
+      )}
+      <input
+        id={name}
+        className="input"
+        type="checkbox"
+        disabled={disabled}
+        {...field}
+      />
+      <FormDescription className="v50 mt-v s-1" description={description} name={name} />
     </div>
   )
 }
 
-CheckboxInput.propTypes = {
+Checkbox.propTypes = {
   /**
    * The HTML id for this element
    */
@@ -79,29 +80,39 @@ CheckboxInput.propTypes = {
    */
   className:PropTypes.string,
 
+  /**
+   * The React-written, css properties for this element.
+   */
+  style:PropTypes.objectOf(PropTypes.string),
+
   /**
    * The input name (html - and Formik state)
    */
   name:PropTypes.string.isRequired,
 
   /**
-   * The input value
+   * The Input description to guide the user if it's not obvious
    */
-  value:PropTypes.string.isRequired,
+  description:PropTypes.string,
 
   /**
-   * The React-written, css properties for this element.
+   * Whether the input should be disabled
    */
-  style:PropTypes.objectOf(PropTypes.string),
+  disabled:PropTypes.bool,
+
+  /**
+   * The input label
+   */
+  label:PropTypes.string,
 
   /**
-   *  The children JSX
+   * Whether the input should have an optional tag
    */
-  children:PropTypes.node,
+  optional:PropTypes.bool,
 }
 
-CheckboxInput.defaultProps = {
-  // someProp:false
+Checkbox.defaultProps = {
+  disabled:false,
 }
 
-export default memo(CheckboxInput)
+export default Checkbox

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

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

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

@@ -0,0 +1,14 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+@use "@pareto-engineering/bem";
+
+$default-margin: 1em;
+
+.#{bem.$base}.checkbox {
+    display: flex;
+    flex-direction: column;
+    align-items: flex-start;
+
+    .#{bem.$base}.label {
+        margin-bottom: $default-margin
+    }
+}

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

@@ -33,6 +33,7 @@ const ChoicesInput = ({
   color,
   colorChecked,
   label,
+  optional,
   disabled,
   // ...otherProps
 }) => {
@@ -63,7 +64,7 @@ const ChoicesInput = ({
       // {...otherProps}
     >
       {label && (
-      <FormLabel as="p">
+      <FormLabel as="p" optional={optional}>
         {label}
       </FormLabel>
       )}
@@ -72,7 +73,7 @@ const ChoicesInput = ({
           <Choice
             key={choice.value}
             name={name}
-            id={`${id}-${choice.value}`}
+            id={`${name}-${choice.value}`}
             multiple={multiple}
             validate={validate}
             disabled={disabled}
@@ -142,13 +143,18 @@ ChoicesInput.propTypes = {
    * Whether all the Choices inputs should be disabled
    */
   disabled          :PropTypes.bool,
+
+  /**
+  * Whether the input is optional or not
+  */
+  optional:PropTypes.bool,
 }
 
 ChoicesInput.defaultProps = {
   gridColumnsMobile :2,
   gridColumnsDesktop:3,
   color             :'background2',
-  colorChecked      :'main1',
+  colorChecked      :'main2',
   disabled          :false,
 }
 

package/src/ui/f/fields/ChoicesInput/common/Choice/Choice.jsx

@@ -28,7 +28,15 @@ const Choice = ({
   validate,
   disabled,
 }) => {
-  const [field] = useField({ name, validate })
+  const type = multiple ? 'checkbox' : 'radio'
+
+  const [field] = useField({
+    name,
+    validate,
+    type,
+    value,
+  })
+
   return (
     <div
       className={[
@@ -43,7 +51,7 @@ const Choice = ({
       style={style}
     >
       <input
-        type={multiple ? 'checkbox' : 'radio'}
+        type={type}
         id={id}
         name={name}
         {...field}

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

@@ -29,10 +29,21 @@ $default-transition:all .3s;
         z-index: -1;
       }
 
+      input:disabled + label {
+        background-color: var(--dark-x);
+      }
+
+      input:not(:disabled) + label {
+        &:hover {
+          border-color: var(--light-y);
+        }
+      }
+
       label {
-        background: var(--x);
-        border-radius: var(--theme-border-radius);
+        border: var(--theme-border-style) var(--dark-x);
+        background: var(--light-x);
         color: var(--on-x);
+        border-radius: var(--theme-border-radius);
         display: block;
         height: 100%;
         padding: $default-padding;
@@ -44,6 +55,10 @@ $default-transition:all .3s;
       input:checked + label {
         background: var(--y);
         color: var(--on-y);
+
+        &:hover {
+          border-color: var(--y);
+        }
       }
     }
   }

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

@@ -0,0 +1,153 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useEffect, useState } from 'react'
+
+import { useRelayEnvironment, fetchQuery } from 'react-relay'
+
+import { useField } from 'formik'
+
+import PropTypes from 'prop-types'
+
+import { ChoicesInput } from '../ChoicesInput'
+
+/**
+ * This is the component description.
+ */
+const QueryChoices = ({
+  name,
+  optionsKeyMap,
+  query,
+  variables,
+  validate,
+  loadingOption,
+  extraVariables,
+  ...otherProps
+}) => {
+  const [, , helpers] = useField({ name, validate })
+
+  const { setError } = helpers
+
+  const environment = useRelayEnvironment()
+
+  const [isFetching, setIsFetching] = useState(false)
+
+  const [options, setOptions] = useState([loadingOption])
+
+  const { graphql, accessor } = query
+
+  const getOptions = () => {
+    if (isFetching) return
+
+    let searchVariables = variables
+
+    if (extraVariables) {
+      searchVariables = {
+        ...variables,
+        ...extraVariables,
+      }
+    }
+
+    fetchQuery(
+      environment,
+      graphql,
+      searchVariables,
+    )
+      .subscribe({
+        start:() => {
+          setIsFetching(true)
+        },
+        complete:() => {
+          setIsFetching(false)
+        },
+        error:(fetchError) => {
+          setIsFetching(false)
+          if (setError) setError(fetchError.message)
+        },
+        next:(data) => {
+          setOptions([
+            ...data[accessor].edges.map(({ node }) => ({
+              value:node[optionsKeyMap.value],
+              label:optionsKeyMap.getLabel(node),
+            })),
+          ])
+        },
+      })
+  }
+
+  useEffect(() => {
+    getOptions()
+  }, [variables])
+
+  return (
+    <ChoicesInput
+      name={name}
+      validate={validate}
+      options={options}
+      {...otherProps}
+    />
+  )
+}
+
+QueryChoices.propTypes = {
+  /**
+   * The choices name
+   */
+  name:PropTypes.string.isRequired,
+
+  /**
+ *  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 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 option to displayed when the select options are being fetched
+ */
+  loadingOption:PropTypes.shape({
+    value   :PropTypes.string.isRequired,
+    label   :PropTypes.string.isRequired,
+    disabled:PropTypes.bool.isRequired,
+  }),
+
+  /**
+   * The input field validator function
+   */
+  validate:PropTypes.string,
+
+  /**
+   *  The extra variables that might be required to be used in the query to fetch
+   *  select options.
+   */
+  extraVariables:PropTypes.objectOf(PropTypes.string),
+}
+
+QueryChoices.defaultProps = {
+  loadingOption:{
+    value   :'',
+    label   :'Fetching Options',
+    disabled:true,
+  },
+}
+
+export default QueryChoices

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

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