FunctionuseFormSubmissionState

  • useFormSubmissionState(form, initialSubmission?, lastElementUpdated?, sectionState?): [{
        definition: Form;
        executedLookups: ExecutedLookups;
        lastElementUpdated: undefined | FormElement;
        sectionState: undefined | {
            id: string;
            state: "COLLAPSED" | "EXPANDED";
        }[];
        submission: {
            [name: string]: unknown;
        };
    }, Dispatch<SetStateAction<{
        definition: Form;
        executedLookups: ExecutedLookups;
        lastElementUpdated: undefined | FormElement;
        sectionState: undefined | {
            id: string;
            state: "COLLAPSED" | "EXPANDED";
        }[];
        submission: {
            [name: string]: unknown;
        };
    }>>]

  • This function is a simple wrapper around the react hook useState(). The results can be passed to the <OneBlinkForm /> //TODO: Fix link component.

    Example

    import {
      useFormSubmissionState,
      OneBlinkFormControlled,
    } from '@oneblink/apps-react'

    function Uncontrolled({ form, initialSubmission, ...props }) {
      const [{ definition, submission }, setFormSubmission] =
        useFormSubmissionState(form, initialSubmission)

      return (
        <OneBlinkFormControlled
          {...props}
          definition={definition}
          submission={submission}
          setFormSubmission={setFormSubmission}
          lastElementUpdated={lastElementUpdated}
        />
      )
    }

    Parameters

    • form: Form

      The OneBlink Form to render

    • OptionalinitialSubmission: {
          [name: string]: unknown;
      }

      The initial submission data to populate the form with

      • [name: string]: unknown
    • OptionallastElementUpdated: FormElement
    • OptionalsectionState: {
          id: string;
          state: "COLLAPSED" | "EXPANDED";
      }[]

    Returns [{
        definition: Form;
        executedLookups: ExecutedLookups;
        lastElementUpdated: undefined | FormElement;
        sectionState: undefined | {
            id: string;
            state: "COLLAPSED" | "EXPANDED";
        }[];
        submission: {
            [name: string]: unknown;
        };
    }, Dispatch<SetStateAction<{
        definition: Form;
        executedLookups: ExecutedLookups;
        lastElementUpdated: undefined | FormElement;
        sectionState: undefined | {
            id: string;
            state: "COLLAPSED" | "EXPANDED";
        }[];
        submission: {
            [name: string]: unknown;
        };
    }>>]

Settings

On This Page

Example