@frigade/react 1.32.75 → 1.32.77

package/lib/index.d.ts

@@ -280,29 +280,32 @@ interface FrigadeConfig {
 }
 declare const FrigadeProvider: FC<FrigadeProviderProps>;
 
-type FrigadeChecklistType = 'inline' | 'modal';
-type FrigadeChecklistStyle = 'with-guide' | 'default' | 'condensed' | 'carousel';
 interface FrigadeChecklistProps extends HeroChecklistProps {
     flowId: string;
     title?: string;
     subtitle?: string;
-    onCompleteStep?: (index: number, stepData: StepData) => void;
     style?: CSSProperties;
+    /** @ignore */
     initialSelectedStep?: number;
     className?: string;
-    type?: FrigadeChecklistType;
-    checklistStyle?: FrigadeChecklistStyle;
+    type?: 'inline' | 'modal';
+    checklistStyle?: 'with-guide' | 'default' | 'condensed' | 'carousel';
     visible?: boolean;
     setVisible?: (visible: boolean) => void;
     onDismiss?: () => void;
+    /**
+     * See https://docs.frigade.com/flows/dynamic-variables
+     */
     customVariables?: {
         [key: string]: string | number | boolean;
     };
     /**
-     *  Optional Props specifically for ChecklistWithGuide
-     *
+     * Flow ID referencing the flow of a guide/link collection to attach to this Checklist
      */
     guideFlowId?: string;
+    /**
+     * Title for the guide (if attached)
+     */
     guideTitle?: string;
     autoExpandFirstIncompleteStep?: boolean;
     autoExpandNextStep?: boolean;
@@ -314,15 +317,18 @@ interface HeroChecklistProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
     subtitle?: string;
     /**
      * @deprecated Use `appearance` instead
+     * @ignore
      */
     primaryColor?: string;
+    /** @ignore */
     steps?: StepData[];
-    /**
-     * @deprecated use onStepCompletion instead
-     */
-    onCompleteStep?: (index: number, stepData: StepData) => void;
+    /** @ignore */
     selectedStep?: number;
+    /** @ignore */
     setSelectedStep?: (index: number) => void;
+    /**
+     * Map from string to function with StepData returning React.ReactNode
+     */
     customStepTypes?: Record<string, (stepData: StepData, appearance: Appearance) => React__default.ReactNode>;
 }