1.1.8 • Published 4 years ago

react-uniform-hook v1.1.8

Weekly downloads
52
License
-
Repository
-
Last release
4 years ago

Uniform Hook

Uniformly generates a form from a schema with on the fly customizability!

NPM downloads NPM downloads NPM downloads

License: MIT semantic-release

Why?

  • helps save time writing complex forms
  • allows you to easily share inputs with other forms
  • allows teams to stay consistent with forms
  • handles the repetitive dull parts of creating a form for you!

Hook props:

PropTypeRequiredDescription
onSubmitFunctionfalsetriggers on submit button click and returns all values
onChangeFunctionfalsetriggers on input change and returns all values
onBlurFunctionfalsetriggers on input blur and returns all values
schemaObjecttrueschema based off what form is generated from
validationObjectfalseoverwrites the schema's validation function for an input (extremely useful when wanting to share validation with)
initialValuesObjectfalsemaps the initial values to schema
featureFlagsObjectfalsejust a object of feature flags
validateInitialValuesbooleanfalsevalidates initial values once form loads
disabledBoolean || JSXfalsedisables inputs if true
viewModeBoolean || JSXfalsetoggles viewMode in schema
classNameStringfalsepasses css classes down to the main form component
errorClassStringfalsepasses css class to error message
viewModeFallbackTextStringfalsepasses fallback viewMode text when value is null or undefined. Default is "N/A"
multiFormBooleanfalseallows you to create a multi form

Component Example:

import { UniformHook } from "react-uniform-hook";
const schema = {
  inputs: {
    name: {
      label: "name",
      required: false,
      type: "text",
      placeholder: "Whats your name"
    },
    age: {
      label: "Age",
      required: true,
      type: "number",
      placeholder: "Whats your age?"
    },
    favoriteColor: {
      label: "favoriteColor",
      placeholder: "Favorite color",
      options: [
        { value: "green", label: "green" },
        { value: "red", label: "red" },
        { value: "blue", label: "blue" }
      ]
    }
  }
};

const Form = () => {
  const onSubmit = values => {
    console.log(values);
  };

  const { form } = UniformHook({ schema, onSubmit });

  return <div>{form}</div>;
};
// More complex example

const Form = () => {
  const onSubmit = values => {
    console.log(values);
  };
  const customSubmitButton = <button type="submit">My Custom Submit</button>;

  const { form, clearForm, addFields, removeFields } = UniformHook({
    schema,
    onSubmit,
    submitButton: customSubmitButton
  });

  return (
    <div>
      {form}
      <button onClick={clearForm}>Clear Form</button>
      <button onClick={addFields}>Add Fields</button>
      <button onClick={removeFields}>Remove Fields</button>
    </div>
  );
};

Schema Format:

KeyTypeDefaultDescription
validateFunctionnulluses this function to validate input
visibleIfFunctionnulladds ability to check if certain criteria is met and then make the input visible if it is
onSubmitFunctionnullon submit run mutation function and return value (Will not run function if value is empty)
labelStringnulltext in input label
initialValueanynullsets initial value of input
typeStringnullinput type: https://www.w3schools.com/html/html_form_input_types.asp
placeholderStringnullsets input placeholder
featureFlagStringnullfeature flag input is associated with
requiredBoolean | Functionfalsesets input as required
untrackedBooleantrueallows you to disable value tracking on the input
customComponentJSXnullallows you to put whatever JSX you'd like to put in form
functionalComponentJSXnullallows you to put whatever Functional Component you'd like to put in form
viewModeComponentFunctionnullallows you to put whatever Component below the label you'd like to render when viewMode is toggled value and values, get passed to function
viewModeClassFunctionnullclass put onto the viewMode Text
customViewModeFunctionnullallows you to put whatever Component you'd like to render when viewMode is toggled schema key value, value, and values, get passed to function
prependHtmlJSXnullappend html after the input
optionsArraynullconverts input to select box options rendered from Array [{value: true, label: "yes"}, { value: false, label: 'no' }]
...ETCANYnullAnything else you add to schema get passed to the inputs as a props

Schema Example:

import { EzValidation } from "util/ezValidation";
schema = {
  inputs: {
    name: {
      label: "name",
      initialValue: "Whats your name",
      validate: (val, vals) =>
        EzValidation(val)
          .isString()
          .minLength(2).errorMessage,
      required: false,
      onSubmit: (val, vals) => {
        if (val.length > 10) {
          return val + " Thats a long Name";
        }
      },
      type: "text",
      placeholder: "name"
    },
    length: {
      label: "length",
      required: true,
      type: "number",
      placeholder: "length of package"
    },
    moneyMoney: {
      label: "Money Money",
      placeholder: "How much you got?",
      type: "text",
      prependHtml: (
        <div className="input-group-prepend">
          <span className="input-group-text" id="basic-addon1">
            $
          </span>
        </div>
      )
    },
    lengthIfOne: {
      label: "length if one",
      visibleIf: values => values["length"] === "1",
      required: true,
      type: "number",
      placeholder: "length"
    },
    selectMulti: {
      label: "selectMulti",
      type: "multiSelect",
      placeholder: "Favorite Color",
      isMulti: true,
      required: true,
      customComponent: Select,
      options: [
        { value: 1, label: "One" },
        { value: 2, label: "Two" },
        { value: 3, label: "Three" }
      ]
    },
    favoriteColor: {
      label: "favoriteColor",
      placeholder: "Favorite color",
      options: [
        { value: "green", label: "green" },
        { value: "red", label: "red" },
        { value: "blue", label: "blue" }
      ]
    },
    masked: {
      label: "masked",
      placeholder: "masked",
      required: true,
      customComponent: InputMask,
      mask: "9999-99-99",
      maskChar: null
    },
    description: {
      label: "description",
      placeholder: "description",
      required: false,
      type: "textarea"
    }
  }
};
1.1.8

4 years ago

1.1.7

4 years ago

1.1.6

4 years ago

1.1.5

4 years ago

1.1.4

4 years ago

1.1.3

4 years ago

1.1.2

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago