@pareto-engineering/design-system 4.0.0-alpha.37 → 4.0.0-alpha.38

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

@@ -15,6 +15,7 @@ import {
   RatingsInput,
   Checkbox,
   QueryChoices,
+  LinkInput,
 } from '../fields'
 
 // Local Definitions
@@ -117,6 +118,16 @@ const FormInput = ({
     )
   }
 
+  if (type === 'link') {
+    return (
+      <LinkInput
+        className={newClassName}
+        disabled={disabled}
+        {...otherProps}
+      />
+    )
+  }
+
   if (extraTypes?.[type]) {
     const Component = extraTypes[type]
     return (
@@ -127,6 +138,7 @@ const FormInput = ({
       />
     )
   }
+
   return (
     <TextInput
       className={newClassName}

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

@@ -0,0 +1,197 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react'
+
+import { useInsertionEffect, memo } from 'react'
+
+import PropTypes from 'prop-types'
+
+import styleNames from '@pareto-engineering/bem/exports'
+
+import { useField } from 'formik'
+
+import { FormLabel, FormDescription, InputWrapper } from '../../common'
+
+// Local Definitions
+
+const baseClassName = styleNames.base
+
+const componentClassName = 'link-input'
+
+/**
+ * This is the component description.
+ */
+const LinkInput = ({
+  id,
+  className:userClassName,
+  style,
+  name,
+  label,
+  color,
+  labelColor,
+  validate,
+  description,
+  disabled,
+  placeholder,
+  optional,
+  autoComplete,
+  labelSpan,
+  desktopLabelSpan,
+  inputSpan,
+  desktopInputSpan,
+  // ...otherProps
+}) => {
+  useInsertionEffect(() => {
+    import('./styles.scss')
+  }, [])
+
+  const [field] = useField({ name, validate })
+
+  return (
+    <>
+      <FormLabel
+        name={name}
+        color={labelColor}
+        optional={optional}
+        columnSpan={labelSpan}
+        desktopColumnSpan={desktopLabelSpan}
+        // {...otherProps}
+      >
+        {label}
+      </FormLabel>
+      <InputWrapper
+        id={id}
+        className={[
+          baseClassName,
+          componentClassName,
+          userClassName,
+          `y-${color}`,
+        ]
+          .filter((e) => e)
+          .join(' ')}
+        style={style}
+        columnSpan={inputSpan}
+        desktopColumnSpan={desktopInputSpan}
+      >
+        <div className="input-link-wrapper">
+          <input
+            id={name}
+            className="input"
+            type="text"
+            disabled={disabled}
+            placeholder={placeholder}
+            autoComplete={autoComplete}
+            {...field}
+          />
+          <a
+            href={field.value}
+            target="_blank"
+            rel="noopener noreferrer"
+          >
+            &#8594;
+          </a>
+        </div>
+        <FormDescription className="s-1" description={description} name={name} />
+      </InputWrapper>
+    </>
+  )
+}
+
+LinkInput.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 label
+   */
+  label:PropTypes.string.isRequired,
+
+  /**
+   * The input label color
+   */
+  labelColor:PropTypes.string,
+
+  /**
+   * The input field validator function
+   */
+  validate:PropTypes.func,
+
+  /**
+   * If the slide will only have one input
+   */
+  oneInputLabel:PropTypes.bool,
+
+  /**
+   * Input description
+   */
+  description:PropTypes.string,
+
+  /**
+   * Whether the text input should be disabled
+   */
+  disabled:PropTypes.bool,
+
+  /**
+   * The placeholder text for the input
+   */
+  placeholder:PropTypes.string,
+
+  /**
+   * The text input color
+   */
+  color:PropTypes.string,
+
+  /**
+ * Whether the input is optional or not
+ */
+  optional:PropTypes.bool,
+
+  /**
+   * The autoComplete value that the browser should watch for the input
+   * `https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete`
+   */
+  autoComplete:PropTypes.string,
+
+  /**
+   * The number of columns the label should span
+   */
+  labelSpan:PropTypes.number,
+
+  /**
+   * The number of columns the input should span
+   */
+  inputSpan:PropTypes.number,
+
+  /**
+   * The number of columns the label should span on desktop
+   */
+  desktopLabelSpan:PropTypes.number,
+
+  /**
+   * The number of columns the input should span on desktop
+   */
+  desktopInputSpan:PropTypes.number,
+}
+
+LinkInput.defaultProps = {
+  color   :'paragraph',
+  disabled:false,
+}
+
+export default memo(LinkInput)

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

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

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

@@ -0,0 +1,89 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+/* stylelint-disable max-nesting-depth -- required here */
+
+@use "@pareto-engineering/bem";
+@use "@pareto-engineering/styles/src/mixins";
+@use "@pareto-engineering/styles/src/globals" as *;
+
+$default-padding: .55em .75em;
+$default-symbol-left: 1em;
+$default-padding-with-symbol:
+  .55em
+  calc($default-symbol-left - 1em)
+  .55em
+  calc($default-symbol-left + 1em);
+$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);
+$disabled-background: var(--background-inputs-30);
+
+.#{bem.$base}.link-input {
+  &.#{bem.$base}.input-wrapper {
+    display: flex;
+    flex-direction: column;
+    position: relative;
+
+    &.has-symbol {
+      &::before {
+        color: var(--y);
+        content: var(--symbol);
+        left: $default-symbol-left;
+        position: absolute;
+        top: 50%;
+        transform: translate(-50%, -50%);
+      }
+
+      input {
+        padding: $default-padding-with-symbol;
+      }
+    }
+
+    > .input-link-wrapper {
+      display: flex;
+      gap: calc(var(--gap) / 2);
+
+      > a {
+        align-self: center;
+        border: 1px solid var(--interactive);
+        border-radius: var(--theme-default-input-border-radius);
+        padding: .5em;
+
+        &:hover {
+          background-color: var(--interactive);
+          color: var(--on-interactive);
+        }
+      }
+
+      > input {
+        background-color: $default-background;
+        border: $default-border;
+        border-radius: $default-input-border-radius;
+        color: var(--y);
+        outline: none;
+        padding: $default-padding;
+        width: 100%;
+
+        &::placeholder {
+          color: var(--metadata);
+        }
+
+        &:disabled {
+          background-color: $disabled-background;
+        }
+
+        &:not(:disabled) {
+          &:hover,
+          &:active {
+            border: $hover-border;
+          }
+
+          &:focus {
+            border: $focus-border;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -7,3 +7,4 @@ export { QueryCombobox } from './QueryCombobox'
 export { QuerySelect } from './QuerySelect'
 export { Checkbox } from './Checkbox'
 export { QueryChoices } from './QueryChoices'
+export { LinkInput } from './LinkInput'

package/tests/__snapshots__/Storyshots.test.js.snap

@@ -18378,6 +18378,398 @@ exports[`Storyshots f/fields/ChoicesInput With Default Formik Value 1`] = `
 </form>
 `;
 
+exports[`Storyshots f/fields/LinkInput Base 1`] = `
+<form
+  action="#"
+  onReset={[Function]}
+  onSubmit={[Function]}
+>
+  <div
+    className="grid"
+  >
+    <label
+      className="base form-label x-paragraph"
+      htmlFor="link"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      Spreadsheet Link
+    </label>
+    <div
+      className="base input-wrapper base link-input y-paragraph"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      <div
+        className="input-link-wrapper"
+      >
+        <input
+          className="input"
+          disabled={false}
+          id="link"
+          name="link"
+          onBlur={[Function]}
+          onChange={[Function]}
+          type="text"
+        />
+        <a
+          rel="noopener noreferrer"
+          target="_blank"
+        >
+          →
+        </a>
+      </div>
+    </div>
+    <div
+      className="debugger"
+    >
+      <button
+        className="base button x-main2"
+        onClick={[Function]}
+        type="button"
+      >
+        Open FormDebugger
+      </button>
+    </div>
+  </div>
+</form>
+`;
+
+exports[`Storyshots f/fields/LinkInput On Single Row 1`] = `
+<form
+  action="#"
+  onReset={[Function]}
+  onSubmit={[Function]}
+>
+  <div
+    className="grid"
+  >
+    <label
+      className="base form-label x-paragraph"
+      htmlFor="link"
+      style={
+        {
+          "--column-span": 4,
+          "--column-span-md": 4,
+        }
+      }
+    >
+      Spreadsheet Link
+    </label>
+    <div
+      className="base input-wrapper base link-input y-paragraph"
+      style={
+        {
+          "--column-span": 4,
+          "--column-span-md": 10,
+        }
+      }
+    >
+      <div
+        className="input-link-wrapper"
+      >
+        <input
+          className="input"
+          disabled={false}
+          id="link"
+          name="link"
+          onBlur={[Function]}
+          onChange={[Function]}
+          type="text"
+        />
+        <a
+          rel="noopener noreferrer"
+          target="_blank"
+        >
+          →
+        </a>
+      </div>
+    </div>
+    <div
+      className="debugger"
+    >
+      <button
+        className="base button x-main2"
+        onClick={[Function]}
+        type="button"
+      >
+        Open FormDebugger
+      </button>
+    </div>
+  </div>
+</form>
+`;
+
+exports[`Storyshots f/fields/LinkInput Optional 1`] = `
+<form
+  action="#"
+  onReset={[Function]}
+  onSubmit={[Function]}
+>
+  <div
+    className="grid"
+  >
+    <label
+      className="base form-label x-paragraph"
+      htmlFor="link"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      Spreadsheet Link
+       (Optional)
+    </label>
+    <div
+      className="base input-wrapper base link-input y-paragraph"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      <div
+        className="input-link-wrapper"
+      >
+        <input
+          className="input"
+          disabled={false}
+          id="link"
+          name="link"
+          onBlur={[Function]}
+          onChange={[Function]}
+          type="text"
+        />
+        <a
+          rel="noopener noreferrer"
+          target="_blank"
+        >
+          →
+        </a>
+      </div>
+    </div>
+    <div
+      className="debugger"
+    >
+      <button
+        className="base button x-main2"
+        onClick={[Function]}
+        type="button"
+      >
+        Open FormDebugger
+      </button>
+    </div>
+  </div>
+</form>
+`;
+
+exports[`Storyshots f/fields/LinkInput With Disabled 1`] = `
+<form
+  action="#"
+  onReset={[Function]}
+  onSubmit={[Function]}
+>
+  <div
+    className="grid"
+  >
+    <label
+      className="base form-label x-paragraph"
+      htmlFor="link"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      Spreadsheet Link
+    </label>
+    <div
+      className="base input-wrapper base link-input y-paragraph"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      <div
+        className="input-link-wrapper"
+      >
+        <input
+          className="input"
+          disabled={true}
+          id="link"
+          name="link"
+          onBlur={[Function]}
+          onChange={[Function]}
+          type="text"
+        />
+        <a
+          rel="noopener noreferrer"
+          target="_blank"
+        >
+          →
+        </a>
+      </div>
+    </div>
+    <div
+      className="debugger"
+    >
+      <button
+        className="base button x-main2"
+        onClick={[Function]}
+        type="button"
+      >
+        Open FormDebugger
+      </button>
+    </div>
+  </div>
+</form>
+`;
+
+exports[`Storyshots f/fields/LinkInput With Placeholder 1`] = `
+<form
+  action="#"
+  onReset={[Function]}
+  onSubmit={[Function]}
+>
+  <div
+    className="grid"
+  >
+    <label
+      className="base form-label x-paragraph"
+      htmlFor="link"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      Spreadsheet Link
+    </label>
+    <div
+      className="base input-wrapper base link-input y-paragraph"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      <div
+        className="input-link-wrapper"
+      >
+        <input
+          className="input"
+          disabled={false}
+          id="link"
+          name="link"
+          onBlur={[Function]}
+          onChange={[Function]}
+          placeholder="Email address"
+          type="text"
+        />
+        <a
+          rel="noopener noreferrer"
+          target="_blank"
+        >
+          →
+        </a>
+      </div>
+    </div>
+    <div
+      className="debugger"
+    >
+      <button
+        className="base button x-main2"
+        onClick={[Function]}
+        type="button"
+      >
+        Open FormDebugger
+      </button>
+    </div>
+  </div>
+</form>
+`;
+
+exports[`Storyshots f/fields/LinkInput With Validation 1`] = `
+<form
+  action="#"
+  onReset={[Function]}
+  onSubmit={[Function]}
+>
+  <div
+    className="grid"
+  >
+    <label
+      className="base form-label x-paragraph"
+      htmlFor="link"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      Spreadsheet Link
+    </label>
+    <div
+      className="base input-wrapper base link-input y-paragraph"
+      style={
+        {
+          "--column-span": "var(--columns)",
+          "--column-span-md": "var(--columns)",
+        }
+      }
+    >
+      <div
+        className="input-link-wrapper"
+      >
+        <input
+          className="input"
+          disabled={false}
+          id="link"
+          name="link"
+          onBlur={[Function]}
+          onChange={[Function]}
+          type="text"
+        />
+        <a
+          rel="noopener noreferrer"
+          target="_blank"
+        >
+          →
+        </a>
+      </div>
+    </div>
+    <div
+      className="debugger"
+    >
+      <button
+        className="base button x-main2"
+        onClick={[Function]}
+        type="button"
+      >
+        Open FormDebugger
+      </button>
+    </div>
+  </div>
+</form>
+`;
+
 exports[`Storyshots f/fields/QueryChoices Base 1`] = `
 <form
   action="#"