@frigade/react 1.32.76 → 1.32.78

package/lib/index.d.ts

@@ -117,6 +117,9 @@ interface DefaultFrigadeFlowProps {
     style?: CSSProperties;
     className?: string;
     appearance?: Appearance;
+    /**
+     * Dynamic variables to use in flow-data.yml. See https://docs.frigade.com/flows/dynamic-variables
+     */
     customVariables?: {
         [key: string]: string | number | boolean;
     };
@@ -280,29 +283,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 +320,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>;
 }
 
@@ -442,28 +451,50 @@ interface ToolTipData extends StepData {
     titleStyle?: CSSProperties;
     buttonStyle?: CSSProperties;
 }
-interface ToolTipProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
+
+interface FrigadeTourProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
+    /**
+     * @ignore
+     */
     steps?: ToolTipData[];
     onDismiss?: () => void;
     onComplete?: () => void;
     tooltipPosition?: ToolTipPosition;
+    /**
+     * Whether to show the highlight (the small circle/ping) or not. Defaults to true.
+     */
     showHighlight?: boolean;
+    /**
+     * Whether to show more than one tooltip at a time. Defaults to false.
+     */
     showTooltipsSimultaneously?: boolean;
+    /**
+     * @ignore
+     */
     buttonStyle?: CSSProperties;
+    /**
+     * Offset to apply to all tooltips.
+     */
     offset?: {
         x: number;
         y: number;
     };
     visible?: boolean;
+    /**
+     * @ignore
+     */
     containerStyle?: CSSProperties;
     customVariables?: {
         [key: string]: string | number | boolean;
     };
+    /**
+     * @ignore
+     */
     selectedStep?: number;
     customStepTypes?: Record<string, (stepData: StepData) => React__default.ReactNode>;
     appearance?: Appearance;
     /**
-     * Shows a close button in the top right corner of the tooltip. This will end the flow.
+     * Shows a close button in the top right corner of the tooltip. Depending on dismissBehavior, it will either end the entire flow or just the current step.
      */
     dismissible?: boolean;
     primaryColor?: string;
@@ -477,14 +508,16 @@ interface ToolTipProps extends Omit<DefaultFrigadeFlowProps, 'flowId'> {
      */
     showStepCount?: boolean;
     /**
-     * 'complete-flow' (default): Completes the entire flow/tour when a single tooltip is dismissed.
-     * 'complete-step': Completes the current step when a tooltip is dismissed.
+     * `complete-flow` (default): Completes the entire flow/tour when a single tooltip is dismissed.
+     * `complete-step`: Completes the current step when a tooltip is dismissed.
      */
     dismissBehavior?: 'complete-flow' | 'complete-step';
+    /**
+     * @ignore
+     */
     showFrigadeBranding?: boolean;
 }
-
-declare const FrigadeTour: FC<ToolTipProps & {
+declare const FrigadeTour: FC<FrigadeTourProps & {
     flowId: string;
     initialSelectedStep?: number;
 }>;