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

package/src/stories/f/Checkbox.stories.jsx

@@ -0,0 +1,95 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useEffect } from 'react'
+
+import { Formik, Form, useField } from 'formik'
+
+import { Checkbox, FormDebugger } from 'ui'
+
+export default {
+  title        :'f/fields/Checkbox',
+  component    :Checkbox,
+  subcomponents:{
+    // Item:Checkbox.Item
+  },
+  decorators:[
+    // storyfn => <div className="">{ storyfn() }</div>,
+    (storyfn) => (
+      <Formik
+        initialValues={{}}
+      >
+        <Form>
+
+          { storyfn() }
+        </Form>
+      </Formik>
+    ),
+  ],
+  argTypes:{
+    label       :{ control: 'text' },
+    description :{ control: 'text' },
+    defaultValue:{ control: 'boolean' },
+    disabled    :{ control: 'boolean' },
+    optional    :{ control: 'boolean' },
+  },
+}
+
+// eslint-disable-next-line react/prop-types
+const Template = ({ defaultValue, ...args }) => {
+  const Content = () => {
+    const { name } = args
+    const [, , helpers] = useField(name)
+    const { setValue } = helpers
+
+    useEffect(() => {
+      if (defaultValue) {
+        setValue(defaultValue)
+      }
+    }, [defaultValue])
+
+    return (
+      <>
+        <Checkbox {...args} />
+        <FormDebugger />
+      </>
+    )
+  }
+
+  return <Content />
+}
+
+export const Base = Template.bind({})
+Base.args = {
+  name:'urgent',
+}
+
+export const WithLabel = Template.bind({})
+WithLabel.args = {
+  ...Base.args,
+  label:'Urgent',
+}
+
+export const WithDescription = Template.bind({})
+WithDescription.args = {
+  ...Base.args,
+  description:'Click on the checkbox',
+}
+
+export const WithDefaultFormikValue = Template.bind({})
+WithDefaultFormikValue.args = {
+  ...Base.args,
+  defaultValue:true,
+}
+
+export const Disabled = Template.bind({})
+Disabled.args = {
+  ...Base.args,
+  disabled:true,
+}
+
+export const Optional = Template.bind({})
+Optional.args = {
+  ...Base.args,
+  optional:true,
+}

package/src/stories/f/ChoicesInput.stories.jsx

@@ -1,8 +1,8 @@
 /* @pareto-engineering/generator-front 1.0.12 */
 import * as React from 'react'
-
+import { useEffect } from 'react'
 import { ChoicesInput, FormDebugger } from 'ui'
-import { Formik, Form } from 'formik'
+import { Formik, Form, useField } from 'formik'
 
 export default {
   title        :'f/fields/ChoicesInput',
@@ -29,14 +29,6 @@ export default {
   },
 }
 
-const Template = (args) => (
-  <>
-    <ChoicesInput {...args} />
-    <FormDebugger />
-  </>
-)
-
-export const Base = Template.bind({})
 const optionsMap = [
   {
     value:'red',
@@ -72,18 +64,54 @@ const optionsMap = [
   },
 ]
 
+// eslint-disable-next-line react/prop-types
+const Template = ({ defaultValue, ...args }) => {
+  const Content = () => {
+    const [, , helpers] = useField(args.name)
+    const { setValue } = helpers
+
+    useEffect(() => {
+      if (defaultValue) {
+        setValue(defaultValue)
+      }
+    }, [defaultValue])
+
+    return (
+      <>
+        <ChoicesInput {...args} />
+        <FormDebugger />
+      </>
+    )
+  }
+  return <Content />
+}
+
+export const Base = Template.bind({})
 Base.args = {
   id     :'colors',
   options:optionsMap,
   name   :'color',
 }
 
+export const WithDefaultFormikValue = Template.bind({})
+WithDefaultFormikValue.args = {
+  ...Base.args,
+  defaultValue:'red',
+}
+
 export const Multiple = Template.bind({})
 Multiple.args = {
   ...Base.args,
   multiple:true,
 }
 
+export const MultipleWithDefaultFormikValue = Template.bind({})
+MultipleWithDefaultFormikValue.args = {
+  ...Base.args,
+  multiple    :true,
+  defaultValue:['brown', 'violet'],
+}
+
 export const MultipleWithGrid = Template.bind({})
 MultipleWithGrid.args = {
   ...Base.args,

package/src/stories/f/FormInput.stories.jsx

@@ -62,6 +62,11 @@ export const Base = () => {
       name :'description',
       label:'Describe yourself in a few sentences',
     },
+    {
+      type :'checkbox',
+      name :'urgent',
+      label:'Urgent',
+    },
     {
       type   :'choices',
       name   :'colors',

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

@@ -13,6 +13,7 @@ import {
   QueryCombobox,
   QuerySelect,
   RatingsInput,
+  Checkbox,
 } from '../fields'
 
 // Local Definitions
@@ -94,6 +95,17 @@ const FormInput = ({
       />
     )
   }
+
+  if (type === 'checkbox') {
+    return (
+      <Checkbox
+        className={newClassName}
+        disabled={disabled}
+        {...otherProps}
+      />
+    )
+  }
+
   if (extraTypes?.[type]) {
     const Component = extraTypes[type]
     return (

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.

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

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

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

@@ -0,0 +1,118 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+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'
+
+/**
+ * This is the component description.
+ */
+const Checkbox = ({
+  id,
+  className:userClassName,
+  style,
+  name,
+  label,
+  description,
+  disabled,
+  optional,
+  // ...otherProps
+}) => {
+  useLayoutEffect(() => {
+    import('./styles.scss')
+  }, [])
+
+  const [field] = useField({ name, type: 'checkbox' })
+
+  return (
+    <div
+      id={id}
+      className={[
+
+        baseClassName,
+
+        componentClassName,
+        userClassName,
+      ]
+        .filter((e) => e)
+        .join(' ')}
+      style={style}
+      // {...otherProps}
+    >
+      {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>
+  )
+}
+
+Checkbox.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 input name (html - and Formik state)
+   */
+  name:PropTypes.string.isRequired,
+
+  /**
+   * The Input description to guide the user if it's not obvious
+   */
+  description:PropTypes.string,
+
+  /**
+   * Whether the input should be disabled
+   */
+  disabled:PropTypes.bool,
+
+  /**
+   * The input label
+   */
+  label:PropTypes.string,
+
+  /**
+   * Whether the input should have an optional tag
+   */
+  optional:PropTypes.bool,
+}
+
+Checkbox.defaultProps = {
+  disabled:false,
+}
+
+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

@@ -72,7 +72,7 @@ const ChoicesInput = ({
           <Choice
             key={choice.value}
             name={name}
-            id={`${id}-${choice.value}`}
+            id={`${name}-${choice.value}`}
             multiple={multiple}
             validate={validate}
             disabled={disabled}

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/QueryCombobox/QueryCombobox.jsx

@@ -33,13 +33,14 @@ const QueryCombobox = ({
   optionsKeyMap,
   minLength,
   transformSearch,
+  validate,
   // ...otherProps
 }) => {
   useLayoutEffect(() => {
     import('./styles.scss')
   }, [])
 
-  const [, meta, helpers] = useField(name)
+  const [, meta, helpers] = useField({ name, validate })
 
   const { setValue, setError } = helpers
 
@@ -209,6 +210,11 @@ QueryCombobox.propTypes = {
    * The function to transform the search input
    */
   transformSearch:PropTypes.func,
+
+  /**
+   * The query combobox field validator function
+   */
+  validate:PropTypes.func,
 }
 
 QueryCombobox.defaultProps = {

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

@@ -30,9 +30,10 @@ const QuerySelect = ({
   color,
   loadingOption,
   defaultOption,
+  validate,
   // ...otherProps
 }) => {
-  const [, , helpers] = useField(name)
+  const [, , helpers] = useField({ name, validate })
 
   const { setError } = helpers
 
@@ -180,6 +181,11 @@ QuerySelect.propTypes = {
     label   :PropTypes.string.isRequired,
     disabled:PropTypes.bool.isRequired,
   }),
+
+  /**
+   * The query select field validator function
+   */
+  validate:PropTypes.func,
 }
 
 QuerySelect.defaultProps = {

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

@@ -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
@@ -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/index.js

@@ -5,3 +5,4 @@ export { TextareaInput } from './TextareaInput'
 export { RatingsInput } from './RatingsInput'
 export { QueryCombobox } from './QueryCombobox'
 export { QuerySelect } from './QuerySelect'
+export { Checkbox } from './Checkbox'

package/dist/cjs/a/ColumnLabel/styles.scss

@@ -1,22 +0,0 @@
-/* @pareto-engineering/generator-front 1.0.12 */
-@use "@pareto-engineering/bem";
-
-$default-image-size: 2em;
-$default-font-size: calc(1 em * var(--s-1));
-$default-padding: .5em;
-
-.#{bem.$base}.column-label{
-    align-items: center;
-    background: var(--x);
-    border-radius: 3em;
-    display: inline-flex;
-    font-size: $default-font-size;
-    padding: $default-padding;
-    white-space: nowrap;
-
-    img {
-        border-radius: 50%;
-        height: $default-image-size;
-        width: $default-image-size;
-    }
-}

package/dist/es/a/ColumnLabel/ColumnLabel.js

@@ -1,78 +0,0 @@
-/* @pareto-engineering/generator-front 1.0.12 */
-import * as React from 'react';
-import { useLayoutEffect } from 'react';
-import PropTypes from 'prop-types';
-import styleNames from '@pareto-engineering/bem'; // Local Definitions
-
-const baseClassName = styleNames.base;
-const componentClassName = 'column-label';
-/**
- * This is the component description.
- */
-
-const ColumnLabel = ({
-  id,
-  className: userClassName,
-  style,
-  value,
-  color: FontColor,
-  getColor,
-  image
-}) => {
-  useLayoutEffect(() => {
-    import("./styles.scss");
-  }, []);
-  const color = getColor ? getColor(value) : FontColor;
-  return /*#__PURE__*/React.createElement("div", {
-    id: id,
-    className: [baseClassName, componentClassName, userClassName].filter(e => e).join(' '),
-    style: { ...style,
-      color
-    }
-  }, image && /*#__PURE__*/React.createElement("img", {
-    className: "image v50 mr-v",
-    src: image,
-    alt: `${value}`
-  }), value);
-};
-
-ColumnLabel.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 value to display for the label
-   */
-  value: PropTypes.string,
-
-  /**
-   *  The default font color to display for the label
-   */
-  color: PropTypes.string,
-
-  /**
-   * The function passed to decide the color of the label
-   */
-  getColor: PropTypes.func,
-
-  /**
-   * The image to be displayed if passed
-   */
-  image: PropTypes.string
-};
-ColumnLabel.defaultProps = {
-  color: 'var(--on-x)'
-};
-export default ColumnLabel;

package/dist/es/a/ColumnLabel/index.js

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

package/dist/es/a/ColumnLabel/styles.scss

@@ -1,22 +0,0 @@
-/* @pareto-engineering/generator-front 1.0.12 */
-@use "@pareto-engineering/bem";
-
-$default-image-size: 2em;
-$default-font-size: calc(1 em * var(--s-1));
-$default-padding: .5em;
-
-.#{bem.$base}.column-label{
-    align-items: center;
-    background: var(--x);
-    border-radius: 3em;
-    display: inline-flex;
-    font-size: $default-font-size;
-    padding: $default-padding;
-    white-space: nowrap;
-
-    img {
-        border-radius: 50%;
-        height: $default-image-size;
-        width: $default-image-size;
-    }
-}