@frigade/react 1.33.12 → 1.33.14

package/lib/index.d.ts

@@ -414,6 +414,7 @@ interface CustomFormTypeProps {
     setCanContinue: (canContinue: boolean) => void;
     onSaveData: (data: object) => void;
     appearance?: Appearance;
+    prefillData?: Record<string, any>;
     customFormElements?: {
         [key: string]: (params: FormInputProps) => React__default.ReactNode;
     };
@@ -439,7 +440,18 @@ interface FrigadeFormProps extends DefaultFrigadeFlowProps {
      * Map of custom components. The key must match the `type` property of the step defined in `flow-data.yml`
      */
     customStepTypes?: {
-        [key: string]: (params: CustomFormTypeProps) => React__default.ReactNode;
+        [key: string]: (params: {
+            flowId: string;
+            stepData: StepData;
+            canContinue: boolean;
+            setCanContinue: (canContinue: boolean) => void;
+            onSaveData: (data: object) => void;
+            appearance?: Appearance;
+            prefillData?: Record<string, any>;
+            customFormElements?: {
+                [key: string]: (params: FormInputProps) => React__default.ReactNode;
+            };
+        }) => React__default.ReactNode;
     };
     /**
      * Map of custom form components. Can only be used with a step of type `multiInput` (defined in `flow-data.yml`).
@@ -481,9 +493,27 @@ interface FrigadeFormProps extends DefaultFrigadeFlowProps {
     showFrigadeBranding?: boolean;
     /**
      * This function is called when the user submits data in a step.
-     * If it returns a string, the flow will not proceed to the next step and the string will be displayed as an error message.
+     * If it returns a string or explicitly false, the flow will not proceed to the next step.
+     * Optionally, if a string is returned it will be displayed as an error message.
+     */
+    validationHandler?: (step: StepData, index: number, nextStep?: StepData, allFormData?: any, stepSpecificFormData?: any) => Promise<string | null | boolean | undefined>;
+    /**
+     * Handler that is called when the form data changes.
+     */
+    onFormDataChange?: (allFormData: any, stepSpecificFormData: any, step: StepData, index: number) => void;
+    /**
+     * Show or hide the form footer
+     */
+    showFooter?: boolean;
+    /**
+     * Data to use for prefilling forms with data.
+     * Useful when you want to prefill a form with data from another source.
+     * The format of the data maps a step id to the prefill data. Depending on the implementation of the given step type,
+     * the value of the data will follow a different structure.
+     *
+     * For `type` multiInputStep, the value contains another map similar to the structure returned from `onFormDataChange`
      */
-    validationHandler?: (step: StepData, index: number, nextStep?: StepData, allFormData?: any, stepSpecificFormData?: object) => Promise<string | null | undefined>;
+    prefillData?: Record<string, any>;
 }
 declare const FrigadeForm: FC<FrigadeFormProps>;