React Form Object

A library for composing and managing complex forms in React.

Description

The FormObject component is a powerful tool for managing form state in React applications. It provides a simple and intuitive interface for handling form data, validation, and submission. With FormObject, you can easily define complex forms with nested fields and dynamic validation rules. It handles state management internally, reducing boilerplate code and making form development more efficient. Additionally, FormObject integrates seamlessly with Yup for schema-based validation and provides hooks for custom validation logic. Overall, FormObject simplifies the process of building and managing forms in React applications, making it an essential tool for frontend developers.

Installation

You can install the package via npm:

npm install react-form-object

Or via yarn:

yarn add react-form-object

Componentes

• FormObject: For managing complex data forms.
• FormIterator: For managing arrays of complex data forms.

Usage

To use the FormObject component, import it from react-form-object and use it within your React components. Here's a simple example of how to use the FormObject component:

See the full code here

export const ContactSimpleExample = () => {
  const [data, setData] = useState(initContact);
  // Method for load options of form
  const doOptions = async () => {
    await sleep(1000); // Simulate fetching options from a server
    return {
      status: "ready",
      options: {
        gender: [
          { value: "", label: `??? ${Date.now()}` },
          { value: "M", label: "Male" },
          { value: "F", label: "Female" },
        ],
      },
    };
  };

  // Method for validate the contact data
  // You could use any tool
  const doValidate = async (contact) => {
    try {
      const result = contactSchema.validateSync(contact, { abortEarly: false });
      return {
        status: "valid",
        feedback: {
          name: {
            type: "valid",
            message: "It is valid!!!",
          },
        },
      };
    } catch (validationError) {
      const feedback = {};
      validationError.inner.forEach((error) => {
        const path = error.path;
        const errorMessage = error.message;
        feedback[path] = { type: "invalid", message: errorMessage };
      });
      return { status: "invalid", feedback };
    }
  };
  // Submit data
  const doSubmit = async ({ data }) => {
    setData(data);
    await sleep(1000); // Simulate submitting data to a server
    return {
      status: "failed",
      message: {
        type: "danger",
        title: "Invalid Service",
        description: "This service is invalid",
      },
    };
  };
  // Declare FormObject
  return (
    <div>
      <FormObject
        data={data}
        doOptions={doOptions}
        doSubmit={doSubmit}
        doValidate={doValidate}
      >
        <ContactForm />
      </FormObject>
      <pre>MAIN:{JSON.stringify(data, null, 2)}</pre>
    </div>
  );
};

The ContactForm is abstracted from data information and can be split into smaller parts, as it is reused in other forms.

const ContactForm = () => {
  const { data, onSubmit, onReset, onReload, options } = useFormObject();
  const enabledGuardian = data.age && data.age < 18;
  return (
    <FormLayout className={ROOT_STYLE[status]}>
      <FormInputText label="Name" name="name" required />
      <FormInputText label="Last Name" name="lastname" required />
      <FormInputText label="Gender" name="gender" required />
      <FormInputText label="Age" name="age" required />
      <FormInputText
        label="Guardian Name"
        name="guardianName"
        disabled={!enabledGuardian}
        required
      />
      <FormInputText
        label="Guardian Phone"
        name="guardianPhone"
        disabled={!enabledGuardian}
        required
      />
      <FormInputText label="Correo Electrónico" name="email" required />
      <FormSelectText
        label="Gender"
        name="gender"
        options={options.gender}
        required
      />
      <div className="message">
        <MessageResponse />
      </div>
      <div className="actions">
        <ButtonGroup>
          <Button variant="success" type="button" onClick={onReload}>
            Reload
          </Button>
          <Button variant="danger" type="button" onClick={onReset}>
            Reset
          </Button>
          <Button variant="primary" type="button" onClick={() => onSubmit()}>
            Submit
          </Button>
          <Button
            variant="primary"
            type="button"
            onClick={() => onSubmit(true)}
          >
            Force Submit
          </Button>
        </ButtonGroup>
      </div>
    </FormLayout>
  );
};

The FormInputText component is reused throughout the entire project.

const FormInputText = ({ name, label, ...props }) => {
  const { getAttribute, setAttribute, feedback } = useFormObject();
  const onChange = (e) => setAttribute(name, e.target.value);
  const value = getAttribute(name) || "";
  const className = ITEM_STYLE[feedback[name]?.type];
  return (
    <Form.Group className={name}>
      <Form.Label>{label}</Form.Label>
      <Form.Control
        {...props}
        value={value}
        onChange={onChange}
        className={className}
      />
      <Form.Control.Feedback type={feedback[name]?.type}>
        {feedback[name]?.message}
      </Form.Control.Feedback>
    </Form.Group>
  );
};

The MessageResponse component is reused throughout the entire project.

const MessageResponse = () => {
  const { status, message } = useFormObject();
  return (
    message && (
      <Alert variant={message.type}>
        <b>
          {status} - {message.title}:{" "}
        </b>{" "}
        {message.description}
      </Alert>
    )
  );
};

FormObject

The FormObject component accepts the following props:

export type FormObjectProps<T, R> = {
  index: number;
  pk: string;
  name: string;

  data: T;
  setData: SetData<T>;
  defaultData: InitData<T>;

  result: R;
  setResult: SetData<R>;
  defaultResult: InitData<R>;

  status: Status;
  setStatus: SetData<Status>;
  defaultStatus: InitData<Status>;

  feedback: Feedback;
  setFeedback: SetData<Feedback>;
  defaultFeedback: InitData<Feedback>;

  message: Message;
  setMessage: SetData<Message>;
  defaultMessage: InitData<Message>;

  options: Options;
  setOptions: SetData<Options>;
  defaultOptions: InitData<Options>;

  doReset: DoReset<T>;
  doChange: DoChange<T>;
  doNotify: DoNotify<T>;
  doSubmit: DoSubmit<T>;
  doLoad: DoLoad<T>;
  doOptions: DoOptions<T>;
  doValidate: DoValidate<T>;

  deep: boolean;
  children: ReactNode;
  wrapper: React.FC<any>;
};

• index: Index within an array, used primarily in conjunction with the FormIterator component.
• pk: The name of the primary key attribute.
• name: The name of the FormObject, used for identification in debugging purposes.
• data: The initial data, representing the initial state of the form (set, default).
• result: The initial result, representing the initial state of the result form (set, default).
• feedback: The initial feedback, representing the initial state of the feedback form (set, default).
• message: The initial message, representing the initial state of the message form (set, default).
• options: The initial options, representing the initial state of the options form (set, default).
• doReset: A function to perform reset actions on the form.
• doChange: A function to handle changes to the form data.
• doNotify: A function to notify changes within the form.
• doSubmit: A function to handle form submission.
• doLoad: A function to load the form.
• doOptions: A function to fetch options for form fields.
• doValidate: A function to validate the form data.
• deep: A boolean indicating whether deep cloning is required for the form data.
• children: The child components of the FormObject.
• wrapper: A wrapper component to render before the child components.

useFormObject

The useFormObject hook provides access to the following data:

export type FormObjectContextProps<T, R> = {
  // Identify
  pk: string;
  name: string;
  index: number;

  // Data Handler
  data: T;
  setData: SetData<T>;
  setAttribute: SetAttribute;
  getAttribute: GetAttribute;
  result: R;
  setResult: SetData<R>;

  // Status Handler
  status: Status;
  setStatus: SetStatus;
  feedback: Feedback;
  setFeedback: SetFeedback;
  options: Options;
  setOptions: SetOptions;
  message: Message;
  setMessage: SetMessage;

  // Allows Methods
  onReset: OnReset;
  onSubmit: OnSubmit;
  onReload: OnReload;
  onNotify: OnNotify;
  onValidate: OnValidate;
};

• pk: The name of the primary key attribute.
• name: The name of the FormObject, used for identification.
• index: Index within an array, used primarily in conjunction with the FormIterator component.
• data: The current form data.
• setData: A function to update the form data.
• setAttribute: A function to set a specific attribute of the form data.
• getAttribute: A function to get the value of a specific attribute from the form data.
• result: The current result form.
• setResult: A function to update the result form.
• status: The current status of the form (e.g., loading, ready, invalid).
• setStatus: A function to update the status of the form.
• feedback: Feedback messages related to form validation.
• setFeedback: A function to update the feedback messages.
• options: Options available for form fields.
• setOptions: A function to update the available options.
• message: A message returned after submitting the form.
• setMessage: A function to update the message after form submission.
• onReset: A method to reset the form to its initial state.
• onSubmit: A method to submit the form data.
• onReload: A method to reload the form.
• onNotify: A method to notify changes within the form.
• onValidate: A method to validate the form data.

useFormValue

The useFormValue hook provides access to the functionality for a specified path, allowing for dynamic management of object data within forms. This hook partially replaces the data and setData methods with value and setValue. Additionally, the getAttribute and setAttribute methods will affect the base path with the specified path parameter.

useFormList

The useFormList hook provides access to the functionality for a specified path, allowing for dynamic management of array data within forms. In addition to the functionality provided by useFormValue, this hook includes methods for manipulating the list, such as addItem, removeItem, removeIndex, setItem, and getItem.

useFormStateValue

StateValue Hooks

const [
      value,
      setValue,
      getAttribute,
      setAttribute,
      handler,
      ] = useFormStateValue = <T, R>(path, _default);

useFormStateList

StateValue Hooks

const [
      value,
      setValue,
      getItem,
      setItem,
      addItem,
      removeItem,
      handler,
      ] = useFormStateList = <T, R>(path, _default);

FormIterator

The FormIterator component is used for managing arrays of complex data within forms.

useFormIterator

The useFormIterator hook provides access to the functionality of the FormIterator component, allowing for dynamic management of array data within forms.

Contributing

License

This package is open-sourced software licensed under the MIT license.