@frigade/react 1.32.79 → 1.32.81

package/lib/index.d.ts

@@ -116,6 +116,9 @@ interface DefaultFrigadeFlowProps {
     flowId: string;
     style?: CSSProperties;
     className?: string;
+    /**
+     * The appearance of the flow. See https://docs.frigade.com/sdk/styling
+     */
     appearance?: Appearance;
     /**
      * Dynamic variables to use in flow-data.yml. See https://docs.frigade.com/flows/dynamic-variables
@@ -128,6 +131,9 @@ interface DefaultFrigadeFlowProps {
      * Handler for when a step is completed.
      * @param step
      * @param index
+     * @param nextStep
+     * @param allFormData All form data collected so far (only applicable to FrigadeForms)
+     * @param stepSpecificFormData Form data collected for the finished step (only applicable to FrigadeForms)
      */
     onStepCompletion?: (step: StepData, index: number, nextStep?: StepData, allFormData?: any, stepSpecificFormData?: any) => boolean;
     /**
@@ -364,8 +370,6 @@ interface FrigadeProgressBadgeProps extends DefaultFrigadeFlowProps {
 }
 declare const FrigadeProgressBadge: React__default.FC<FrigadeProgressBadgeProps>;
 
-type ModalPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center';
-
 interface FormInputType {
     id: string;
     title?: string;
@@ -414,25 +418,59 @@ interface StepContentProps {
 type EntityProperties = Record<string, string | boolean | number | null>;
 
 type FrigadeFormType = 'inline' | 'modal' | 'large-modal' | 'corner-modal';
-interface FormProps extends DefaultFrigadeFlowProps {
+interface FrigadeFormProps extends DefaultFrigadeFlowProps {
+    /**
+     * @ignore
+     */
     title?: string;
+    /**
+     * @ignore
+     */
     subtitle?: string;
     type?: FrigadeFormType;
+    /**
+     * 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;
     };
+    /**
+     * Map of custom form components. Can only be used with a step of type `multiInput` (defined in `flow-data.yml`).
+     * The key must match the `type` property of the input defined in `flow-data.yml`
+     */
     customFormElements?: {
         [key: string]: (params: FormInputProps) => React__default.ReactNode;
     };
     visible?: boolean;
     setVisible?: (visible: boolean) => void;
     onComplete?: () => void;
+    /**
+     * Whether to show a dismiss button to exit out of the form. Applicable only for modal forms.
+     */
     dismissible?: boolean;
+    /**
+     * If true, the form can be repeated multiple times. Default is false. Useful for e.g. contact/support forms.
+     */
     repeatable?: boolean;
+    /**
+     * If true, the user will be excited from the flow when the form is dismissed. Default is false.
+     */
     endFlowOnDismiss?: boolean;
-    modalPosition?: ModalPosition;
+    /**
+     * Indicates the position of the modal if the form type is a modal. Default is center.
+     */
+    modalPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center';
+    /**
+     * Show a pagination indicator at the bottom of the form. Default is false.
+     */
     showPagination?: boolean;
+    /**
+     * Whether to allow the user to navigate back to previous steps. Default is false.
+     */
     allowBackNavigation?: boolean;
+    /**
+     * @ignore
+     */
     showFrigadeBranding?: boolean;
     /**
      * This function is called when the user submits data in a step.
@@ -440,7 +478,7 @@ interface FormProps extends DefaultFrigadeFlowProps {
      */
     validationHandler?: (step: StepData, index: number, nextStep?: StepData, allFormData?: any, stepSpecificFormData?: object) => Promise<string | null | undefined>;
 }
-declare const FrigadeForm: FC<FormProps>;
+declare const FrigadeForm: FC<FrigadeFormProps>;
 
 interface FrigadeGuideProps extends DefaultFrigadeFlowProps {
     title: string;
@@ -520,6 +558,11 @@ interface FrigadeTourProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
      * @ignore
      */
     showFrigadeBranding?: boolean;
+    /**
+     * If true, the tour will go to the next existing step/tip if the current selector element is not found on the page.
+     * Defaults to false.
+     */
+    skipIfNotFound?: boolean;
 }
 declare const FrigadeTour: FC<FrigadeTourProps & {
     flowId: string;